文档中心>云数据库 MongoDB

续费实例(包年包月)

最近更新时间:2024-10-12 11:58:26

1. 接口描述

本接口(RenewMongoDB)用于续费副本集实例(包年包月),请确保账号余额充足。
接口请求域名:mongodb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为RenewMongoDB。

参数名称 是否必选 类型 描述
instanceId String 待操作的实例ID,可通过 DescribeMongoDBInstances 接口返回值中的 instanceId 获取。
period Int 续费时长,单位:月, 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 错误信息描述, 成功时,该值为空
codeDesc String 业务侧错误码英文描述。成功时返回Success,错误时返回具体业务错误原因。
data Object 返回的订单ID

其中,data 表示订单ID,其参数构成如下:

参数名称 类型 描述
data.dealId String 订单号,可通过 DescribeMongodbDealDetail 接口查询订单详情

4. 错误码

以下错误码表列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
11050 InvalidParameter 业务参数错误
11056 InstanceNotExists 没有找到对应实例
11051 InstanceDeleted 实例到期已被回收
11067 PeriodNotInRange 请求的时长不在售卖范围内
100207 OperationConstraints.AccountBalanceNotEnough 账号余额不足,请充值

5. 示例

输入

https://mongodb.api.qcloud.com/v2/index.php?Action=RenewMongoDB
&<公共请求参数>
&instanceId=cmgo-6ozqe0uh
&period=1

输出

{
    "code":"0",
    "message":"",
    "codeDesc": "Success",
    "data":{
        "dealId":"3374462"
    }
}