全部产品
云市场

实例查询服务

更新时间:2019-08-21 10:06:37

接口名

QueryAvailableInstances

描述

实例查询接口,查询用户可用实例列表。

请求参数

名称 类型 是否必填 说明
ProductCode String 产品代码。当region设置了时,不为空
ProductType String 产品类型
SubscriptionType String 订阅类型:Subscription-预付费,PayAsYouGo-后付费
InstanceIDs String 实例ID;英文逗号分隔,最大不超过100个实例
Region String Region
EndTimeStart String 结束时间段起,符合ISO8601标准的utc时间格式,如2016-05-23T12:00:00Z(为北京时间2016年5月23日20点0分0秒)
EndTimeEnd String 结束时间段止,格式要求同上
CreateTimeStart String 创建时间段起,格式要求同上
CreateTimeEnd String 创建时间段止,格式要求同上
RenewStatus String 续费状态:AutoRenewal – 自动续费,ManualRenewal – 手动续费,NotRenewal – 不续费
OwnerId String BID场景/分销场景,OwnerId必须指定

返回参数

名称 类型 说明
Success Boolean 是否成功
Code String 错误码
Message String 调用详情
RequestId String 本次调用的RequestId
Data PagedBssResponse 参见数据字典PagedBssResponse

PagedBssResponse详情

名称 类型 说明
PageNum Integer 页码,从1开始
PageSize Integer 每页大小
TotalCount Integer 有效实例总数
InstanceList List 包含实例信息的列表,详见数据字典BssInstanceInfo

BssInstanceInfo详情

名称 类型 说明
OwnerId String OwnerID
ProductCode String 产品代码
ProductType String 产品类型
SubscriptionType String 订阅类型:Subscription-预付费,PayAsYouGo-后付费
InstanceID String 实例ID
Region String Region
CreateTime String 创建时间
EndTime String 结束时间
StopTime String 停止时间
ReleaseTime String 释放时间
ExpectedReleaseTime String 期望释放时间
Status String 状态
SubStatus String 子状态
RenewStatus String 续费状态:AutoRenewal – 自动续费,ManualRenewal – 手动续费,NotRenewal – 不续费
RenewalDuration String 自动续费周期数量
RenewalDurationUnit String 自动续费周期单位,M-月,Y-年
Seller String 卖方

错误码

错误码 错误信息 HTTP状态码语义
NotApplicable This API is not applicable for caller. 400 该用户没有访问API的权限。
MissingParameter The specified parameter xx is mandatory for this request. 400 指定的参数未设置。
InvalidParameter The specified moduleCode is not valid. 400 指定的参数不合法。
InvalidModuleCode The specified moduleCode is not valid. 400 模块标识不合法。
InvalidConfigCode The specified configCode is not valid. 400 模块属性标识不合法。
InvalidOwner The specified owner doesn’t belong to caller. 400 指定的拥有者从属关系不属于调用者。
InvalidCaller The specified caller doesn’t exists. 400 调用者不合法。
InternalError The request processing has failed due to some unknown error, exception or failure. 400 内部未知错误。

请求示例

  1. https://business.aliyuncs.com/?Action=QueryAvailableInstances
  2. &ProductCode=
  3. &ProductType=
  4. &SubscriptionType=
  5. &InstanceIDs=
  6. &Region=
  7. &EndTimeStart=
  8. &EndTimeEnd=
  9. &CreateTimeStart=
  10. &CreateTimeEnd=
  11. &RenewStatus=
  12. &OwnerID=

