调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格、增配分区数等产品规格。
随着业务规模增长,如果实例规格不再满足需求,您可以适当升高实例的规格配置。此接口用于变更 Kafka 实例的规格,包括计算规格、存储空间和分区数量等配置。
变配接口为异步接口,调用接口后,您可以在控制台实例详情页面中查看实例的计算规格等规格参数是否已变更成功。
如需升级实例规格,请注意以下限制和风险。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyInstanceSpec | 要执行的操作,取值:ModifyInstanceSpec。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
ComputeSpec | String | 否 | kafka.60xrate.hw | 实例变更后的计算规格。如需升级计算规格,此参数必选。消息队列 Kafka版实例提供的计算规格清单,请参考产品规格。 说明 仅支持升级实例规格,不支持降级。 |
StorageSpace | Integer | 否 | 1000 | 实例变更后的存储空间。如需扩容存储空间,此参数必选。 说明 仅支持升级实例规格,不支持降级。 |
NeedRebalance | Boolean | 否 | false | 是否开启再均衡(Rebalance)。
说明 变更实例的计算规格时才需要选择是否再均衡,仅升级存储规格时无需再均衡。即此参数仅在指定 ComputeSpec 参数时生效。 |
RebalanceTime | String | 否 | 2022-01-02T15:04:05Z | 自动再均衡的执行时间。时间格式为 YYYY-MM-DD HH:MM:SS,例如 2023-01-02 15:04:05。应晚于当前时间 5 分钟以上。 说明
|
PartitionNumber | Integer | 否 | 1000 | |
InstanceId | String | 是 | kafka-cnngqkfgdudt**** | 实例 ID。 |
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.30xrate.hw", "StorageSpace": 500, "PartitionNumber": 400 }
{ "ResponseMetadata": { "RequestId": "2023022721230816131228CB14B15FBB72", "Action": "ModifyInstanceSpec", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "OrderId": "Order720482488077238****" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | OperationDenied.ExistCreatingOrder | 已存在创建中的订单,无法执行该操作。 |
400 | OperationDenied.InsufficientIp | 所选子网IP数量不足,无法执行该操作。 |
400 | QuotaExceeded.StorageCapacity | 所有实例的存储空间之和超出配额上限。 |
400 | InvalidParameter.StorageCapacity | 期望的存储空间不在计算规格指定的范围内。 |
400 | InsufficientResource | 资源不足,无法执行该操作。 |
400 | ResourceAZSoldOut | %s可用区资源不足。 |
400 | InstanceOrderCreateFailed | 创建订单失败。 |
400 | OperationDenied.InvalidRequest | 请求异常,请检查后重试。 |
400 | Insufficient.Balance | 您的账户余额不足。 |
400 | OperationDenied.ResourceSoldOut | 当前可用区资源不足。 |
400 | ResourceScaleSoldOut | %s可用区资源不足。 |
404 | InvalidInstance.NotFound | 实例不存在。 |