Domain name for API request: es.intl.tencentcloudapi.com.
Update the ES cluster dictionary
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 | Address of the COS main dictionary for IK word segmentation entered during installation, and the dictionary name such as test.dic entered during deletion. |
| IkStopwords.N | No | Array of String | Address of the COS stopword dictionary for IK word segmentation during installation. When deleting, enter the dictionary name, for example, test.dic. |
| Synonym.N | No | Array of String | Address of the synonym dictionary COS during installation, and the dictionary name such as test.dic when deleting. |
| QQDict.N | No | Array of String | Address of the COS QQ tokenizer dictionary during installation, and the dictionary name such as test.dic during deletion. |
| UpdateType | No | Integer | 0: installation; 1: deletion. Default value: 0 |
| ForceRestart | No | Boolean | Whether to force restart the cluster. Default value: 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. |
Update ES cluster dictionary
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDictionaries
<Common request parameters>
{
"IkStopwords": [
"stop"
],
"Synonym": [
"syno"
],
"InstanceId": "es-esadfeas",
"UpdateType": 0,
"ForceRestart": true,
"QQDict": [
"qqDict"
],
"IkMainDicts": [
"mainDict"
]
}{
"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 | Manipulation is not allowed due to EsDictionaryInfo error. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| InvalidParameter.InvalidUpdateType | The value of the update type UpdateType does not match the expected value. |
| LimitExceeded.UpdateItemLimit | Too many update parameter values. The limit is exceeded. |
| ResourceInUse | The resource is occupied. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.CosInfoNotFound | Failed to obtain COS related information. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| ResourceNotFound.WhiteListNotFound | Failed to obtain the allowlist resource. |
| UnsupportedOperation.ClusterStateNoReplication | Some indexes in the cluster have no backup. |
| UnsupportedOperation.ClusterStateUnHealth | Cluster status is abnormal (not green). |
| UnsupportedOperation.HeteroScalingExecuting | An incomplete heterogeneous scaling process exists. |
| UnsupportedOperation.Plugin | The plugin is not supported. |
| UnsupportedOperation.StatusNotNormal | This operation is not supported. The instance is not running as normal. |
| UnsupportedOperation.StatusNotSupport | This operation is not supported. The instance status is incorrect. |
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