ListInstance-Elasticsearch(ES)-阿里云帮助中心

Retrieves a list of Elasticsearch instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

elasticsearch:ListInstance

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/*

None

Request syntax

GET /openapi/instances HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
page	integer	No	The page number of the instance list.	1
size	integer	No	The number of entries per page in a paged query. Settings the number of entries per page for paging. Maximum value: 100. Default value: 10.	10
description	string	No	The instance name. Fuzzy match is supported. For example, if you search for abc, all instances whose names contain abc may be returned, such as abc, abcde, xyabc, and xabcy.	aliyunes_test1
instanceId	string	No	The instance ID.	es-cn-v641a0ta3000g****
esVersion	string	No	The instance version.	6.7_with_X-Pack
resourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-aekzvowej3i****
tags	string	No	The instance tags.	[{"tagKey":"key1","tagValue":"value1"}]
vpcId	string	No	The ID of the virtual private cloud (VPC) in which the instance resides.	vpc-bp16k1dvzxtmagcva****
zoneId	string	No	The zone ID of the instance.	cn-hangzhou-i
paymentType	string	No	The billing method of the instance. Valid values:	postpaid
instanceCategory	string	No	The edition of the instance. Valid values:	advanced
status	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Headers	object	The response headers.
X-Total-Count	integer	The total number of instance records.	10
Result	array<object>	The returned results.
	array<object>
advancedDedicateMaster	boolean	Indicates whether the instance contains dedicated master nodes. Valid values:	false
nodeAmount	integer	The number of data nodes in the instance.	2
createdAt	string	The time when the instance was created.	2018-07-13T03:58:07.253Z
status	string	The status of the instance. Valid values:	active
dedicateMaster	boolean	[Deprecated] Indicates whether the instance contains dedicated master nodes. Valid values:	false
serviceVpc	boolean	Indicates whether the instance is a service VPC.	true
paymentType	string	The billing method of the instance. Valid values:	postpaid
resourceGroupId	string	The resource group ID.	rg-aekzvowej3i****
postpaidServiceStatus	string	The status of the pay-as-you-go service that is overlaid on the subscription instance. Valid values:	active
description	string	The name of the instance.	es-cn-abc
esVersion	string	The instance version.	6.7_with_X-Pack
isNewDeployment	string	Indicates whether the instance uses the new deployment architecture.	true
updatedAt	string	The time when the instance was last updated.	2018-07-18T10:10:04.484Z
instanceId	string	The instance ID.	es-cn-v641a0ta3000g****
tags	array<object>	The instance tags.
	object
tagKey	string	The tag key.	env
tagValue	string	The tag value.	dev
extendConfigs	array<object>	The extension parameter settings of the cluster.
	object	The extension parameter settings of the cluster.	[{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]
clientNodeConfiguration	object	The configuration of client nodes.
spec	string	The node specifications. For more information, see Product specifications.	elasticsearch.sn2ne.large
amount	integer	The number of nodes.	3
disk	integer	The storage size of the node. Unit: GB.	20
diskType	string	The storage type of the node. Only ultra disks (cloud_efficiency) are supported.	cloud_efficiency
specInfo	string	The node specifications description.	1C 2G
elasticDataNodeConfiguration	object	The configuration of elastic data nodes.
spec	string	The node specifications. For more information, see Product specifications.	elasticsearch.sn2ne.large
amount	integer	The number of nodes.	3
disk	integer	The storage size of the node. Unit: GB.	20
diskEncryption	boolean	Indicates whether cloud disk encryption is enabled for the node. Valid values: true: Enabled. false: Disabled.	true
diskType	string	The storage type of the node. Valid values: cloud_ssd: standard SSD. cloud_essd: ESSD. cloud_efficiency: ultra disk.	cloud_ssd
specInfo	string	The node specifications description.	1C 2G
kibanaConfiguration	object	The configuration of Kibana nodes.
spec	string	The node specifications. For more information, see Product specifications.	elasticsearch.n4.small
amount	integer	The number of nodes.	1
disk	integer	The storage size of the node. Unit: GB.	20
diskType	string	The storage type of the node.	cloud_ssd
specInfo	string	The node specifications description.	1C 2G
masterConfiguration	object	The configuration of master nodes.
spec	string	The node specifications. For more information, see Product specifications.	elasticsearch.sn2ne.large
amount	integer	The number of nodes.	3
disk	integer	The storage size of the node. Unit: GB.	20
diskType	string	The storage type of the node. Only cloud_ssd (standard SSD) is supported.	cloud_ssd
specInfo	string	The node specifications description.	1C 2G
networkConfig	object	The network configuration.
vpcId	string	The VPC ID.	vpc-abc
vsArea	string	The zone in which the instance resides.	cn-hangzhou-e
type	string	The network type. Only Virtual Private Cloud (VPC) is supported.	vpc
vswitchId	string	The vSwitch ID.	vsw-def
whiteIpGroupList	array<object>	The whitelist group settings for public and private network access to the cluster.
	object
groupName	string	The group name.	default
whiteIpType	string	The network type. PRIVATE_ES: Elasticsearch private network. PUBLIC_KIBANA: Kibana public network. PUBLIC_ES: Elasticsearch public network. PRIVATE_KIBANA: Kibana private network.	PUBLIC_KIBANA
ips	array	The network whitelist.
	string	The network whitelist.	["0.0.0.0", "127.0.XX.XX"]
nodeSpec	object	The configuration of data nodes.
spec	string	The node specifications. For more information, see Product specifications.	elasticsearch.n4.small
disk	integer	The storage size of the node. Unit: GB.	50
diskEncryption	boolean	Indicates whether disk encryption is enabled. Valid values: true: Enabled. false: Disabled.	false
diskType	string	The storage type of the node. Valid values: cloud_ssd: standard SSD. cloud_efficiency: ultra disk.	cloud_ssd
performanceLevel	string	The performance level (PL) of the ESSD. This parameter is required when diskType is set to cloud_essd. Valid values: PL1, PL2, and PL3.	PL1
specInfo	string	The node specifications description.	1C 2G
diskPreference	string		high_availability
vpcInstanceId	string	The VPC ID.	vpc-bp1uag5jj38c****
kibanaIPWhitelist	array	The public network access whitelist for the Kibana node of the cluster.
	string	The public network access whitelist for the Kibana node of the cluster.	"0.0.0.0/0"
kibanaPrivateIPWhitelist	array	The private network access whitelist for the Kibana node of the cluster.
	string	The private network access whitelist for the Kibana node of the cluster.	["192.168.XX.XX"]
publicIpWhitelist	array	The public network access whitelist for the Elasticsearch cluster.
	string	The public network access whitelist for the Elasticsearch cluster.	[ "0.0.0.0/0" ]
privateNetworkIpWhiteList	array	The private network access IP whitelist for the Elasticsearch cluster.
	string	The private network access IP whitelist for the Elasticsearch cluster.	["192.168.XX.XX/25"]
endTime	integer	The time when the instance expires.	1715826092044
archType	string	The deployment mode. Architecture type:	public
domain	string	The internal endpoint of the instance.	es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com
port	string	The access port of the instance.	9200
protocol	string	The access protocol. Valid values: HTTP and HTTPS.	HTTP
zoneCount	integer		1
zoneInfos	array<object>
	object
zoneId	string		cn-hangzhou-i
status	string		NORMAL

Note

The following response example contains most of the parameters in the response. The actual response prevails. We recommend that your application does not depend on the presence of any specific parameter.

Examples

Success response

JSON format

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****",
  "Headers": {
    "X-Total-Count": 10
  },
  "Result": [
    {
      "advancedDedicateMaster": false,
      "nodeAmount": 2,
      "createdAt": "2018-07-13T03:58:07.253Z",
      "status": "active",
      "dedicateMaster": false,
      "serviceVpc": true,
      "paymentType": "postpaid",
      "resourceGroupId": "rg-aekzvowej3i****",
      "postpaidServiceStatus": "active",
      "description": "es-cn-abc",
      "esVersion": "6.7_with_X-Pack",
      "isNewDeployment": "true",
      "updatedAt": "2018-07-18T10:10:04.484Z",
      "instanceId": "es-cn-v641a0ta3000g****",
      "tags": [
        {
          "tagKey": "env",
          "tagValue": "dev"
        }
      ],
      "extendConfigs": [
        [
          {
            "configType": "aliVersion",
            "aliVersion": "ali1.3.0"
          }
        ]
      ],
      "clientNodeConfiguration": {
        "spec": "elasticsearch.sn2ne.large",
        "amount": 3,
        "disk": 20,
        "diskType": "cloud_efficiency",
        "specInfo": "1C 2G"
      },
      "elasticDataNodeConfiguration": {
        "spec": "elasticsearch.sn2ne.large",
        "amount": 3,
        "disk": 20,
        "diskEncryption": true,
        "diskType": "cloud_ssd",
        "specInfo": "1C 2G "
      },
      "kibanaConfiguration": {
        "spec": "elasticsearch.n4.small",
        "amount": 1,
        "disk": 20,
        "diskType": "cloud_ssd",
        "specInfo": "1C 2G "
      },
      "masterConfiguration": {
        "spec": "elasticsearch.sn2ne.large",
        "amount": 3,
        "disk": 20,
        "diskType": "cloud_ssd",
        "specInfo": "1C 2G "
      },
      "networkConfig": {
        "vpcId": "vpc-abc",
        "vsArea": "cn-hangzhou-e",
        "type": "vpc",
        "vswitchId": "vsw-def",
        "whiteIpGroupList": [
          {
            "groupName": "default",
            "whiteIpType": "PUBLIC_KIBANA",
            "ips": [
              "[\"0.0.0.0\", \"127.0.XX.XX\"]"
            ]
          }
        ]
      },
      "nodeSpec": {
        "spec": "elasticsearch.n4.small",
        "disk": 50,
        "diskEncryption": false,
        "diskType": "cloud_ssd",
        "performanceLevel": "PL1",
        "specInfo": "1C 2G ",
        "diskPreference": "high_availability"
      },
      "vpcInstanceId": "vpc-bp1uag5jj38c****",
      "kibanaIPWhitelist": [
        "\"0.0.0.0/0\""
      ],
      "kibanaPrivateIPWhitelist": [
        "[\"192.168.XX.XX\"]"
      ],
      "publicIpWhitelist": [
        "[ \"0.0.0.0/0\" ]"
      ],
      "privateNetworkIpWhiteList": [
        "[\"192.168.XX.XX/25\"]"
      ],
      "endTime": 1715826092044,
      "archType": "public",
      "domain": "es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com",
      "port": "9200",
      "protocol": "HTTP",
      "zoneCount": 1,
      "zoneInfos": [
        {
          "zoneId": "cn-hangzhou-i",
          "status": "NORMAL"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.