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: 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. |
| 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, 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. |
POST / HTTP/1.1
Host: es.intl.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"
}
{
"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
}
]
}
}
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 IndexType value does not match the expected value. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
フィードバック