Help Center/Distributed Message Service for RabbitMQ/API Reference/APIs V2 (Recommended)/Instance Management/Listing Plug-ins
Updated on 2025-12-29 GMT+08:00
View PDF

Listing Plug-ins

Function

This API is used to list plug-ins.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/rabbitmq/plugins

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

plugins

Array of PluginEntity objects

Plug-in information list.

Table 3 PluginEntity

Parameter

Type

Description

running

Boolean

Whether the plug-in is running.

enable

Boolean

Whether the plug-in is enabled.

name

String

Plug-in name.

version

String

Plug-in version.

Example Requests

Querying the plug-in list

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/rabbitmq/plugins

Example Responses

Status code: 200

The plug-ins are listed successfully.

{
  "plugins" : [ {
    "running" : true,
    "enable" : true,
    "name" : "rabbitmq_shovel",
    "version" : "3.8.35"
  }, {
    "running" : true,
    "enable" : true,
    "name" : "rabbitmq_consistent_hash_exchange",
    "version" : "3.8.35"
  }, {
    "running" : false,
    "enable" : false,
    "name" : "rabbitmq_federation",
    "version" : "3.8.35"
  } ]
}

Status Codes

Status Code

Description

200

The plug-ins are listed successfully.

Error Codes

See Error Codes.

Parent Topic: Instance Management