文档中心

ModifyPlugin

最近更新时间：2024.02.23 15:26:18

首次发布时间：2021.08.30 16:33:47

调用 ModifyPlugin 接口修改实例插件状态。

注意事项

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

使用说明

在消息队列 RabbitMQ版控制台中创建实例之后，实例插件默认为关闭状态，您可以手动为实例开启插件。
目前消息队列 RabbitMQ版支持在控制台开启以下插件：

插件名称	功能描述	端口号
rabbitmq_mqtt	表示实例是否支持 MQTT 协议（TCP方式）。	1883
rabbitmq_web_mqtt	表示实例是否支持 MQTT 协议（WebSocket方式）。	15675
rabbitmq_delayed_message_exchange	表示实例是否开启消息延迟功能。插件延迟时间存在 1% 左右的误差，可能提前或者推迟发送消息给消费者。
rabbitmq_stomp	表示实例是否支持 STOMP 协议。	61613
rabbitmq_tracing	用于跟踪消息的流入流出，并将其记录在日志文件中。请确保实例存储空间容量充足。开启后，请前往 WebUI 控制台使用。

说明

不支持修改插件端口号。
集群版实例中，开启/关闭 rabbitmq_mqtt、rabbitmq_web_mqtt 或 rabbitmq_stomp 插件时会触发RabbitMQ集群滚动重启，建议避开业务运行时段执行该操作。集群滚动重启时会造成未持久化的消息丢失，也会出现短暂的连接不稳定现象，例如连接断开，断开后会根据客户端配置决定是否自动重连。
单机版实例中，开启或关闭 rabbitmq_mqtt、rabbitmq_web_mqtt 或 rabbitmq_stomp 插件时会造成业务中断，需要客户端配置主动重连。
关闭插件 rabbitmq_delayed_message_exchange 将导致未投递的延时消息丢失。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	rbtmq-*******	实例ID。
PluginStatusList	List	必选		待修改状态的插件列表。详细信息请参考 PluginStatus。说明插件列表中未指定的插件，不调整其状态。

响应参数

null

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=ModifyPlugin&Version=2018-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-*******",
  "PluginStatusList": [
    {
      "PluginName": "rabbitmq_mqtt",
      "Enabled": true
    }
  ]
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "********",
    "Action": "ModifyPlugin",
    "Version": "2018-01-01",
    "Service": "rabbitmq",
    "Region": "cn-beijing"
  },
  "Result": null
}