调用 DescribeInstance 查询实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeInstance

系统规定参数。取值：DescribeInstance。

InstanceId String 是 155****11

实例 ID。
OrderType String 否 NEW

订单类型，已废弃。

返回数据

名称 类型 示例值 描述
Status String OPENED

业务状态，根据不同商品类型设置不同值：

当ProductType = MIRROR 时

  • PRODUCE：生产中
  • USING：使用中
  • UNUSED：未使用
  • EXPIRED：已过期
  • CLOSED：已释放

当 ProductType = SERVICE 时

  • READYING：未开始
  • STARTED：服务中
  • 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***"}

应用信息，示例中的参数说明如下：

  • username：用户名
  • passowrd：密码
  • frontEndUrl：前台地址
  • adminUrl：管理地址
ProductName String ***协同办公

商品名称
InstanceId Long 1551111111

实例ID
ExtendJson String {"说明": "如有使用问题，请联系..."}

扩展信息
IsTrial Boolean true

是否试用
BeganOn Long 1570634021000

实例开通时间（时间戳）
ComponentJson String {"package_version":"yuncode000111"}

业务模块

示例中的参数说明如下：

  • package_version：版本
Constraints String {}

已废弃
ProductType String APP

商品类型，取值：

  • APP：应用类
  • SERVIC：服务类
  • MIRROR：镜像类
  • DOWNLOAD：下载类
  • API_SERVICE：API类
  • DOCKER：DOCKER类
HostJson String {"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}

主机信息，示例中的参数说明如下：

  • username：用户名
  • passowrd：密码
  • ip：主机 IP
  • innerIp：主机内网 IP
ProductSkuCode String cmgj00**11-prepay

规格Code
CreatedOn Long 1570634018000

创建时间（时间戳）
EndOn Long 1602259200000

到期时间（时间戳）
OrderId Long 204211111111111

订单ID
ProductCode String cmgj00**11

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

服务商名称
RelationalData Object

关联信息
ServiceStatus String STARTED

服务状态

  • READYING：未开始
  • STARTED： 服务中
  • 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
&<公共请求参数>

正常返回示例

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>***协同办公</ProductName>
    <ComponentJson>{"package_version":"yuncode000111"}</ComponentJson>
    <SupplierName>阿里巴巴技术有限公司</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" : "***协同办公",
  "ComponentJson" : "{\"package_version\":\"yuncode000111\"}",
  "SupplierName" : "阿里巴巴技术有限公司"
}

错误码

HttpCode 错误码 错误信息 描述
500 UnknownError An error occurred while processing your request. 未知错误

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。