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 obtain the index list.

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: DescribeIndexList.
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.
IndexType Yes String Index type. auto: Automated; normal: General.
InstanceId No String ES cluster ID
IndexName No String Index name. null indicates that all indexes are requested.
Username No String Username for cluster access
Password No String Password for cluster access
Offset No Integer The starting position of paging
Limit No Integer The number of results per page
OrderBy No String Sorting condition field, which can be IndexName, IndexStorage, or IndexCreateTime.
IndexStatusList.N No Array of String Filtering by index status
Order No String Sorting mode, which can be asc and desc.

3. Output Parameters

Parameter Name Type Description
IndexMetaFields Array of IndexMetaField Index metadata field
Note: This field may return null, indicating that no valid value can be obtained.
TotalCount Integer Total number of results
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining index list

Input Example

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

    "Username": "xx",
    "IndexName": "xx",
    "IndexType": "xx",
    "InstanceId": "xx",
    "Limit": 0,
    "Offset": 0,
    "Password": "xx"

Output Example

    "Response": {
        "TotalCount": 0,
        "RequestId": "xx",
        "IndexMetaFields": [
                "BackingIndices": [
                        "IndexPhrase": "xx",
                        "IndexStatus": "xx",
                        "IndexStorage": 0,
                        "IndexName": "xx",
                        "IndexCreateTime": "xx"
                "IndexOptionsField": {
                    "WriteMode": "xx",
                    "RolloverMaxAge": "xx",
                    "ExpireMaxAge": "xx",
                    "RolloverDynamic": "xx",
                    "ExpireMaxSize": "xx",
                    "ShardNumDynamic": "xx",
                    "TimestampField": "xx"
                "IndexName": "xx",
                "IndexType": "xx",
                "IndexPolicyField": {
                    "WarmEnable": "xx",
                    "WarmMinAge": "xx",
                    "ColdMinAge": "xx",
                    "FrozenEnable": "xx",
                    "FrozenMinAge": "xx",
                    "ColdEnable": "xx"
                "ClusterName": "xx",
                "IndexStatus": "xx",
                "ClusterId": "xx",
                "IndexCreateTime": "xx",
                "ClusterVersion": "xx",
                "IndexStorage": 0

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 CAM signature/authentication error
AuthFailure.UnAuthorizedOperation Unauthorized operation.
FailedOperation Operation failed.
FailedOperation.ErrorClusterState Incorrect cluster status
FailedOperation.ErrorClusterStateUnhealth The cluster is unhealthy.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse Resource is in use.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
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