DescribePlugins--消息队列 RabbitMQ版-火山引擎

文档中心

立即注册

导航

DescribePlugins

最近更新时间：2024.02.23 15:26:19首次发布时间：2023.05.19 15:47:10

调用 DescribePlugins 接口查询指定实例的插件列表。

注意事项

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

使用说明

该接口用于查看指定实例的插件列表，其中包括当前支持的插件、每个插件的开启状态及相关注意事项。建议修改插件启用状态之前，先通过此接口查看插件的详细信息，例如开启某插件是否会引发实例重启。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	rbtmq-*******	实例 ID。
PageSize	Integer	是	10	查询结果分页展示时，此参数用于表示每页的数据量。取值范围为1~100。
PageNumber	Integer	是	1	查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。

响应参数

参数	参数类型	示例值	说明
InstanceId	String	rbtmq-2f707884****	实例 ID。
Total	Integer	3	插件总数。
PluginsInfo	Array of BasicPluginInfoObject	/	该实例的插件信息，包括支持的插件列表、每个插件的开启状态等。详细信息请参考 BasicPluginInfoObject。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribePlugins&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****",
   "PageSize": "10",
   "PageNumber": "1"
}

响应示例

"Result": {
        "InstanceId": "rbtmq-2f707884****",
        "PluginsInfo": [
            {
                "Description": "支持MQTT协议（TCP方式）",
                "DisablePrompt": "禁用该插件将触发RabbitMQ集群滚动重启",
                "EnablePrompt": "启用该插件将触发RabbitMQ集群滚动重启",
                "Enabled": true,
                "NeedRebootOnChange": true,
                "PluginName": "rabbitmq_mqtt",
                "Port": 8883,
                "Version": "3.8.18"
            },
            {
                "Description": "支持MQTT协议（WebSocket方式）",
                "DisablePrompt": "禁用该插件将触发RabbitMQ集群滚动重启",
                "EnablePrompt": "启用该插件将触发RabbitMQ集群滚动重启",
                "Enabled": false,
                "NeedRebootOnChange": true,
                "PluginName": "rabbitmq_web_mqtt",
                "Port": 15676,
                "Version": "3.8.18"
            },
            {
                "Description": "延迟消息",
                "DisablePrompt": "关闭该插件将导致未投递的延时消息丢失",
                "EnablePrompt": "",
                "Enabled": false,
                "NeedRebootOnChange": false,
                "PluginName": "rabbitmq_delayed_message_exchange",
                "Port": 0,
                "Version": "3.8.17"
            },
            {
                "Description": "支持Stomp协议",
                "DisablePrompt": "禁用该插件将触发RabbitMQ集群滚动重启",
                "EnablePrompt": "启用该插件将触发RabbitMQ集群滚动重启",
                "Enabled": false,
                "NeedRebootOnChange": true,
                "PluginName": "rabbitmq_stomp",
                "Port": 61614,
                "Version": "3.8.18"
            },
            {
                "Description": "可跟踪消息的流入流出并记录在日志文件中，请确保实例存储空间容量充足。开启后，请前往WebUI控制台使用",
                "DisablePrompt": "关闭该插件将导致无法对消息进行跟踪",
                "EnablePrompt": "",
                "Enabled": false,
                "NeedRebootOnChange": false,
                "PluginName": "rabbitmq_tracing",
                "Port": 0,
                "Version": "3.8.18"
            },
            {
                "Description": "一致性哈希交换机，使用一致性哈希算法将消息路由到队列",
                "DisablePrompt": "关闭该插件将导致无法使用一致性哈希Exchange",
                "EnablePrompt": "",
                "Enabled": true,
                "NeedRebootOnChange": false,
                "PluginName": "rabbitmq_consistent_hash_exchange",
                "Port": 0,
                "Version": "3.8.18"
            }
        ],
        "Total": 6
    }