设置MongoDB实例的自动续费功能。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:ModifyInstanceAutoRenewalAttribute | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 实例所属的地域 ID。您可以通过调用 DescribeDBInstanceAttribute 进行查询地域 ID。 | cn-hangzhou |
| DBInstanceId | string | 是 | 实例 ID。 | dds-bp15da1923e3**** |
| Duration | string | 否 | 自动续费时长，单位：月。 取值范围：1~12（整数）。 说明
当 AutoRenew 参数传入的值为 true 时，本参数才可用，且必须传入。
| 1 |
| AutoRenew | string | 是 | 是否开启自动续费，取值说明：
说明
当本参数取值为 true 时，您还需要传入 Duration 参数。
| true |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "EFD65226-08CC-4C4D-B6A4-CB3C382F67B0"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDbInstanceId.NotFound | Specified instance does not exist. | 该实例不存在，原因可能是该实例已经释放，请刷新页面。 |
| 400 | InvalidDbInstanceIdInvalid | Instance dbInstanceId is invalid. | - |
| 400 | InstanceAutoRenewInvalid | Instance auto renewal is invalid. | - |
| 400 | InstanceChargeTypeInvalid | Instance charge type is invalid. | - |
| 400 | InvalidDuration.Invalid | Instance duration is invalid. | 续费时长无效 |
| 403 | ClassicNetworkNotSupport | Classic network has not been supported, try to use VPC. | 当前操作不支持经典网络实例，请使用VPC网络。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-10-09 | OpenAPI 错误码发生变更 | 查看变更详情 |