接口请求域名: es.intl.tencentcloudapi.com 。
变更插件列表
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdatePlugins。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID |
| InstallPluginList.N | 否 | Array of String | 需要安装的插件名列表 |
| RemovePluginList.N | 否 | Array of String | 需要卸载的插件名列表 |
| ForceRestart | 否 | Boolean | 是否强制重启,默认值false |
| ForceUpdate | 否 | Boolean | 是否重新安装,默认值false |
| PluginType | 否 | Integer | 0:系统插件 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
批量卸载插件
https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&RemovePluginList.0=analysis-qq
&RemovePluginList.1=sql
&<公共请求参数>
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
批量安装插件
https://es.intl.tencentcloudapi.com/?Action=UpdatePlugins
&InstanceId=es-xxxxxxxx
&InstallPluginList.0=analysis-qq
&InstallPluginList.1=sql
&<公共请求参数>
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FileNameError | 文件名不符合规范。 |
| FailedOperation.FileSizeError | 文件大小不符合要求。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId,没有找到对应资源。 |
| InvalidParameter.InvalidRegion | 地域Region的取值与预期不符。 |
| InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
| InvalidParameterValue.InstallPluginList | 为集群稳定起见,当前只支持同时安装1个用户插件。 |
| InvalidParameterValue.PluginType | 插件类型PluginType的取值有误。 |
| LimitExceeded.PluginInstall | 超过最大自定义插件数量,请先删除部分自定义插件。 |
| LimitExceeded.UpdateItemLimit | 更新参数值过多,超过限制。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.CosInfoNotFound | COS相关信息获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnsupportedOperation.HeteroScalingExecuting | 存在未完成的异构扩缩容流程 |
| UnsupportedOperation.Plugin | 不支持该插件。 |
| UnsupportedOperation.StatusNotNormal | 不支持该操作,当前实例运行状态不为正常。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作,实例状态有误。 |
피드백