ModifyDBInstanceChargeType--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceChargeType

最近更新时间：2024.07.17 16:22:06首次发布时间：2022.04.12 11:06:53

调用 ModifyDBInstanceChargeType 接口修改目标 MongoDB 实例的计费类型。

请求类型

异步请求。

注意事项

当前仅支持将按量计费（也称后付费）实例改为包年包月（也称预付费）实例。

请求参数

参数	类型	是否必选	示例值	描述
InstanceIds	String[]	是	["mongo-replica-a1f25ba5****"]	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。支持同时传入多个实例 ID 批量转为包年包月。多个实例 ID 间用英文逗号（,）分隔。最多支持同时传入 10 个实例，实例 ID 不允许重复。
ChargeType	String	是	Prepaid	修改后的实例计费类型。当前仅支持将按量计费实例改为包年包月实例，故取值必须为 `Prepaid`。
PeriodUnit	String	是	Year	指定包年包月实例为包年或者包月类型。取值如下： `Year`：包年。 `Month`：包月。说明当 `ChargeType` 取值为 `Prepaid` 时，该参数必填。
Period	Integer	是	1	包年包月实例的购买时长，其中：当 `PeriodUnit` 为 `Year` 时，`Period` 取值为 1~3。当 `PeriodUnit` 为 `Month` 时，`Period` 取值为 1~9。
AutoRenew	Boolean	否	false	是否为包年包月实例开启自动续费，取值范围如下： `false`（默认）：不开启自动续费。 `true`：开启自动续费。

返回参数

参数	类型	示例值	描述
InstanceIds	String[]	["mongo-replica-a1f25ba5****"]	实例 ID。
OrderNO	String	Order707596823497132****	订单 ID。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceChargeType&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceIds":[
        "mongo-replica-a1f25ba5****"
    ],
    "ChargeType":"Prepaid",
    "PeriodUnit":"Month",
    "Period":1,
    "AutoRenew":false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202202211539050101742350380678****",
        "Action": "ModifyDBInstanceChargeType",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceIds": [
            "mongo-replica-a1f25ba5****"
        ],
        "OrderNO": "Order707596823497132****"
    }
}

错误码

更多详情，请参见错误码。