文档中心

ModifyInstanceSpec

最近更新时间：2024.04.01 17:20:47

首次发布时间：2023.03.30 19:59:25

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

使用说明

随着业务规模增长，如果实例规格不再满足需求，您可以适当升高实例的规格配置。此接口用于变更 Kafka 实例的规格，包括计算规格、存储空间和分区数量等配置。变配接口为异步接口，调用接口后，您可以在控制台实例详情页面中查看实例的计算规格等规格参数是否已变更成功。

说明

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	kafka-cnngqkfgdudt****	实例 ID。
ComputeSpec	String	否	kafka.60xrate.hw	实例变更后的计算规格。如需升级计算规格，此参数必选。消息队列 Kafka版实例提供的计算规格清单，请参考产品规格。仅支持升级实例规格，不支持降级。
StorageSpace	Integer	否	1000	实例变更后的存储空间。如需扩容存储空间，此参数必选。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格，详细说明请参考产品规格。仅支持升级实例规格，不支持降级。
PartitionNumber	Integer	否	1000	分区数量。如需提高分区数量，此参数必选。取值范围取决于当前指定的计算规格，详细说明请参考产品规格。仅支持增加分区数量。升级实例规格时增加的分区将额外收取分区费用，分区的计费方式请参考计费项。
NeedRebalance	Boolean	否	false	是否开启再均衡（Rebalance）。 true ：（推荐）消息队列 Kafka版会对分区进行再均衡分配。 false：（默认）若未启用再均衡，您需要为原有的 Topic 手动增加分区，以使用升配后的新资源。说明变更实例的计算规格时才需要选择是否再均衡，仅升级存储规格时无需再均衡。即此参数仅在指定 ComputeSpec 参数时生效。
RebalanceTime	String	否	2022-07-18T07:48:58Z	自动再均衡的执行时间。时间格式为 YYYYMMDD'T'HHMMSS'Z'，例如 2022-07-18T07:48:58Z。应晚于当前时间 5 分钟以上。说明此参数仅在NeedRebalance为true时生效。若未设置此参数，更配完成后将立即执行再均衡任务。推荐选择夜晚等业务低峰时进行再均衡，以减少数据迁移对业务的影响。若不指定此参数，表示升级结束后立即执行再均衡。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	保证客户端请求幂等性的标识。该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。如何使用幂等标识，请参考请求幂等性。

响应参数

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

示例

请求示例

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

{
  "InstanceId": "kafka-cnngbnntswg1****",
  "ComputeSpec": "kafka.60xrate.hw",
  "StorageSpace": 300,
  "PartitionNumber": 400
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023022721230816131228CB14B15FBB72",
        "Action": "ModifyInstanceSpec",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderId": "Order720482488077238****"
    }
}

使用说明

请求参数

响应参数

示例

请求示例

响应示例

消息队列 Kafka版

ModifyInstanceSpec

使用说明

请求参数

响应参数

示例

请求示例

响应示例