ModifyPlugin - 修改实例插件状态--消息队列 RabbitMQ版-火山引擎

文档中心

立即注册

导航

ModifyPlugin - 修改实例插件状态

最近更新时间：2024.11.18 10:21:06首次发布时间：2023.05.19 15:47:10

调用 ModifyPlugin 接口开启或关闭插件。

注意事项

请求频率：该接口请求频率限制为 20 次/秒；单用户请求频率限制为 5 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyPlugin	要执行的操作，取值：ModifyPlugin。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
InstanceId	String	是	rbtmq-*******	实例 ID。
Plugins	Array of Object	是	[ { "PluginName": "rabbitmq_delayed_message_exchange", "Enabled": true }, { "PluginName": "rabbitmq_tracing", "Enabled": true } ]	待修改状态的插件列表。说明插件列表中未指定的插件，不调整其状态。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=ModifyPlugin&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
   "InstanceId": "rbtmq-2f707884****",
   "Plugins": {
        "PluginName": "rabbitmq_mqtt",
        "Enabled": true
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202302171758012E56A0172D79CA886DB1",
        "Action": "ModifyPlugin",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。