Help Center> Distributed Message Service for RabbitMQ> API Reference> APIs V2 (Recommended)> Instance Management> Listing Plug-ins
View PDF

Listing Plug-ins

Function

This API is used to list plug-ins.

Debugging

You can use API Explorer to debug this API.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

'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_amqp1_0",
    "version" : "3.7.17"
  }, {
    "running" : true,
    "enable" : true,
    "name" : "rabbitmq_delayed_message_exchange",
    "version" : "3.8.0"
  }, {
    "running" : false,
    "enable" : false,
    "name" : "rabbitmq_federation",
    "version" : "3.7.17"
  } ]
}

Status Codes

Status Code

Description

200

The plug-ins are listed successfully.

Error Codes

See Error Codes.

Parent topic: Instance Management