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 |
| MountIndex | No | Boolean | |
| IndexUuid | No | String | |
| BackingIndexName | No | String |
| 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 Parameter>
{
"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 index metadata JSON field IndexMetaJson does not match the expected value. |
| InvalidParameter.InvalidIndexType | The IndexType value does not match the expected value. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| InvalidParameter.InvalidUpdateMetaJson | |
| LimitExceeded.UpdateItemLimit | |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
피드백