tencent cloud

APIs

UpdatePlugins

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-24 15:49:08

1. API Description

Domain name for API request: es.intl.tencentcloudapi.com.

This API is used to change the list of plugins.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 List of names of the plugins to be installed
RemovePluginList.N No Array of String List of names of the plugins to be uninstalled
ForceRestart No Boolean Whether to force restart the cluster. The default value is false.
ForceUpdate No Boolean Whether to reinstall the cluster. The default value is false.
PluginType No Integer 0: system plugin

3. Output Parameters

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.

4. Example

Example1 Uninstalling plugins in batches

Input Example

https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&RemovePluginList.0=analysis-qq
&RemovePluginList.1=sql
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
    }
}

Example2 Installing plugins in batches

Input Example

https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&InstallPluginList.0=analysis-qq
&InstallPluginList.1=sql
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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
FailedOperation.FileSizeError
InternalError Internal error.
InvalidParameter.InvalidAppId The APPID value does not match the expectation.
InvalidParameter.InvalidInstanceId Invalid InstanceId, no corresponding resource found.
InvalidParameter.InvalidRegion The Region value does not meet the expectation.
InvalidParameterValue.ConfigInfo
InvalidParameterValue.InstallPluginList
InvalidParameterValue.PluginType
LimitExceeded.PluginInstall
LimitExceeded.UpdateItemLimit
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.HeteroScalingExecuting
UnsupportedOperation.Plugin The plugin is not supported.
UnsupportedOperation.StatusNotNormal
UnsupportedOperation.StatusNotSupport

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백