说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (RenewInstance) 用于包年包月实例续费。
接口请求域名:cvm.api.qcloud.com
确保用户账户余额充足,可通过 DescribeAccountBalance API 查询余额。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
instanceId | 是 | String | 待操作的实例ID。可通过 DescribeInstances API返回值中的 unInstanceId 获取。 |
period | 是 | Int | 续费时长(月);续费时长至少为1个月,最多为36个月。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 CVM 错误码 页面。
错误码 | 描述 |
---|---|
OperationConstraints.InvaildInstanceStatus | 实例状态不正确或获取实例状态失败 |
OperationConstraints.AccountBalanceNotEnough | 您的余额不足,请先充值 |
PermissionDenied.UserQualificationAuditFailed | 用户资质审核未通过 |
NotSupport.SharedInstance | 共享核不允许续费 |
OperationFail.SystemBusy | 资源购买繁忙 |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=RenewInstance &instanceId=qcvm8e7bf56c115c53ce2d2a1ac2ea6e657a &period=1 &<公共请求参数>
输出
{
"codeDesc": "Success",
"message": "",
"code": 0,
"dealId": "2790804"
}