文档中心

ScaleInstance

最近更新时间：2024.02.23 15:26:18

首次发布时间：2022.04.20 20:30:03

调用接口 ScaleInstance 变更实例规格。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

使用说明

实例创建成功后，如果对应的业务规模增长，当前实例规格不再满足需求，您可以适当升高实例的计算规格和存储规格，避免因资源限制而导致处理能力下降，影响业务正常运行。本文介绍如何在消息队列 RabbitMQ版控制台中升级实例规格。

说明

调用此接口前，请确认实例状态为运行中。

变更限制：

集群版实例不支持变更为单机版实例。
目前仅支持升级实例配置，不支持降级计算规格或缩容存储空间。
不同计算规格对应不同的存储空间范围，升级实例的计算规格时，需要同步升级存储空间。
不同计算规格、存储空间的定价不同，变更实例规格后，配置费用将发生变化，请在订单中确认相关费用。

风险说明：

变更规格过程中，请勿对实例进行其他操作，否则可能造成实例状态异常等问题。
升级规格时服务端节点会依次滚动重启，建议在业务低峰期操作。
单机版实例的客户端会和部分节点短暂的断开连接并重连，可能会造成少量报错。已经发送成功的消息，升级之后不会丢失。升级期间发送失败的消息，建议重试发送，可在客户端配置重试机制。
升级预计持续约30分钟，整体服务不受影响，可能会产生小概率消费乱序。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	rbtmq-*******	实例 ID。
ComputeResource	String	可选	rabbitmq.n3.x2.medium	计算规格。支持设置为： rabbitmq.n1.x2.medium rabbitmq.n3.x2.medium rabbitmq.n5.x2.medium rabbitmq.n7.x2.medium 说明 ComputeResource 和 StorageCapacity 参数，至少指定一个。指定 ComputeResource 时，不支持降低计算规格。
StorageCapacity	Integer	可选	1000	实例存储空间，单位为 GiB。说明 ComputeResource 和 StorageCapacity 参数，至少指定一个。指定 StorageCapacity 时，不支持减少存储空间。

参数

参数类型

是否必选

示例值

说明

InstanceId

String

必选

rbtmq-*******

实例 ID。

ComputeResource

String

可选

rabbitmq.n3.x2.medium

计算规格。支持设置为：

rabbitmq.n1.x2.medium
rabbitmq.n3.x2.medium
rabbitmq.n5.x2.medium
rabbitmq.n7.x2.medium

说明

ComputeResource 和 StorageCapacity 参数，至少指定一个。
指定 ComputeResource 时，不支持降低计算规格。

StorageCapacity

Integer

可选

1000

实例存储空间，单位为 GiB。

说明

ComputeResource 和 StorageCapacity 参数，至少指定一个。
指定 StorageCapacity 时，不支持减少存储空间。

响应参数

参数	参数类型	示例值	说明
OrderId	String		订单 ID。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=ScaleInstance&Version=2018-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-*******",
  "ComputeResource": "rabbitmq.n1.x2.medium",
  "StorageCapacity": 1000
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "********",
    "Action": "ScaleInstance",
    "Version": "2018-01-01",
    "Service": "rabbitmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "OrderId": "example-order-id"
  }
}