Docs

Message Queue for RabbitMQ

Instance management

RestartInstance - Restart instance

Call the RestartInstance API to restart the instance.

Instructions

The RestartInstance API restarts the RabbitMQ instance. During the RabbitMQ instance restart, the RabbitMQ cluster will reject message production from producers and message consumption from consumers. Please schedule the operation during the planned maintenance time.

Before calling this API, ensure the RabbitMQ instance is Running with no ongoing background tasks.

Note

Request frequency: This API limits requests to 20 times per second. The per-user request frequency limit is 4 times per second.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: RestartInstance

The action to perform, value: RestartInstance.

Version string required Example value: 2022-01-01

API version, value: 2022-01-01.

InstanceId string required Example: rbtmq-2f707884****

Instance ID.

Response parameters

This interface has no unique response parameters. For more information, see the response structure.

Request example

POST /?Action=RestartInstance&Version=2022-01-01 HTTP/1.1​
Host: rabbitmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260107T093657Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260107/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rbtmq-2f707884****"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "202601071737030271760922045E****",​
    "Action": "RestartInstance",​
    "Version": "2022-01-01",​
    "Service": "RabbitMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

Error code

Error codesThe following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	description
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	You are not authorized. Authorize or switch accounts and try again.
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	Background tasks are running, please try again later.
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	The current instance state does not allow this operation.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.
500	InternalError	The request failed due to some unknown error, exception or failure.	Internal error, please try again later.

Last updated: 2026.02.06 14:27:44