Queries the detailed information of all Elasticsearch clusters or a specified Elasticsearch cluster.

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 headers

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

Request syntax

GET /openapi/instances HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
page Integer Query No 1

The page number of the returned page.

Start value: 1. Default value: 1.

size Integer Query No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

description String Query No aliyunes_test1

The name of the instance. You can specify a keyword to match multiple instances. For example, if you search for all instances of a abc, you might return all instances of abc, abcde, xyabc, and xabcy.

instanceId String Query No es-cn-v641a0ta3000g****

The ID of the instance.

esVersion String Query No 6.7_with_X-Pack

The edition of the dedicated KMS instance.

resourceGroupId String Query No rg-aekzvowej3i****

The ID of the resource group to which the new ECS instance belongs.

tags String Query No [{"tagKey":"key1","tagValue":"value1"}]

The tags of the instance. Each tag is a key-value pair.

vpcId String Query No vpc-bp16k1dvzxtmagcva****

The ID of the Virtual Private Cloud to which the instance belongs.

zoneId String Query No cn-hangzhou-i

The zone ID of the instance.

paymentType String Query No postpaid

The billing method of the instance. Default value: no. Valid values:

  • postpaid: pay-as-you-go
  • prepaid: subscription
instanceCategory String Query No advanced

The version type of the instance. Default value: no. Valid values:

  • x-pack: Business Edition
  • advanced/IS: Enhanced Edition
  • community: Basic Edition

Response parameters

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

The ID of the request.

Headers Object

The header of the response.

X-Total-Count Integer 10

The number of entries returned per page.

Result Array of Instance

The returned data.

advancedDedicateMaster Boolean false

Specifies whether to include dedicated master nodes. Valid values:

  • true: The files contain data that is dumped to the IA storage medium.
  • false: The files do not contain data that is dumped to the IA storage medium.
nodeAmount Integer 2

The number of data nodes.

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

The time when the node is created.

status String active

The status of the instance. Valid values:

  • active: normal
  • activating: taking effect
  • inactive: frozen
  • invalid: invalid
dedicateMaster Boolean false

Specifies whether to include dedicated master nodes (obsolete). Valid values:

  • true: The files contain data that is dumped to the IA storage medium.
  • false: The files do not contain data that is dumped to the IA storage medium.
serviceVpc Boolean true

Indicates whether it is a service VPC.

paymentType String postpaid

The billing method of the instance. Valid values:

  • prepaid: subscription
  • postpaid: pay-as-you-go
resourceGroupId String rg-aekzvowej3i****

The ID of the resource group.

postpaidServiceStatus String active

The status of the pay-as-you-go service that is overlaid on a subscription instance. Valid values:

  • active: normal
  • closed: Close
  • indebt: Overdue payments are frozen
description String es-cn-abc

The name of the instance.

esVersion String 6.7_with_X-Pack

The edition of the dedicated KMS instance.

isNewDeployment String true

Specifies whether to deploy the new architecture.

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

The time when the instance was last updated.

instanceId String es-cn-v641a0ta3000g****

The ID of the instance.

tags Array of Tag

The tags of the instance. Each tag is a key-value pair.

tagKey String env

The key of the tag.

tagValue String dev

The value of the tag.

extendConfigs Array of Object [{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]

The configuration of cluster extension parameters.

clientNodeConfiguration Object

Coordination node configuration.

spec String elasticsearch.sn2ne.large

The instance type of the node. For more information, see Specifications.

amount Integer 3

The number of nodes.

disk Integer 20

The size of the node storage space. Unit: GB.

diskType String cloud_efficiency

The storage type of the node. Only ultra disks (cloud_efficiency) are supported.

elasticDataNodeConfiguration Object

The configurations of elastic data nodes.

spec String elasticsearch.sn2ne.large

The instance type of the node. For more information, see Specifications.

amount Integer 3

The number of nodes.

disk Integer 20

The size of the node storage space. Unit: GB.

diskEncryption Boolean true

Specifies whether to enable disk encryption for the node. Valid values:

  • true: enables instant image cache.
  • false: disables reuse of image cache layers.
diskType String cloud_ssd

The storage type of the node. Valid values:

  • cloud_ssd: SSD.
  • cloud_essd: ESSD.
  • cloud_efficiency: ultra disk
kibanaConfiguration Object

The configuration of Kibana nodes.

spec String elasticsearch.n4.small

The instance type of the node. For more information, see Specifications.

amount Integer 1

The number of nodes.

disk Integer 20

The size of the node storage space. Unit: GB.

diskType String cloud_ssd

The storage type of the node.

masterConfiguration Object

The configuration of dedicated master nodes.

spec String elasticsearch.sn2ne.large

The instance type of the node. For more information, see Specifications.

amount Integer 3

The number of nodes.

disk Integer 20

The size of the node storage space. Unit: GB.

diskType String cloud_ssd

The storage type of the node. Only cloud_ssd(SSD cloud disk) is supported.

networkConfig Object

The network configurations.

vpcId String vpc-abc

The VPC ID of the cluster.

vsArea String cn-hangzhou-e

The zone where the cluster resides.

type String vpc

The network type. Only Virtual Private Cloud (VPC) is supported.

vswitchId String vsw-def

The vSwitch ID of the cluster.

nodeSpec Object

The configuration of data nodes.

spec String elasticsearch.n4.small

The instance type of the node. For more information, see Specifications.

disk Integer 50

The storage space of the node. Unit: GB.

diskEncryption Boolean false

Specifies whether to use disk encryption. Valid values:

  • true
  • false
diskType String cloud_ssd

The storage type of the node. Valid values:

  • cloud_ssd: standard SSD
  • cloud_efficiency: ultra disk
performanceLevel String PL1

The performance level of the ESSD. This parameter is required when the diskType parameter is set to cloud_essd. Valid values: PL1, PL2, and PL3.

vpcInstanceId String vpc-bp1uag5jj38c****

The VPC ID of the cluster.

Note In the following return example, this article only guarantees that the parameters in the return data list are included, and the parameters not mentioned are for reference only. The program cannot force to rely on obtaining these parameters.

Examples

Sample requests

GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "instanceId" : "es-cn-v641a0ta3000g****",
    "description" : "aliyunes_test1",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "serviceVpc" : true,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : true
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1xk0naij7jx4ph1****",
      "vswitchId" : "vsw-bp1ogpdintii5qvyx****",
      "vsArea" : "cn-hangzhou-g",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-26T08:18:06.652Z",
    "updatedAt" : "2019-08-26T08:19:49.448Z",
    "inited" : true,
    "tags" : [ {
      "tagKey" : "key1",
      "tagValue" : "value1"
    } ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : true,
    "masterConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20
    },
    "haveClientNode" : true,
    "warmNode" : true,
    "warmNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 500,
      "diskEncryption" : true
    },
    "clientNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 20
    },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4722508800000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-g",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  }, {
    "instanceId" : "es-cn-v641920bh0006****",
    "description" : "aliyunes_test2",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn2ne.2xlarge",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1op7luys63go2x5****",
      "vswitchId" : "vsw-bp1rusvg785q97ucp****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-07T13:14:07.974Z",
    "updatedAt" : "2019-08-12T03:04:27.215Z",
    "inited" : true,
    "tags" : [ ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4720867200000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  } ]
}

Error codes

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