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

使用说明

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

变配接口为异步接口，调用接口后，您可以在控制台实例详情页面中查看实例的计算规格等规格参数是否已变更成功。

注意事项

如需升级实例规格，请注意以下限制和风险。

变更限制：

目前仅支持升级实例配置，不支持降级计算规格或缩容存储空间。

不同计算规格对应不同的存储空间范围，升级实例的计算规格时，需要同步升级存储空间。

不同计算规格、存储空间的定价不同，变更实例规格后，配置费用将发生变化。

风险说明：

变更规格过程中，请勿对实例进行其他操作，否则可能造成实例状态异常等问题。

升级规格时服务端节点会依次滚动重启，建议在业务低峰期操作。

客户端会和部分节点短暂的断开连接并重连，可能会造成少量报错。已经发送成功的消息，升级之后不会丢失。升级期间发送失败的消息，建议重试发送，可在客户端配置重试机制。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ModifyInstanceSpec

要执行的操作，取值：ModifyInstanceSpec。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

ComputeSpec string 可选示例值：kafka.60xrate.hw

实例变更后的计算规格。如需升级计算规格，此参数必选。消息队列 Kafka版实例提供的计算规格清单，请参考产品规格。

说明

仅支持升级实例规格，不支持降级。

StorageSpace integer 可选示例值：1000

实例变更后的存储空间。如需扩容存储空间，此参数必选。

单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格，详细说明请参考产品规格。

说明

仅支持升级实例规格，不支持降级。

NeedRebalance boolean 可选示例值：false

是否开启再均衡（Rebalance）。

true ：（推荐）消息队列 Kafka版会对分区进行再均衡分配。

false：（默认）若未启用再均衡，您需要为原有的Topic手动增加分区，以使用升配后的新资源。

说明

变更实例的计算规格时才需要选择是否再均衡，仅升级存储规格时无需再均衡。即此参数仅在指定 ComputeSpec 参数时生效。

RebalanceTime string 可选示例值：2022-01-02T15:04:05Z

自动再均衡的执行时间。时间格式为 YYYY-MM-DD HH:MM:SS，例如 2023-01-02 15:04:05。应晚于当前时间 5 分钟以上。

说明

此参数仅在 NeedRebalance 为 true 时生效。若未设置此参数，更配完成后将立即执行再均衡任务。

推荐选择夜晚等业务低峰时进行再均衡，以减少数据迁移对业务的影响。

若不指定此参数，表示升级结束后立即执行再均衡。

PartitionNumber integer 可选示例值：1000

分区数量。如需提高分区数量，此参数必选。

取值范围取决于当前指定的计算规格，详细说明请参考产品规格。

仅支持增加分区数量。

升级实例规格时增加的分区将额外收取分区费用，分区的计费方式请参考计费项。

InstanceId string 必选示例值：kafka-cnngqkfgdudt****

实例 ID。

ClientToken string 可选示例值：123e4567-e89b-12d3-a456-426655440000

保证客户端请求幂等性的标识。该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。

如何使用幂等标识，请参考请求幂等性。

返回参数

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

OrderId string 示例值：order-712089661643355****

订单 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	OperationDenied.ExistCreatingOrder	The operation is not permitted due to exist creating instance order.	已存在创建中的订单，无法执行该操作。
400	OperationDenied.InsufficientIp	The operation is not permitted due to the insufficient IP address in the target subnet.	所选子网IP数量不足，无法执行该操作。
400	QuotaExceeded.StorageCapacity	The sum storage capacity of all instances exceeds the limit.	所有实例的存储空间之和超出配额上限。
400	InvalidParameter.StorageCapacity	The storage capacity is not within the range specified by the instance specification.	期望的存储空间不在计算规格指定的范围内。
400	InsufficientResource	The resource is insufficient.	资源不足，无法执行该操作。
400	ResourceAZSoldOut	zone %s is sold out. Please select another availability zone to create an instance.	%s可用区资源不足。
400	InstanceOrderCreateFailed	Create instance order failed.	创建订单失败。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	Insufficient.Balance	The account balance is insufficient.	您的账户余额不足。
400	OperationDenied.ResourceSoldOut	The operation is not permitted due to the requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
400	ResourceScaleSoldOut	The scale of zone %s is sold out. Please select another availability zone to create an instance.	%s可用区资源不足。
404	InvalidInstance.NotFound	The specified instance does not exist.	实例不存在。