ModifyInstanceSpec - 修改实例配置--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

ModifyInstanceSpec - 修改实例配置

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:34

调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格、增配分区数等产品规格。

使用说明

随着业务规模增长，如果实例规格不再满足需求，您可以适当升高实例的规格配置。此接口用于变更 RocketMQ 实例的规格，包括计算规格、存储空间和分区数量等配置。

说明

调用此接口前，请确认实例状态为运行中（Running）。
目前仅支持升级实例配置，不支持降级，例如降级计算规格或缩容存储空间。
不同计算规格对应不同的存储空间范围，升级实例的计算规格时，需要同步升级存储空间。

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyInstanceSpec	要执行的操作，取值：ModifyInstanceSpec。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	保证客户端请求幂等性的标识。该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。如何使用幂等标识，请参考请求幂等性。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	需要更新配置的实例 ID。
ComputeSpec	String	否	rocketmq.n1.x2.tiny	实例变更后的计算规格。如需升级计算规格，此参数必选。仅支持升级实例规格，不支持降级。
StorageSpace	Integer	否	300	实例变更后的存储空间。如需扩容存储空间，此参数必选。单位为GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格，详细说明请参考产品规格。仅支持升级实例规格，不支持降级。
AutoScaleQueue	Boolean	否	false	实例规格更改时，是否自动创建队列。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
OrderId	String	order-712089661643355****	订单 ID。

请求示例

POST /?Action=ModifyInstanceSpec&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "ComputeSpec": "rocketmq.n1.x2.small",
  "StorageSpace": 300
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023022721230816131228CB14B15FBB72",
        "Action": "ModifyInstanceSpec",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "OrderId": "Order720482488077238****"
    }
}

错误码

公共错误码请参见公共错误码文档。