Domain name for API request: es.intl.tencentcloudapi.com.
Update the plug-in list
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: UpdatePlugins. |
| 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 | Instance ID |
| InstallPluginList.N | No | Array of String | Name list of plug-ins that needs to be installed |
| RemovePluginList.N | No | Array of String | List of plug-in names to uninstall |
| ForceRestart | No | Boolean | Whether to force restart. Default value: false |
| ForceUpdate | No | Boolean | Whether to reinstall. Default value: false |
| PluginType | No | Integer | 0: System plugin |
| 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. |
Batch uninstall plug-ins
https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&RemovePluginList.0=analysis-qq
&RemovePluginList.1=sql
&<Common request parameters>{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}Install plugins in batches
https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&InstallPluginList.0=analysis-qq
&InstallPluginList.1=sql
&<Common request parameters>{
"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.FileNameError | File name does not conform to specifications. |
| FailedOperation.FileSizeError | File size does not meet requirements. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| InvalidParameter.InvalidRegion | The Region value does not meet the expectation. |
| InvalidParameterValue.ConfigInfo | Component configuration value error. |
| InvalidParameterValue.InstallPluginList | For cluster stability, currently only support installing 1 user plugin at the same time. |
| InvalidParameterValue.PluginType | Invalid value of the plug-in type PluginType. |
| LimitExceeded.PluginInstall | Exceeds the maximum number of custom plugins. Please delete some custom plugins first. |
| LimitExceeded.UpdateItemLimit | Too many update parameter values. The limit is exceeded. |
| 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.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