You can call this operation to query detailed information about a specified Elasticsearch instance.

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/[InstanceId] HTTP/1.1

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-s9dsk3k4k****

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The ID of the request.

Result

Detailed information about the instance.

advancedDedicateMaster Boolean false

Indicates whether the instance contains dedicated master nodes.

clientNodeConfiguration

The configuration of client nodes.

amount Integer 3

The number of client nodes.

disk Integer 40

The disk size per client node. Unit: GB.

diskType String cloud_efficiency

The disk type of client nodes. cloud_efficiency: ultra disk.

spec String elasticsearch.n4.small

The specification of client 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.

dictList Array

The configuration of the IK dictionary.

fileSize Long 2782602

The size of the IK dictionary file. Unit: bytes.

name String SYSTEM_MAIN.dic

The name of the IK dictionary file.

sourceType String ORIGIN

The source of the IK dictionary file.

type String MAIN

The type of the IK dictionary. Valid values: MAIN (main dictionary) and STOP (stopword list).

domain String es-cn-abc.elasticsearch.aliyuncs.com

The private network endpoint of the instance.

enableKibanaPublicNetwork Boolean true

Indicates whether Kibana enables public network access.

enablePublic Boolean true

Indicates whether the instance enables public network access.

esConfig Map {"http.cors.allow-credentials":"false"}

The YML configuration of the instance.

esIPBlacklist List [ "0.0.0.0/0" ]

The configuration of the private network blacklist. This feature is deprecated.

esIPWhitelist List [ "0.0.0.0/0" ]

The configuration of the private network whitelist. This feature is deprecated.

esVersion String 5.5.3_with_X-Pack

The version of the instance.

haveClientNode Boolean true

Indicates whether the instance contains client nodes.

haveKibana Boolean true

Indicates whether the instance contains Kibana nodes.

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 40

The disk size per Kibana node. Unit: GB.

diskType String cloud_ssd

The disk type of Kibana nodes. Please ignore this parameter.

spec String elasticsearch.n4.small

The specification of Kibana nodes.

kibanaDomain String es-cn-abc.kibana.elasticsearch.aliyuncs.com

The endpoint of Kibana.

kibanaIPWhitelist List [ "0.0.0.0/0" ]

The configuration of the Kibana private network whitelist.

kibanaPort Integer 5601

The port of the Kibana node.

masterConfiguration

The configuration of dedicated master nodes.

amount Integer 3

The number of dedicated master nodes.

disk Integer 40

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

diskType String cloud_ssd

The disk type of dedicated master nodes. cloud_ssd: standard SSD.

spec String elasticsearch.n4.small

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

The zone where the instance is deployed.

vswitchId String vsw-abc

The ID of the VSwitch.

nodeAmount Integer 2

The number of data nodes.

nodeSpec

The configuration of data nodes.

disk Integer 40

The disk size per data node. Unit: GB.

diskType String cloud_ssd

The disk type of data nodes. cloud_ssd: standard SSD.

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).

port Integer 9200

The port of the instance.

privateNetworkIpWhiteList List 0.0.0.0/0

The configuration of the private network whitelist.

protocol String HTTP

The communication protocol. Valid values: HTTP and HTTPS.

publicDomain String es-cn-abc.elasticsearch.aliyuncs.com

The public network endpoint of the instance.

publicIpWhitelist List [ "0.0.0.0/0" ]

The configuration of the public network whitelist.

publicPort Integer 8033

The public network port.

status String active

The status of the instance. Valid values: active (normal), activating (initializing), inactive (locked), and invalid (expired).

synonymsDicts Array

The configuration of the synonym dictionary.

fileSize Long 2782602

The size of the synonym dictionary file. Unit: bytes.

name String SYSTEM_MAIN.dic

The name of the synonym dictionary file.

sourceType String ORIGIN

The source of the synonym dictionary file.

type String STOP

The type of the synonym dictionary. Valid values: MAIN (main dictionary) and STOP (stopword list).

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

The time when the instance was last updated.

vpcInstanceId String vpc-bp1uag5jj38c****

The ID of the VPC instance.

warmNode Boolean true

Indicates whether the instance contains warm nodes.

warmNodeConfiguration

The configuration of warm nodes.

amount Integer 6

The number of warm nodes.

disk Integer 500

The disk size per warm node. Unit: GB.

diskType String cloud_efficiency

The disk type of warm nodes. cloud_efficiency: ultra disk.

spec String elasticsearch.n4.small

The specification of warm nodes.

zoneCount Integer 2

The number of zones.

zoneInfos Array

Zone information.

status String NORMAL

The status of the zone. Valid values: ISOLATION and NORMAL.

zoneId String cn-hangzhou-b

The ID of the zone.

Examples

Sample requests

GET /openapi/instances/[InstanceId] HTTP/1.1
Common request header
{
  "InstanceId": "es-cn-s9dsk3k4k****"
}

Sample success responses

XML format

<Result>
    <instanceId>es-cn-pp7055iz678v1****</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>es-cn-pp7055iz678v1****</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-18T16:10:05.147Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687603200000</endTime>
</Result>
<RequestId>B0BB1C4B-AF9C-465D-BED4-9E4C5B54****</RequestId>

JSON format

{
	"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-pp7055iz678v1****",
		"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-pp7055iz678v1****",
		"esIPWhitelist":[],
		"updatedAt":"2018-07-18T16:10:05.147Z",
		"esIPBlacklist":[],
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"commodityCode":"elasticsearch"
	},
	"RequestId":"B0BB1C4B-AF9C-465D-BED4-9E4C5B54****"
}

Error codes

HTTP status code Error code Error message Description
400 InstanceNotFound The instanceId provided does not exist The error message returned because the specified instance cannot be found. Please check the status of the instance.

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