Domain name for API request: es.intl.tencentcloudapi.com.
Updates an index
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 | Updated index type. auto: autonomous index; normal: general index |
| IndexName | Yes | String | Updated index name |
| UpdateMetaJson | No | String | Updated JSON-formatted index metadata, such as mappings and settings |
| Username | No | String | Cluster access username. |
| Password | No | String | Cluster access password |
| RolloverBackingIndex | No | Boolean | Whether to scroll the backup index |
| MountIndex | No | Boolean | Whether to retrieve the full uninstall index |
| IndexUuid | No | String | Index Uuid |
| BackingIndexName | No | String | Backing index name |
| Parameter Name | Type | Description |
|---|---|---|
| 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: UpdateIndex
<Common request parameters>
{
"InstanceId": "es-h3pzdpd6",
"IndexName": "asd",
"IndexType": "normal",
"UpdateMetaJson": "{\"mappings\":{\"properties\":{\"aa\":{\"analyzer\":\"standard\",\"index\":true,\"type\":\"text\"}}},\"settings\":{}}"
}{
"Response": {
"RequestId": "6cf36e17-abdf-4a75-a95a-78a0e59fc959"
}
}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 |
|---|---|
| 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.InvalidIndexMetaJson | The value of the created JSON-formatted index metadata IndexMetaJson does not match expectations. |
| InvalidParameter.InvalidIndexType | The value of IndexType does not match the expected value. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| InvalidParameter.InvalidUpdateMetaJson | The value of the updated json-formatted index metadata UpdateMetaJson does not match expectations. |
| LimitExceeded.UpdateItemLimit | Too many update parameter values. The limit is exceeded. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback