Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to update ES cluster dictionaries.
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: UpdateDictionaries. |
| 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 instance ID |
| IkMainDicts.N | No | Array of String | COS address of the main dictionary for the IK analyzer |
| IkStopwords.N | No | Array of String | COS address of the stopword dictionary for the IK analyzer |
| Synonym.N | No | Array of String | COS address of the synonym dictionary |
| QQDict.N | No | Array of String | COS address of the QQ dictionary |
| UpdateType | No | Integer | 0 (default): Install, 1: Delete |
| ForceRestart | No | Boolean | Whether to force restart the cluster. The default value is false. |
| 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: UpdateDictionaries
<Common request parameters>
{
"IkStopwords": [
"xx"
],
"Synonym": [
"xx"
],
"InstanceId": "xx",
"UpdateType": 0,
"ForceRestart": true,
"QQDict": [
"xx"
],
"IkMainDicts": [
"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 |
|---|---|
| FailedOperation.EsDictionaryInfoError | |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| InvalidParameter.InvalidUpdateType | |
| LimitExceeded.UpdateItemLimit | |
| ResourceInUse | Resource is in use. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.CosInfoNotFound | Failed to obtain COS related information. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| ResourceNotFound.WhiteListNotFound | |
| UnsupportedOperation.ClusterStateNoReplication | |
| UnsupportedOperation.ClusterStateUnHealth | |
| UnsupportedOperation.HeteroScalingExecuting | |
| UnsupportedOperation.Plugin | The plugin is not supported. |
| UnsupportedOperation.StatusNotNormal | |
| UnsupportedOperation.StatusNotSupport |
피드백