文档中心>云数据库 MySQL>API 文档>实例相关接口>修改云数据库实例的自动续费标记

修改云数据库实例的自动续费标记

最近更新时间:2024-11-11 01:11:19

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(ModifyAutoRenewFlag)用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyAutoRenewFlag。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
说明:可输入多个实例 ID 进行修改,json 格式如下。
[
"cdb-30z11v8s",
"cdb-93h11efg"
]
示例值:cdb-f35wr6wj
AutoRenew Integer 自动续费标记,可取值的有:0 - 不自动续费,1 - 自动续费。
示例值:1

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改云数据库实例的自动续费标记

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoRenewFlag
<公共请求参数>

{
    "AutoRenew": "1",
    "InstanceIds": [
        "cdb-f35wr6wj"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "1a42feb9-82087f71-6a0031ac-699a92a8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError.DBRecordNotExistError 数据库实例不存在。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.ExceptionParam 异常参数。
InvalidParameter.InstanceNotFound 实例不存在。
InvalidParameter.InvalidParameterError 无效的参数值。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied 操作被拒绝。