Domain name for API request: es.intl.tencentcloudapi.com.
Query all instances meeting conditions for the user in that region
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeInstances. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Zone | No | String | AZ to which the cluster instance belongs. All AZs are selected by default if this parameter is not specified. |
| InstanceIds.N | No | Array of String | Cluster instance ID list |
| InstanceNames.N | No | Array of String | Cluster instance name list. |
| Offset | No | Integer | Pagination starting value. Default value: 0 |
| Limit | No | Integer | Page size. Default value: 20 |
| OrderByKey | No | Integer | Sorting field |
| OrderByType | No | Integer | Sorting method |
| TagList.N | No | Array of TagInfo | Node tag information list |
| IpList.N | No | Array of String | Private network vip list |
| NodeIps.N | No | Array of String | IP list of cluster nodes |
| ZoneList.N | No | Array of String | Availability zone list |
| HealthStatus.N | No | Array of Integer | Health status filter list: 0 represents green, 1 represents yellow, 2 represents red, -1 represents unknown |
| VpcIds.N | No | Array of String | Vpc list filter item |
| CdcId | No | String | cdc cluster id |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of returned instances |
| InstanceList | Array of InstanceInfo | Instance detail list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query an ES cluster instance
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<Common request parameters>
{}{
"Response": {
"TotalCount": 1,
"InstanceList": [
{
"InstanceId": "es-7sy7efoi",
"InstanceName": "_some_name_",
"InstanceType": 2,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-3",
"AppId": 130000000,
"Uin": "100000000",
"VpcUid": "vpc-xxxxxx",
"SubnetUid": "subnet-xxxxxx",
"CdcId": "cluster-xxxxxxxx",
"Status": 1,
"ChargeType": "POSTPAID_BY_HOUR",
"ChargePeriod": 0,
"RenewFlag": "",
"NodeInfoList": [
{
"Type": "hotData",
"NodeNum": 3,
"NodeType": "ES.SA2.MEDIUM4",
"CpuNum": 0,
"MemSize": 0,
"DiskType": "CLOUD_SSD",
"DiskSize": 20,
"DiskEnhance": 0,
"DiskEncrypt": 0,
"DiskCount": 1,
"LocalDiskInfo": null
}
],
"NodeType": "ES.SA2.MEDIUM4",
"NodeNum": 3,
"CpuNum": 2,
"MemSize": 4,
"DiskType": "CLOUD_SSD",
"AutoIndexEnabled": true,
"DiskSize": 20,
"EnableHotWarmMode": false,
"WarmNodeType": "",
"WarmNodeNum": 0,
"WarmCpuNum": 0,
"WarmMemSize": 0,
"WarmDiskType": "",
"WarmDiskSize": 0,
"ColdNodeType": "",
"ColdNodeNum": 0,
"ColdCpuNum": 0,
"ColdMemSize": 0,
"ColdDiskType": "",
"ColdDiskSize": 0,
"FrozenNodeType": "",
"FrozenNodeNum": 0,
"FrozenCpuNum": 0,
"FrozenMemSize": 0,
"FrozenDiskType": "",
"FrozenDiskSize": 0,
"MasterNodeInfo": {
"EnableDedicatedMaster": false,
"MasterNodeType": "",
"MasterNodeNum": 0,
"MasterNodeCpuNum": 0,
"MasterNodeMemSize": 0,
"MasterNodeDiskType": "",
"MasterNodeDiskSize": 0
},
"KibanaNodeInfo": {
"KibanaNodeType": "ES.SA2.SMALL2",
"KibanaNodeNum": 1,
"KibanaNodeCpuNum": 1,
"KibanaNodeMemSize": 2,
"KibanaNodeDiskType": "CLOUD_PREMIUM",
"KibanaNodeDiskSize": 50
},
"EsDomain": "es-7sy7efoi.myelasticsearch.com",
"EsPrivateDomain": "es-7sy7efoi-esinternal.kibana.myelasticsearch.com",
"EsVip": "{vip}",
"EsPort": 9200,
"KibanaUrl": "https://es-7sy7efoi.kibana.myelasticsearch.com:5601",
"KibanaPrivateUrl": "",
"PublicAccess": "CLOSE",
"KibanaPublicAccess": "OPEN",
"KibanaPrivateAccess": "CLOSE",
"KibanaAlteringPublicAccess": "CLOSE",
"Protocol": "",
"SecurityGroups": [],
"EsPublicUrl": "",
"EsPrivateUrl": "https://es-7sy7efoi-esinternal.kibana.myelasticsearch.com:9200",
"EsVersion": "7.14.2",
"EsConfig": "{\"http.cors.allow-methods\":\"OPTIONS,HEAD,GET,POST,PUT,DELETE\"}",
"EsConfigSets": [],
"KibanaConfig": "",
"EsAcl": {
"WhiteIpList": [
"127.0.0.1"
],
"BlackIpList": []
},
"EsPublicAcl": {
"WhiteIpList": [],
"BlackIpList": []
},
"IkConfig": {
"UpdateType": "",
"MainDict": [],
"Stopwords": [],
"Synonym": [],
"QQDict": []
},
"AllowCosBackup": true,
"CosBackup": {
"IsAutoBackup": false,
"BackupTime": ""
},
"DeployMode": 0,
"MultiZoneInfo": [
{
"Zone": "ap-guangzhou-3",
"SubnetId": "subnet-q29llw8g"
}
],
"TagList": [],
"HealthStatus": 0,
"SecurityType": 2,
"LicenseType": "platinum",
"SceneType": 1,
"Jdk": "kona",
"WebNodeTypeInfo": {
"NodeNum": 1,
"NodeType": "ES.SA2.SMALL2"
},
"CreateTime": "2022-07-06 20:52:48",
"UpdateTime": "2022-07-07 17:35:29",
"Deadline": "2017-12-04 00:00:00",
"OperationDuration": null,
"OptionalWebServiceInfos": [
{
"Status": 0,
"PrivateAccess": "CLOSE",
"PublicAccess": "CLOSE",
"PrivateUrl": "http://es-xxxxxxxx.internal.cerebro.tencentelasticsearch.com:9000",
"Version": "0.9.4",
"Type": "cerebro",
"PublicUrl": "https://es-xxxxxxxx.cerebro.tencentelasticsearch.com:9000"
}
],
"ProcessPercent": 0.5,
"EnableHybridStorage": true,
"HasKernelUpgrade": true,
"SubProductCode": "sp_es_platium"
}
],
"RequestId": "c1689946-7206-447c-9ee7-33b1cc0360a1"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.UnAuthDescribeInstances | Current user is unauthorized for the query cluster instance operation. Add CAM permission. |
| AuthFailure.UnAuthorizedOperation | Unauthorized operation. |
| FailedOperation.GetTagInfoError | Error getting the tag list of the instance. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidIp | The Ip address value does not meet expectations. |
| InvalidParameter.InvalidIpList | The value of IpList in the private network vip list does not meet expectations. |
| InvalidParameter.InvalidLimit | The value of the pagination size Limit does not match the expectation. |
| InvalidParameter.InvalidNodeType | The value of NodeType does not match the expected value. |
| InvalidParameter.InvalidOffset | The pagination starting value Offset does not match the expectation. |
| InvalidParameter.InvalidOrderByKey | The value of the sorting field OrderByKey does not match the expected value. |
| InvalidParameter.InvalidOrderByType | The value of OrderByType does not match the expected sorting method. |
| InvalidParameter.InvalidRegion | The Region value does not meet the expectation. |
| InvalidParameter.InvalidTagInfo | The value of the node tag information TagInfo does not match the expected value. |
| InvalidParameter.InvalidTagList | The value of the node tag information list TagList does not match the expected value. |
| InvalidParameter.InvalidZone | The information of the availability zone Zone does not meet expectations. |
| ResourceNotFound.CAMInfoNotFound | CAM resource is not found. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
피드백