調(diào)用 DescribeInstance 查詢實例信息。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeInstance

系統(tǒng)規(guī)定參數(shù)。取值：DescribeInstance。

InstanceId String 是 155****11

實例 ID。
OrderType String 否 NEW

訂單類型，已廢棄。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Status String OPENED

業(yè)務(wù)狀態(tài)，根據(jù)不同商品類型設(shè)置不同值：

當ProductType = MIRROR 時

  • PRODUCE：生產(chǎn)中
  • USING：使用中
  • UNUSED：未使用
  • EXPIRED：已過期
  • CLOSED：已釋放

當 ProductType = SERVICE 時

  • READYING：未開始
  • STARTED：服務(wù)中
  • CONFIRM：已完成
  • EXPIRED：已過期
  • CLOSED：已釋放

當 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 時

  • OPENING：開通中
  • OPENED：已開通
  • EXPIRED：已過期
  • CLOSED：已釋放
AppJson String {"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}

應(yīng)用信息，示例中的參數(shù)說明如下：

  • username：用戶名
  • passowrd：密碼
  • frontEndUrl：前臺地址
  • adminUrl：管理地址
ProductName String ***協(xié)同辦公

商品名稱
InstanceId Long 1551111111

實例ID
ExtendJson String {"說明": "如有使用問題，請聯(lián)系..."}

擴展信息
IsTrial Boolean true

是否試用
BeganOn Long 1570634021000

實例開通時間（時間戳）
ComponentJson String {"package_version":"yuncode000111"}

業(yè)務(wù)模塊

示例中的參數(shù)說明如下：

  • package_version：版本
Constraints String {}

已廢棄
ProductType String APP

商品類型，取值：

  • APP：應(yīng)用類
  • SERVIC：服務(wù)類
  • MIRROR：鏡像類
  • DOWNLOAD：下載類
  • API_SERVICE：API類
  • DOCKER：DOCKER類
HostJson String {"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}

主機信息，示例中的參數(shù)說明如下：

  • username：用戶名
  • passowrd：密碼
  • ip：主機 IP
  • innerIp：主機內(nèi)網(wǎng) IP
ProductSkuCode String cmgj00**11-prepay

規(guī)格Code
CreatedOn Long 1570634018000

創(chuàng)建時間（時間戳）
EndOn Long 1602259200000

到期時間（時間戳）
OrderId Long 204211111111111

訂單ID
ProductCode String cmgj00**11

商品Code
SupplierName String *****有限公司

服務(wù)商名稱
RelationalData Object

關(guān)聯(lián)信息
ServiceStatus String STARTED

服務(wù)狀態(tài)

  • READYING：未開始
  • STARTED： 服務(wù)中
  • CONFIRM：已完成
  • EXPIRED： 已過期
  • CLOSED： 已釋放
Modules Array of Module

商品模塊信息，已廢棄。
Module
Code String package_config

已廢棄
Name String 套餐配置

已廢棄
Id String 101*********026

已廢棄
Properties Array of Property

已廢棄
Property
Key String 12

已廢棄
ShowType String 12

已廢棄
Name String 12

已廢棄
DisplayUnit String 12

已廢棄
PropertyValues Array of PropertyValue

已廢棄
PropertyValue
DisplayName String 12

已廢棄
Type String 12

已廢棄
Step String 12

已廢棄
Value String 12

已廢棄
Max String 12

已廢棄
Remark String 12

已廢棄
Min String 12

已廢棄

示例

請求示例

http(s)://market.aliyuncs.com/?Action=DescribeInstance
&InstanceId=15****11
&<公共請求參數(shù)>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceResponse>
    <BeganOn>1570634021000</BeganOn>
    <ProductCode>cmgj00**11</ProductCode>
    <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>
    <OrderId>204605827111111</OrderId>
    <InstanceId>15581111</InstanceId>
    <EndOn>1602259200000</EndOn>
    <Status>OPENED</Status>
    <AppJson>{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}</AppJson>
    <ProductType>APP</ProductType>
    <CreatedOn>1570634018000</CreatedOn>
    <RelationalData>
        <ServiceStatus>READYING</ServiceStatus>
    </RelationalData>
    <ProductName>***協(xié)同辦公</ProductName>
    <ComponentJson>{"package_version":"yuncode000111"}</ComponentJson>
    <SupplierName>阿里巴巴技術(shù)有限公司</SupplierName>
</DescribeInstanceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "BeganOn" : 1570634021000,
  "ProductCode" : "cmgj00**11",
  "ProductSkuCode" : "cmgj00**11-prepay",
  "OrderId" : "204605827111111",
  "InstanceId" : "15581111",
  "EndOn" : 1602259200000,
  "Status" : "OPENED",
  "AppJson" : "{\"frontEndUrl\":\"https://****.aliyundoc.com\",\"password\":\"Sjtv***\",\"adminUrl\":\"https://****.aliyundoc.com\",\"username\":\"aliyun***\"}",
  "ProductType" : "APP",
  "CreatedOn" : 1570634018000,
  "RelationalData" : {
    "ServiceStatus" : "READYING"
  },
  "ProductName" : "***協(xié)同辦公",
  "ComponentJson" : "{\"package_version\":\"yuncode000111\"}",
  "SupplierName" : "阿里巴巴技術(shù)有限公司"
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
500 UnknownError An error occurred while processing your request. 未知錯誤

訪問錯誤中心查看更多錯誤碼。

訪問錯誤中心查看更多錯誤碼。