ScaleKafkaInstance--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

ScaleKafkaInstance

最近更新时间：2022.10.18 16:24:26首次发布时间：2022.04.24 15:56:37

调用 ScaleKafkaInstance 更改实例规格。

使用说明

说明

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

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-xxxxxxxxxx	实例 ID。
NewKafkaSpecification	String	可选	kafka.n5.x2.medinum	实例更配新的计算规格。 NewKafkaSpecification 和 NewDiskCapacity 中，至少指定一个。默认不执行计算规格更配。
NewDiskCapacity	Integer	可选	1800	实例更配新的存储容量，单位为 GiB。默认不执行存储规格更配。
NeedRebalance	Bool	可选	false	更配结束后是否执行自动重均衡。 true ：实例需要再均衡。 false：（默认）不执行再均衡任务。
RebalanceTime	String	可选	2022-03-15 21:00:00	自动再均衡的时间，时间格式为: YYYY-MM-DD HH:mm:ss。默认更配完成后立刻触发重均衡任务。
EipIds	List	可选	[eip-xxxxx,eip-yyyyy]	EIP ID，开启公网访问时必填。更高的计算规格需要更多的公网 IP，升级实例规格时需要通过此参数传入增加的公网IP ID。您可以通过 ListKafkaConf 接口查看各个实例需要的公网IP数量。
PartitionOfBuy	Integer	可选	900	Kafka 实例的分区数量，请根据业务需求合理设置分区数。不同规格提供数量不同的免费分区额度，超过免费额度的部分将另外收取分区费用。每个规格可创建的分区数量范围请参考产品规格，分区的计费方式请参考计费项。

响应参数

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

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ScaleKafkaInstance&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AKLTYmYwNjAzYjFmMjRkNDQwZWI4MzI1MzhjZGYyM2YxYmY/20210328/cn-north-1/kafka/request, SignedHeaders=x-date, Signature=e1d274292f8b36eb096e1d2fec02822bd2e5cb3435699938adb7341861214e49

{
  "InstanceId": "kafka-xxxxxxxxxx",
  "NewKafkaSpecification": "kafka.n5.x2.medinum",
  "NewDiskCapacity": 1800,
  "NeedRebalance": false,
  "RebalanceTime": "2022-03-15 21:00:00",
  "EipIds": [
    "********"
  ]
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "540CFF28-407A-40B5-B6A5-74B",
    "Action": "ScaleKafkaInstance",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "OrderId": "order-xxxxxxx"
  }
}