返回示例

  1. "Data": {
  2. "TotalCount": 51,
  3. "PageSize": 20,
  4. "PageNum": 1,
  5. "InstanceList": [
  6. {
  7. "Status": "Creating",
  8. "SubStatus": "Normal",
  9. "SubscriptionType": "Subscription",
  10. "RenewStatus": "ManualRenewal",
  11. "InstanceID": "IFP-ji2gz****",
  12. "ProductCode": "flowpack",
  13. "CreateTime": "2999-09-08T16:00:00Z",
  14. "OwnerId": "181****",
  15. "EndTime": "2016-11-07T16:00:00Z",
  16. "Seller": "26888"
  17. },
  18. {
  19. "Status": "Creating",
  20. "SubStatus": "Normal",
  21. "SubscriptionType": "Subscription",
  22. "RenewStatus": "ManualRenewal",
  23. "InstanceID": "IFP-6dyrc****",
  24. "ProductCode": "flowpack",
  25. "CreateTime": "2999-09-08T16:00:00Z",
  26. "OwnerId": "181****",
  27. "EndTime": "2016-11-07T16:00:00Z",
  28. "Seller": "26888"
  29. },
  30. {
  31. "Status": "Creating",
  32. "SubStatus": "Normal",
  33. "SubscriptionType": "Subscription",
  34. "RenewStatus": "ManualRenewal",
  35. "InstanceID": "IFP-ne1nt5uw1",
  36. "ProductCode": "flowpack",
  37. "CreateTime": "2999-09-08T16:00:00Z",
  38. "OwnerId": "181****",
  39. "EndTime": "2016-11-07T16:00:00Z",
  40. "Seller": "26888"
  41. },
  42. {
  43. "Status": "Creating",
  44. "SubStatus": "Normal",
  45. "SubscriptionType": "Subscription",
  46. "RenewStatus": "ManualRenewal",
  47. "InstanceID": "IFP-vj5ry82x1",
  48. "ProductCode": "flowpack",
  49. "CreateTime": "2999-09-08T16:00:00Z",
  50. "OwnerId": "181****",
  51. "EndTime": "2016-11-07T16:00:00Z",
  52. "Seller": "26888"
  53. },
  54. {
  55. "Status": "Creating",
  56. "SubStatus": "Normal",
  57. "SubscriptionType": "Subscription",
  58. "RenewStatus": "ManualRenewal",
  59. "InstanceID": "IFP-e6oupf251",
  60. "ProductCode": "flowpack",
  61. "CreateTime": "2999-09-08T16:00:00Z",
  62. "OwnerId": "181****",
  63. "EndTime": "2016-11-10T16:00:00Z",
  64. "Seller": "26888"
  65. },
  66. {
  67. "Status": "Creating",
  68. "SubStatus": "Normal",
  69. "SubscriptionType": "PayAsYouGo",
  70. "InstanceID": "988643",
  71. "ProductCode": "cmjj011731",
  72. "CreateTime": "2999-09-08T16:00:00Z",
  73. "OwnerId": "181****",
  74. "EndTime": "2999-09-08T16:00:00Z",
  75. "Seller": "26888"
  76. },
  77. {
  78. "Status": "Creating",
  79. "SubStatus": "Normal",
  80. "SubscriptionType": "PayAsYouGo",
  81. "InstanceID": "988647",
  82. "ProductCode": "cmjj011731",
  83. "CreateTime": "2999-09-08T16:00:00Z",
  84. "OwnerId": "181****",
  85. "EndTime": "2999-09-08T16:00:00Z",
  86. "Seller": "26888"
  87. },
  88. {
  89. "Status": "Creating",
  90. "SubStatus": "Normal",
  91. "SubscriptionType": "PayAsYouGo",
  92. "InstanceID": "988648",
  93. "ProductCode": "cmjj011731",
  94. "CreateTime": "2999-09-08T16:00:00Z",
  95. "OwnerId": "181****",
  96. "EndTime": "2999-09-08T16:00:00Z",
  97. "Seller": "26888"
  98. },
  99. {
  100. "Status": "Creating",
  101. "SubStatus": "Normal",
  102. "SubscriptionType": "PayAsYouGo",
  103. "InstanceID": "988649",
  104. "ProductCode": "cmjj011731",
  105. "CreateTime": "2999-09-08T16:00:00Z",
  106. "OwnerId": "181****",
  107. "EndTime": "2999-09-08T16:00:00Z",
  108. "Seller": "26888"
  109. },
  110. {
  111. "Status": "Creating",
  112. "SubStatus": "Normal",
  113. "SubscriptionType": "PayAsYouGo",
  114. "InstanceID": "988651",
  115. "ProductCode": "cmjj011731",
  116. "CreateTime": "2999-09-08T16:00:00Z",
  117. "OwnerId": "181****",
  118. "EndTime": "2999-09-08T16:00:00Z",
  119. "Seller": "26888"
  120. },
  121. {
  122. "Status": "Creating",
  123. "SubStatus": "Normal",
  124. "SubscriptionType": "PayAsYouGo",
  125. "InstanceID": "1049056",
  126. "ProductCode": "cmjj011399",
  127. "CreateTime": "2999-09-08T16:00:00Z",
  128. "OwnerId": "181****",
  129. "EndTime": "2999-09-08T16:00:00Z",
  130. "Seller": "26888"
  131. },
  132. {
  133. "Status": "Creating",
  134. "SubStatus": "Normal",
  135. "SubscriptionType": "PayAsYouGo",
  136. "InstanceID": "1049052",
  137. "ProductCode": "cmjj011399",
  138. "CreateTime": "2999-09-08T16:00:00Z",
  139. "OwnerId": "181****",
  140. "EndTime": "2999-09-08T16:00:00Z",
  141. "Seller": "26888"
  142. }
  143. ]
  144. },
  145. "Message": "Successful!",
  146. "RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
  147. "Success": true,
  148. "Code": "Success"