You can call this operation to query Alibaba Cloud Elasticsearch instances that match the specified query string and retrieve detailed information about these instances.

Note You can specify request parameters to construct a query string. The logical relation between these parameters is AND. Unspecified parameters are not included in the query string.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

GET /openapi/instances HTTP/1.1

Request parameters

Parameter Type Required Example Description
description String No es-cn-abc

The name of the instance. You can specify a keyword to match multiple instances. For example, if you specify abc, instances whose names are abc, abcde, xyabc, and xabcy are matched.

esVersion String No 5.3_with_X-Pack

The version of the instance.

instanceId String No es-cn-abc

The ID of the instance.

page Integer No 1

The number of the page to return.

Minimum value: 1. Default value: 1.

resourceGroupId String No rg-aekzvowej3i****

The ID of the resource group.

size String No 10

The number of entries to return on each page.

Maximum value: 100. Default value: 10.

Response parameters

Parameter Type Example Description
Headers

The header of the response.

X-Total-Count Integer 10

The number of instances that match the query string.

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The ID of the request.

Result Array

Detailed information about the matching instances.

advancedDedicateMaster Boolean false

Indicates whether the instance contains dedicated master nodes.

createdAt String 2018-07-13T03:58:07.253Z

The time when the instance was created.

dedicateMaster Boolean false

Indicates whether the instance contains dedicated master nodes. This parameter is only supported by earlier Elasticsearch versions.

description String es-cn-abc

The name of the instance.

esVersion String 5.5.3_with_X-Pack

The version of the instance.

instanceId String es-cn-abc

The ID of the instance.

kibanaConfiguration

The configuration of Kibana nodes.

amount Integer 1

The number of Kibana nodes. Only one Kibana node is supported.

disk Integer 0

The disk size per Kibana node. Unit: GB.

diskType String cloud_ssd

The disk type of Kibana nodes.

spec String elasticsearch.n4.small

The specification of Kibana nodes.

masterConfiguration

The configuration of dedicated master nodes.

amount Integer 3

The number of dedicated master nodes.

disk Integer 20

The disk size per dedicated master node. Unit: GB.

diskType String cloud_ssd

The disk type of dedicated master nodes.

spec String elasticsearch.sn2ne.large

The specification of dedicated master nodes.

networkConfig

The network configuration.

type String vpc

The type of the network. Only VPC networks are supported.

vpcId String vpc-abc

The ID of the VPC network.

vsArea String cn-hangzhou-e

The zone where the instance is deployed.

vswitchId String vsw-def

The ID of the VSwitch.

nodeAmount Integer 2

The number of data nodes.

nodeSpec

The configuration of data nodes.

disk Integer 50

The disk size per data node. Unit: GB.

diskType String cloud_ssd

The disk type of data nodes.

spec String elasticsearch.n4.small

The specification of data nodes.

paymentType String postpaid

The billing method of the instance.

Valid values: prepaid (subscription) and postpaid (pay-as-you-go).

status String active

The status of the instance.

Valid values: active (normal), activating (initializing), inactive (locked), and invalid (expired).

updatedAt String 2018-07-18T10:10:04.484Z

The time when the instance was last updated.

Examples

Sample requests

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

Sample success responses

XML format

<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 format

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

Error codes

HTTP status code Error code Error message Description
401 UserUnauthorized Authentication required The error message returned because you are not authorized to perform the operation. Please log on to the console and check whether you have the required permission.
401 SubAccountNoPermission Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM The error message returned because the RAM user does not have the required permission. Please check the permissions of the RAM user.

For a list of error codes, visit the API Error Center.