You need to enable JavaScript to run this app.
导航
RestartInstance - 重启实例
最近更新时间:2024.11.18 10:21:06首次发布时间:2023.05.19 15:47:10

调用 RestartInstance 接口重启实例。

使用说明

  • RestartInstance 接口用于重启 RabbitMQ 重启实例。在 RabbitMQ 实例重启过程中,RabbitMQ 集群会拒绝生产端的消息生产和消费端的消息消费,请在提前计划的维护时间窗操作。
  • 调用此 API 之前,请确认 RabbitMQ 实例处于运行中,且无运行中的后台任务。

注意事项

请求频率:该接口请求频率限制为 20 次/秒;单用户请求频率限制为 4 次/秒。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

RestartInstance

要执行的操作,取值:RestartInstance。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

InstanceId
String

rbtmq-2f707884****

实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=RestartInstance&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
   "InstanceId": "rbtmq-9283a61f****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230217175421E698024A11179196218F",
        "Action": "RestartInstance",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": null
}

错误码

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

状态码
错误码
错误信息
说明
403
OperationDenied.AccountNotAuthorized
You are not authorized to perform this operation.

您不具备相关权限 ,请授权或切换账号后重试。

403
OperationDenied.TaskIsRunning
An operation is currently in progress. Try again later.

后台任务正在运行中,请稍后再试。

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.

内部错误,请稍后重试。