Help Center> Distributed Message Service for RabbitMQ> API Reference> APIs V2 (Recommended)> Instance Management> Enabling or Disabling a Plug-in
Enabling or Disabling a Plug-in
Function
This API is used to enable or disable a plug-in.
Debugging
You can use API Explorer to debug this API.
URI
PUT /v2/{project_id}/instances/{instance_id}/rabbitmq/plugins
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enable | No | Boolean | Whether to enable the plug-in. |
| plugins | No | String | Plug-ins. Separated multiple plug-ins with commas (,). |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Background task ID. |
Example Requests
Enabling or Disabling a Plug-in
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/rabbitmq/plugins
{
"enable" : true,
"plugins" : "rabbitmq_federation,rabbitmq_shovel"
} Example Responses
Status code: 200
The plug-in is enabled or disabled successfully.
{
"job_id" : "8abfa7b27437db8f01744ea8ad4f245e"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The plug-in is enabled or disabled successfully. |
Error Codes
See Error Codes.
Parent topic: Instance Management
Last Article: Listing Plug-ins
Next Article: Specification Modification Management
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.