调用ListInstance，在列表中展示所有实例的详细信息。

说明 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。

调试

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

请求头

请求语法

GET /openapi/instances HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
page Integer 否 1

实例列表的页码。

起始值：1，默认值：1。

size Integer 否 10

分页查询时设置的每页条数。

最大值：100，默认值：10。

description String 否 es-cn-abc

实例名称，支持模糊查询。例如搜索abc的所有实例，则可能返回abc、abcde、xyabc、xabcy的所有实例。

instanceId String 否 es-cn-abc

实例ID。
esVersion String 否 5.3_with_X-Pack

实例版本。
resourceGroupId String 否 rg-aekzvowej3i****

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

当前请求的Request ID。
Result Array

当前请求返回的实例列表。
instanceId String es-cn-abc

实例ID。
description String es-cn-abc

实例名称。
nodeAmount Integer 2

实例的数据节点数量。
paymentType String postpaid

实例的付费方式。

可选值：prepaid（包年包月）和postpaid（按量付费）。

status String active

实例的状态。

可选值：active（正常）、activating（生效中）、inactive（冻结）和invalid（失效）。

esVersion String 5.5.3_with_X-Pack

实例版本。
createdAt String 2018-07-13T03:58:07.253Z

实例创建时间。
updatedAt String 2018-07-18T10:10:04.484Z

实例最后更新的时间。
advancedDedicateMaster Boolean false

是否包含专有主节点。
dedicateMaster Boolean false

是否包含专有主节点（旧版本）。
nodeSpec Struct

数据节点配置信息。
spec String elasticsearch.n4.small

数据节点规格。
disk Integer 50

数据节点磁盘大小，单位为GB。
diskType String cloud_ssd

数据节点磁盘类型。
networkConfig Struct

网络配置。
type String vpc

网络类型，当前只支持VPC网络。
vpcId String vpc-abc

虚拟专有网络ID。
vswitchId String vsw-def

虚拟交换机ID。
vsArea String cn-hangzhou-e

实例所在的可用区。
masterConfiguration Struct

Master节点配置信息。
spec String elasticsearch.sn2ne.large

Master节点规格。
amount Integer 3

Master节点数量。
diskType String cloud_ssd

Master节点磁盘类型。
disk Integer 20

Master节点磁盘大小，单位为GB。
kibanaConfiguration Struct

Kibana节点配置信息。
spec String elasticsearch.n4.small

Kibana节点规格。
disk Integer 0

Kibana节点磁盘大小，单位为GB。
amount Integer 1

Kibana节点数量。
diskType String cloud_ssd

Kibana节点磁盘类型。
Headers Struct

返回头信息。
X-Total-Count Integer 10

实例总记录数。

示例

请求示例

GET /openapi/instances?description=abc&page=1&size=10

正常返回示例

XML 格式 

<Result>
    <instanceId>es-cn-abc</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>es-cn-abc</description>
    <nodeAmount>2</nodeAmount>
    <paymentType>postpaid</paymentType>
    <paymentInfo/>
    <status>active</status>
    <port>9200</port>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <esConfig>
        <action.destructive_requires_name>true</action.destructive_requires_name>
        <xpack.security.audit.outputs>logfile</xpack.security.audit.outputs>
        <xpack.watcher.enabled>false</xpack.watcher.enabled>
        <action.auto_create_index>+.*,-*</action.auto_create_index>
    </esConfig>
    <kibanaDomain>es-cn-abc.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <publicDomain/>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.n4.small</spec>
        <disk>20</disk>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-abc</vpcId>
        <vswitchId>vsw-abc</vswitchId>
        <vsArea>cn-hangzhou-b</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2018-07-17T18:19:02.019Z</createdAt>
    <updatedAt>2018-07-18T10:10:04.484Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687603200000</endTime>
</Result>
<Result>
    <instanceId>es-cn-def</instanceId>
    <domain>es-cn-def.elasticsearch.aliyuncs.com</domain>
    <description>keepit</description>
    <nodeAmount>3</nodeAmount>
    <paymentType>postpaid</paymentType>
    <paymentInfo/>
    <status>active</status>
    <port>9200</port>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <esConfig>
        <action.destructive_requires_name>true</action.destructive_requires_name>
        <xpack.security.audit.outputs>logfile</xpack.security.audit.outputs>
        <xpack.watcher.enabled>false</xpack.watcher.enabled>
        <action.auto_create_index>+.*,-*</action.auto_create_index>
    </esConfig>
    <kibanaDomain>es-cn-def.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <publicDomain/>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.sn1ne.large</spec>
        <disk>20</disk>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-def</vpcId>
        <vswitchId>vsw-def</vswitchId>
        <vsArea>cn-hangzhou-b</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2018-07-13T03:58:07.253Z</createdAt>
    <updatedAt>2018-07-18T10:10:15.259Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>true</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687171200000</endTime>
</Result>
<RequestId>E2BAE51F-48A8-44D2-B5CD-A3BCE6B8****</RequestId>
<Headers>
    <X-Total-Count>2</X-Total-Count>
</Headers>

JSON 格式 

{
  "Result" : [ {
    "instanceId" : "es-cn-abc",
    "domain" : "es-cn-abc.elasticsearch.aliyuncs.com",
    "description" : "es-cn-abc",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "paymentInfo" : null,
    "status" : "active",
    "port" : 9200,
    "esVersion" : "5.5.3_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "logfile",
      "xpack.watcher.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-abc.kibana.elasticsearch.aliyuncs.com",
    "publicDomain" : null,
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 20
    },
    "networkConfig" : {
      "vpcId" : "vpc-abc",
      "vswitchId" : "vsw-abc",
      "vsArea" : "cn-hangzhou-b",
      "type" : "vpc"
    },
    "createdAt" : "2018-07-17T18:19:02.019Z",
    "updatedAt" : "2018-07-18T10:10:04.484Z",
    "inited" : true,
    "dedicateMaster" : false,
    "commodityCode" : "elasticsearch",
    "endTime" : 4687603200000,
    "dictList" : [ ]
  }, {
    "instanceId" : "es-cn-def",
    "domain" : "es-cn-def.elasticsearch.aliyuncs.com",
    "description" : "keepit",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "paymentInfo" : null,
    "status" : "active",
    "port" : 9200,
    "esVersion" : "5.5.3_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "logfile",
      "xpack.watcher.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-def.kibana.elasticsearch.aliyuncs.com",
    "publicDomain" : null,
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20
    },
    "networkConfig" : {
      "vpcId" : "vpc-def",
      "vswitchId" : "vsw-def",
      "vsArea" : "cn-hangzhou-b",
      "type" : "vpc"
    },
    "createdAt" : "2018-07-13T03:58:07.253Z",
    "updatedAt" : "2018-07-18T10:10:15.259Z",
    "inited" : true,
    "dedicateMaster" : true,
    "commodityCode" : "elasticsearch",
    "endTime" : 4687171200000,
    "dictList" : [ ]
  } ],
  "RequestId" : "E2BAE51F-48A8-44D2-B5CD-A3BCE6B8****",
  "Headers" : {
    "X-Total-Count" : 2
  }
}

错误码

HttpCode 错误码 错误信息 描述
401 UserUnauthorized Authentication required 用户验证失败，请先登录并核对是否有权限
401 SubAccountNoPermission Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM 子账户无权限，请核对子账号权限

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