文档中心

消息队列 RabbitMQ版

插件管理

DescribePlugins - 查询实例插件状态

DescribePlugins - 查询实例插件状态

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

使用说明

该接口用于查看指定实例的插件列表，其中包括当前支持的插件、每个插件的开启状态及相关注意事项。

建议修改插件启用状态之前，先通过此接口查看插件的详细信息，例如开启某插件是否会引发实例重启。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribePlugins

要执行的操作，取值：DescribePlugins。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

InstanceId string 必选示例值：rbtmq-2f707884****

实例 ID。

PageSize integer 必选示例值：10

查询结果分页展示时，此参数用于表示每页的数据量。取值范围为 1~100。

PageNumber integer 必选示例值：1

查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：rbtmq-*******

实例 ID。

Total integer 示例值：3

插件总数。

PluginsInfo object[] 示例值：/

该实例的插件信息，包括支持的插件列表、每个插件的开启状态等。

EnablePrompt string 示例值：启用该插件将触发RabbitMQ集群滚动重启

开启此插件的注意事项说明。

PluginName string 示例值：rabbitmq_mqtt

插件名称。

Version string 示例值：3.8.18

插件版本。

NeedRebootOnChange boolean 示例值：true

开启或关闭插件是否会引发 RabbitMQ 实例重启。

true：会重启实例。

false：不会重启实例。

Enabled boolean 示例值：true

是否已开启插件。

true：插件已开启。

false：插件已关闭。

Port integer 示例值：8883

插件的服务端口。

DisablePrompt string 示例值：禁用该插件将触发RabbitMQ集群滚动重启

关闭此插件的注意事项说明。

Description string 示例值：支持 MQTT 协议（TCP方式）

插件的描述信息。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
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

这个页面对您有帮助吗？

有用

有用

无用

无用