You need to enable JavaScript to run this app.
文档中心
消息队列 RabbitMQ版

消息队列 RabbitMQ版

复制全文
下载 pdf
插件管理
ModifyPlugin - 修改实例插件状态
复制全文
下载 pdf
ModifyPlugin - 修改实例插件状态
调用 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 object[] 必选 示例值:[ { "PluginName": "rabbitmq_delayed_message_exchange", "Enabled": true }, { "PluginName": "rabbitmq_tracing", "Enabled": true } ]​
待修改状态的插件列表。​
说明​
插件列表中未指定的插件,不调整其状态。​
Enabled boolean 必选 示例值:true​
是否开启插件。默认值:false​
  • true:开启插件。​
  • false:关闭插件。​
​
PluginName string 必选 示例值:rabbitmq_mqtt​
插件名称。支持设置为:​
  • rabbitmq_mqtt:实例是否支持 MQTT 协议(TCP方式)。​
  • rabbitmq_web_mqtt:实例是否支持 MQTT 协议(WebSocket方式)。​
  • rabbitmq_delayed_message_exchange:实例是否开启消息延迟功能。插件延迟时间存在 1% 左右的误差,可能提前或者推迟发送消息给消费者。​
  • rabbitmq_stomp:实例是否支持 STOMP 协议。​
  • rabbitmq_tracing:是否开启 tracing 插件。​
  • rabbitmq_consistent_hash_exchange:是否开启一致性哈希交换机。​
  • rabbitmq_shovel:实例是否开启 shovel 插件。shovel 插件支持在不同的 RabbitMQ 服务器之间自动可靠地传输消息。​
  • rabbitmq_shovel_management:实例是否开启 shovel 管理插件。插件支持管理和监控 shovel 的配置和状态,开启后,请前往WebUI控制台使用​
  • rabbitmq_federation: 实例是否开启 RabbitMQ Federation 插件。Federation 插件用于在 Broker 或集群之间传输消息。​
  • rabbitmq_federation_management:实例是否开启 RabbitMQ Federation 管理插件。插件提供 Federation 功能的图形化管理界面。​
​
​
​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
请求示例​
​
POST /?Action=ModifyPlugin&Version=2022-01-01 HTTP/1.1​
Host: rabbitmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260107T095206Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260107/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"InstanceId": "rbtmq-*******",​
"Plugins": [​
{​
"Enabled": true,​
"PluginName": "rabbitmq_mqtt"​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026010717521215104413413001****",​
"Action": "ModifyPlugin",​
"Version": "2022-01-01",​
"Service": "RabbitMQ",​
"Region": "cn-beijing"​
},​
"Result": {}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
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.​
内部错误,请稍后重试。​
​
​
最近更新时间:2026.02.05 18:09:46
这个页面对您有帮助吗?
有用
有用
无用
无用