服务商侧查询实例信息_云市场(Marketplace)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceForIsv	系统规定参数。取值：DescribeInstanceForIsv。
InstanceId	String	是	155****11	实例ID

返回数据

名称	类型	示例值	描述
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：版本
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：已释放
RequestId	String	6EF60BEC-**--**-270359FB54A7	请求ID。
AutoRenewal	String	{"autoRenewCycle":"Year","autoRenewDuration":1}	周期类商品自动付费，不为空时表示已开通自动续费 autoRenewCycle:Day（日），Month（月），Year（年） autoRenewDuration:续费周期
ActiveAddress	String	https://*****.com	激活地址
LicenseCode	String	xxxxxx	激活码
ImageJson	String	{"imageId":"m-*****","instanceId":******}	镜像实例信息 imageId：镜像id instanceId: 实例id ecsInstanceId: ecs id

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceForIsv
&InstanceId=155****11
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstanceForIsvResponse>
    <Status>OPENED</Status>
    <AppJson>{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}</AppJson>
    <ProductName>***协同办公</ProductName>
    <InstanceId>1551111111</InstanceId>
    <ExtendJson>{"说明": "如有使用问题，请联系..."}</ExtendJson>
    <IsTrial>true</IsTrial>
    <BeganOn>1570634021000</BeganOn>
    <ComponentJson>{"package_version":"yuncode000111"}</ComponentJson>
    <ProductType>APP</ProductType>
    <HostJson>{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}</HostJson>
    <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>
    <CreatedOn>1570634018000</CreatedOn>
    <EndOn>1602259200000</EndOn>
    <OrderId>204211111111111</OrderId>
    <ProductCode>cmgj00**11</ProductCode>
    <SupplierName>*****有限公司</SupplierName>
    <RelationalData>
        <ServiceStatus>STARTED</ServiceStatus>
    </RelationalData>
    <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>
    <AutoRenewal>{"autoRenewCycle":"Year","autoRenewDuration":1}</AutoRenewal>
    <ActiveAddress>https://*****.com</ActiveAddress>
    <LicenseCode>xxxxxx</LicenseCode>
    <ImageJson>{"imageId":"m-*******","instanceId":********}</ImageJson>
</DescribeInstanceForIsvResponse>

JSON格式

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

{
  "Status" : "OPENED",
  "AppJson" : "{\"frontEndUrl\":\"https://****.aliyundoc.com\",\"password\":\"Sjtv***\",\"adminUrl\":\"https://****.aliyundoc.com\",\"username\":\"aliyun***\"}",
  "ProductName" : "***协同办公",
  "InstanceId" : 1551111111,
  "ExtendJson" : "{\"说明\": \"如有使用问题，请联系...\"}",
  "IsTrial" : true,
  "BeganOn" : 1570634021000,
  "ComponentJson" : "{\"package_version\":\"yuncode000111\"}",
  "ProductType" : "APP",
  "HostJson" : "{\"password\":\"***\",\"ip\":\"118.31.***.41\",\"innerIp\":\"118.31.***.41\",\"region\":\"\",\"username\":\"***\",\"beianInfo\":\"\"}",
  "ProductSkuCode" : "cmgj00**11-prepay",
  "CreatedOn" : 1570634018000,
  "EndOn" : 1602259200000,
  "OrderId" : 204211111111111,
  "ProductCode" : "cmgj00**11",
  "SupplierName" : "*****有限公司",
  "RelationalData" : {
    "ServiceStatus" : "STARTED"
  },
  "RequestId" : "6EF60BEC-****-****-****-270359FB54A7",
  "AutoRenewal" : "{\"autoRenewCycle\":\"Year\",\"autoRenewDuration\":1}",
  "ActiveAddress" : "https://*****.com",
  "LicenseCode" : "xxxxxx",
  "ImageJson" : "{\"imageId\":\"m-*******\",\"instanceId\":********}"
}

错误码

HttpCode	错误码	错误信息	描述
400	IllegalPermission	Permission Denied.	该账号没有权限
500	UnknownError	An error occurred while processing your request.	未知错误。

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