文档

ModifyInstanceAutoRenewalAttribute - 开启或者关闭实例的到期前自动续费功能

设置MongoDB实例的自动续费功能。

接口说明

请确保在使用该接口前,已充分了解云数据库 MongoDB 产品的收费方式和价格

本接口仅适用于付费类型为包年包月的实例。

说明 自动续费将于服务到期前 9 天开始扣款,请保证您的账户资金充足。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:ModifyInstanceAutoRenewalAttributeWrite
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID。您可以通过调用 DescribeDBInstanceAttribute 进行查询地域 ID。

cn-hangzhou
DBInstanceIdstring

实例 ID。

dds-bp15da1923e3****
Durationstring

自动续费时长,单位:月。

取值范围:1~12(整数)。

说明 AutoRenew 参数传入的值为 true 时,本参数才可用,且必须传入。
1
AutoRenewstring

是否开启自动续费,取值说明:

  • true:开启自动续费。
  • false:不开启自动续费。
说明 当本参数取值为 true 时,您还需要传入 Duration 参数。
true

返回参数

名称类型描述示例值
object

请求信息。

RequestIdstring

请求 ID。

EFD65226-08CC-4C4D-B6A4-CB3C382F67B0

示例

正常返回示例

JSON格式

{
  "RequestId": "EFD65226-08CC-4C4D-B6A4-CB3C382F67B0"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDbInstanceId.NotFoundSpecified instance does not exist.该实例不存在,原因可能是该实例已经释放,请刷新页面。
400InvalidDbInstanceIdInvalidInstance dbInstanceId is invalid.-
400InstanceAutoRenewInvalidInstance auto renewal is invalid.-
400InstanceChargeTypeInvalidInstance charge type is invalid.-
400InvalidDuration.InvalidInstance duration is invalid.续费时长无效

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