tencent cloud



Last updated: 2023-02-13 10:21:13

1. API Description

Domain name for API request: es.tencentcloudapi.com.

This API is used to query all eligible instances in the current region under the current account.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 of the cluster instance. If this is not passed in, all AZs are used by default
InstanceIds.N No Array of String List of cluster instance IDs
InstanceNames.N No Array of String List of cluster instance names
Offset No Integer Pagination start value. Default value: 0
Limit No Integer Number of entries per page. Default value: 20
OrderByKey No Integer The sorting field.
  • 1: Instance ID
  • 2: Instance name
  • 3: AZ
  • 4: Creation time
  • If OrderByKey is not passed in, sorting is performed by creation time in descending order.
    OrderByType No Integer Sorting order
  • 0: ascending
  • 1: descending
  • If orderByKey is passed in but orderByType is not, ascending order is used by default
    TagList.N No Array of TagInfo Node tag information list
    IpList.N No Array of String VPC VIP list
    ZoneList.N No Array of String List of availability zones
    HealthStatus.N No Array of Integer The health status filter. Valid values: 0 (green), 1 (yellow), 2 (red), -1 (unknown).
    VpcIds.N No Array of String VPC IDs

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of returned instances
    InstanceList Array of InstanceInfo List of instance details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying an ES cluster instance

    This example shows you how to query ES cluster instances according to the given criteria and return their details.

    Input Example

    POST / HTTP/1.1
    Host: es.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInstances
    <Common request parameters>

    Output Example

        "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",
                    "Status": 1,
                    "ChargeType": "POSTPAID_BY_HOUR",
                    "ChargePeriod": 0,
                    "RenewFlag": "",
                    "NodeInfoList": [
                            "Type": "hotData",
                            "NodeNum": 3,
                            "NodeType": "ES.SA2.MEDIUM4",
                            "DiskType": "CLOUD_SSD",
                            "DiskSize": 20,
                            "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": "{}",
                    "EsConfigSets": [],
                    "KibanaConfig": "",
                    "EsAcl": {
                        "WhiteIpList": [
                        "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": "xx",
                            "PublicAccess": "xx",
                            "PrivateUrl": "xx",
                            "Version": "xx",
                            "Type": "xx",
                            "PublicUrl": "xx"
                    "ProcessPercent": 0.5,
                    "EnableHybridStorage": true
            "RequestId": "xxxx"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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.UnAuthorizedOperation Unauthorized operation.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    UnsupportedOperation Unsupported operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support