Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to update indices.
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: UpdateIndex. |
| 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. |
| InstanceId | Yes | String | ES cluster ID |
| IndexType | Yes | String | Type of the index to update. auto: Automated; normal: General. |
| IndexName | Yes | String | Name of the index to update |
| UpdateMetaJson | No | String | JSON-formatted index metadata to update, such as mappings and settings. |
| Username | No | String | Username for cluster access |
| Password | No | String | Password for cluster access |
| RolloverBackingIndex | No | Boolean | Whether to roll over the backup index |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateIndex
<Common request parameters>
{
"Username": "xx",
"UpdateMetaJson": "xx",
"IndexType": "xx",
"InstanceId": "xx",
"IndexName": "xx",
"Password": "xx"
}{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}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 | 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. |
文档反馈