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

文档中心

立即注册

导航

消息队列 Kafka版

ModifyChargeToPrepaid

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.25 13:44:48

调用 ModifyChargeToPrepaid 接口将按量付费实例转为包年包月实例。

使用说明

创建实例后，可以根据此接口修改实例的付费方式。

说明

目前仅支持按量付费实例转为包年包月实例。
调用此接口前，请确认实例状态为运行中（Running）。

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	kafka-****	需要操作的实例 ID。
PrepaidType	String	是	Yearly	包年包月实例的购买时指定的时长单位。 Monthly：以月为单位购买。 Yearly：以年为单位购买。
ChargeUnitNumber	Integer	是	1	包年包月场景下指定购买的时长。
AutoRenew	Bool	否	true	是否开启自动续费功能。 true：自动续费 false：到期前需手动续费

响应参数

参数	参数类型	说明
OrderId	String	订单ID。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ModifyChargeToPrepaid&Version=2022-05-01 HTTP/1.1
Accept: application/json
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-****",
  "PrepaidType": "Yearly",
  "ChargeUnitNumber": 1,
  "AutoRenew": true
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "ModifyChargeToPrepaid",
    "Version": "2022-05-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "OrderId": "order-xxxxxxx"
  }
}