Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to obtain the index list.
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: 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: autonomous index; normal: general index |
| InstanceId | No | String | ES cluster ID |
| IndexName | No | String | Index name. If this parameter is left empty, all indexes are obtained. |
| Username | No | String | Cluster access username. |
| Password | No | String | Cluster access password |
| Offset | No | Integer | Paging start position |
| Limit | No | Integer | Number of items displayed per page |
| OrderBy | No | String | Sorting fields, which support the following index names: IndexName, IndexStorage, and IndexCreateTime. |
| IndexStatusList.N | No | Array of String | Filter by index status |
| Order | No | String | Sort order. Supports asc and desc. Defaults to desc. Data format: "asc", "desc" |
| Parameter Name | Type | Description |
|---|---|---|
| IndexMetaFields | Array of IndexMetaField | Index metadata field |
| TotalCount | Integer | Total query count |
| 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. |
Get index metadata
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndexList
<Common request parameters>
{
"Username": "elastic",
"IndexName": "index_test",
"IndexType": "auto",
"InstanceId": "es-abcdefgh",
"Limit": 0,
"Offset": 10,
"Password": "ascq23***********cjaw"
}{
"Response": {
"IndexMetaFields": [
{
"IndexType": "auto",
"IndexName": "index_test",
"IndexMetaJson": "{\"f1\":52}",
"IndexStatus": "green",
"IndexStorage": 0,
"IndexCreateTime": "2024-12-05 17:22:44",
"BackingIndices": [
{
"IndexName": "index_test0",
"IndexStatus": "green",
"IndexStorage": 0,
"IndexPhrase": "data_hot",
"IndexCreateTime": "2024-12-05 17:22:44"
}
],
"ClusterId": "es-hhio223",
"ClusterName": "test-cluster",
"ClusterVersion": "7.14.0",
"IndexPolicyField": {
"WarmEnable": "true",
"WarmMinAge": "16",
"ColdEnable": "true",
"ColdMinAge": "8",
"FrozenEnable": "false",
"FrozenMinAge": "0",
"ColdAction": "migrate"
},
"IndexOptionsField": {
"ExpireMaxAge": "1d",
"ExpireMaxSize": "1024",
"RolloverMaxAge": "1d",
"RolloverDynamic": "true",
"ShardNumDynamic": "true",
"TimestampField": "TIMESTAMP",
"WriteMode": "append_only"
},
"IndexSettingsField": {
"NumberOfShards": "2",
"NumberOfReplicas": "1",
"RefreshInterval": "30s"
},
"AppId": 1,
"IndexDocs": 1
}
],
"TotalCount": 0,
"RequestId": "ah782-j*************c-ih89"
}
}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 |
|---|---|
| FailedOperation.RequestTimeOut | Request timeout. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidEsVersion | The instance version EsVersion does not match the expectation. |
| InvalidParameter.InvalidIndexType | The value of IndexType does not match the expected value. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
피드백