全部产品
云市场

ListInstance

更新时间:2018-12-13 10:10:08

查询一个或多个实例的详细信息。

描述

获取实例列表,返回实例列表按GmtCreate倒序。请求参数的作用类似于一个过滤器,过滤器为逻辑与( AND )关系。如果某个参数为空,则过滤器不起作用。

方法

GET

URI

/openapi/instances

请求参数

参数 类型 是否必需 描述
Name String 通过实例名称进行过滤,支持模糊匹配。
InstanceId String 通过实例ID进行过滤,支持模糊匹配。
Page Integer 指定页码,默认为:1
Size Integer 指定每页展示条数,默认为10,限制:[1-50]

返回参数

参数 类型 描述
RequestId String 当前请求的RequestID
Result List<Instance> 实例列表
Headers Map 头信息详情
X-Total-Count Integer 实例总数量

示例

请求示例

  1. GET /openapi/instances?name=test&instanceId=abc&page=1&size=10

返回示例

JSON 格式

  1. {
  2. "Result": [
  3. {
  4. "InstanceId": "airec-cn-xxxxxx",
  5. "Name": "airec-cn-xxxxxx",
  6. "Type": "Standard",
  7. "Status": "Running",
  8. "Industry": "content",
  9. "Scene": "gul",
  10. "RegionId": "cn-hangzhou",
  11. "ChargeType": "PrePaid",
  12. "CommodityCode": "airecpre",
  13. "GmtCreate": "2018-11-24T01:42:03.000Z",
  14. "GmtModified": "2018-11-24T01:45:09.000Z",
  15. "ExpiredTime": "2018-11-25T01:42:00.000Z",
  16. "LockMode": "Unlock"
  17. },
  18. {
  19. "InstanceId": "airec-cn-xxxxxx",
  20. "Name": "xxxxxx",
  21. "Type": "Standard",
  22. "Status": "Running",
  23. "Industry": "news",
  24. "Scene": "gul",
  25. "RegionId": "cn-hangzhou",
  26. "ChargeType": "PrePaid",
  27. "DataSetVersion": "20181122115505",
  28. "CommodityCode": "airecpre",
  29. "GmtCreate": "2018-11-22T03:51:46.000Z",
  30. "GmtModified": "2018-11-22T09:50:36.000Z",
  31. "ExpiredTime": "2018-11-23T03:51:44.000Z",
  32. "LockMode": "Unlock"
  33. }
  34. ],
  35. "RequestId": "76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF",
  36. "Headers": {
  37. "X-Total-Count": 19
  38. }
  39. }

无结果

  1. {
  2. "RequestId":"8F81A922-6C81-46D6-B78C-CC35E16B1691",
  3. "Result":[]
  4. }

异常返回示例

JSON 格式

  1. {
  2. "Code": "InstanceNotFound",
  3. "Message": "The specified instance does not exist. Check the instanceId please.",
  4. "RequestId": "829F38F6-E2D6-4109-90A6-888160BD16C2"
  5. }