You can call this operation to display the details of all instances in the list.

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

Request syntax


     GET /openapi/instances HTTP/1.1

Request parameter

Parameter Type Position Required Example Description
page Integer Query No 1

The page number of the returned page.

Starting 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 ApsaraDB for Redis instance.

esVersion String Query No 6.7.0_with_X-Pack

The version of the instance.

resourceGroupId String Query No rg-aekzvowej3i****

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

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

Details about the tags.

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. Valid values:

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

The version of the instance. Valid values:

  • x-pack: Commercial Edition.
  • advanced: enhanced edition.
  • community: the basic version.

Response parameters

Parameter Type Sample response Description
Headers Struct

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 of Instance

The return result of the video moderation task.

advancedDedicateMaster Boolean false

Specifies whether to include dedicated master nodes. Valid values:

  • true: The resource tags are returned.
  • flase: not included.
clientNodeConfiguration Struct

Coordinate node configurations.

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.

spec String elasticsearch.sn2ne.large

The node specification. Specification information is available through Product Specifications View.

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

The time when the instance was created.

dedicateMaster Boolean false

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

  • true: The resource tags are returned.
  • flase: not included.
description String es-cn-abc

The name of the instance.

elasticDataNodeConfiguration Struct

The configuration of the elastic data node.

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 MFA
  • flase: disabled.
diskType String cloud_ssd

The storage type of the node. Valid values:

  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD
  • cloud_efficiency: ultra disk
spec String elasticsearch.sn2ne.large

The node specification. Specification information is available through Product Specifications View.

esVersion String 6.7.0_with_X-Pack

The version of the instance.

extendConfigs List [{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]

The configuration of cluster extension parameters.

instanceId String es-cn-v641a0ta3000g****

The ID of the ApsaraDB for Redis instance.

isNewDeployment String true

Specifies whether to deploy the new architecture.

kibanaConfiguration Struct

The configuration of Kibana nodes.

amount Integer 1

The number of DRDS server nodes.

disk Integer 20

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

diskType String cloud_ssd

The storage type of the node.

spec String elasticsearch.n4.small

The specification of data nodes. Specification information is available through Product Specifications View.

masterConfiguration Struct

The configuration of dedicated master nodes.

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

spec String elasticsearch.sn2ne.large

The node specification. Specification information is available through Product Specifications View.

networkConfig Struct

The network configuration.

type String vpc

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

vpcId String vpc-abc

The ID of the virtual private cloud (VPC).

vsArea String cn-hangzhou-e

The zone where the instance is deployed.

vswitchId String vsw-def

The ID of the vSwitch associated with the specified VPC.

nodeAmount Integer 2

The number of data nodes.

nodeSpec Struct

The configuration of data nodes.

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
spec String elasticsearch.n4.small

The specification of data nodes. Specification information is available through Product Specifications View.

paymentType String postpaid

The billing method of the instance. Valid values:

  • prepaid: subscription.
  • postpaid: pay-as-you-go.
postpaidServiceStatus String active

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

  • active: normal.
  • closed: disabled.
  • indebt: The overdue payment is being frozen.
resourceGroupId String rg-aekzvowej3i****

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

serviceVpc Boolean true

whether it is a service vpc.

status String active

The status of the instance. Valid values:

  • active: normal.
  • activating: The instance is taking effect.
  • inactive: freezes.
  • invalid: invalid.
tags Array of Tag

Details about the tags.

tagKey String env

The tag key of the disk.

tagValue String dev

The tag value of the disk.

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

The time when the instance was last updated.

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?description=abc&page=1&size=10

Sample success response

JSON format 


     { "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 code

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