ListInstance_实例_API参考_开发指南

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

描述

获取实例列表，返回实例列表按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	实例总数量

示例

请求示例

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

返回示例

JSON 格式

{
  "Result": [
    {
      "InstanceId": "airec-cn-xxxxxx",
      "Name": "airec-cn-xxxxxx",
      "Type": "Standard",
      "Status": "Running",
      "Industry": "content",
      "Scene": "gul",
      "RegionId": "cn-hangzhou",
      "ChargeType": "PrePaid",
      "CommodityCode": "airecpre",
      "GmtCreate": "2018-11-24T01:42:03.000Z",
      "GmtModified": "2018-11-24T01:45:09.000Z",
      "ExpiredTime": "2018-11-25T01:42:00.000Z",
      "LockMode": "Unlock"
    },
    {
      "InstanceId": "airec-cn-xxxxxx",
      "Name": "xxxxxx",
      "Type": "Standard",
      "Status": "Running",
      "Industry": "news",
      "Scene": "gul",
      "RegionId": "cn-hangzhou",
      "ChargeType": "PrePaid",
      "DataSetVersion": "20181122115505",
      "CommodityCode": "airecpre",
      "GmtCreate": "2018-11-22T03:51:46.000Z",
      "GmtModified": "2018-11-22T09:50:36.000Z",
      "ExpiredTime": "2018-11-23T03:51:44.000Z",
      "LockMode": "Unlock"
    }
  ],
  "RequestId": "76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF",
  "Headers": {
    "X-Total-Count": 19
  }
}

无结果

{
    "RequestId":"8F81A922-6C81-46D6-B78C-CC35E16B1691",
    "Result":[]
}

异常返回示例

JSON 格式

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