ModifyAutoRenewAttribute - 设置包年包月集群自动续费状态

更新时间:
复制 MD 格式

设置PolarDB包年包月集群自动续费状态。

接口说明

修改包年包月 PolarDB 集群的自动续费设置。目标集群须为包年包月(Prepaid);按量付费集群应先调用 TransformDBClusterPayType 转换付费类型,再调用本接口。调用说明:前置依赖说明:当集群为按量付费时需先调用 TransformDBClusterPayType 转换付费类型,并给出调用链示意。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:ModifyAutoRenewAttribute

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

无 无

请求参数

名称

类型

必填

描述

示例值

DBClusterIds

string

是

数据库集群 ID。集群付费类型须为包年包月(Prepaid);按量付费集群调用可能返回 OperationDenied.DBClusterPayType。可先调用 TransformDBClusterPayType 转换付费类型。调用说明:集群付费类型必须为包年包月(Prepaid),按量付费集群调用会返回 OperationDenied.DBClusterPayType 错误。

pc-***************

RegionId

string

是

地域 ID,长度不超过 50 个字符。

说明

可通过接口 DescribeRegions 查看可用的地域。

cn-hangzhou

RenewalStatus

string

否

设置自动续费状态,取值范围如下:

  • AutoRenewal:自动续费。

  • Normal:手动续费。

  • NotRenewal:不再续费。

默认为 AutoRenewal。

说明

设置为 NotRenewal 后,系统不再发送到期提醒,只在到期前第三天发送不续费提醒。

AutoRenewal

Duration

string

否

设置实例自动续费时长,取值范围如下:

  • 当 PeriodUnit 为 Month 时,取值为[1,2,3,6,12]。

  • 当 PeriodUnit 为 Year 时,取值为[1-3]。

默认为 1。

1

PeriodUnit

string

否

续费时长的单位,取值范围如下:

  • Year:年。

  • Month:月。

默认为 Month。

Month

ResourceGroupId

string

否

资源组 ID。

rg-************

CloudProvider

string

否

实例所属的云服务商

ENS

返回参数

名称

类型

描述

示例值

object

{}

RequestId

string

请求 ID。

4CE6DF97-AEA4-484F-906F-C407EE******

示例

正常返回示例

JSON格式

{
  "RequestId": "4CE6DF97-AEA4-484F-906F-C407EE******"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidRenewalStatus.Malformed The specified parameter RenewalStatus is not valid. 指定的参数RenewalStatus无效。
400 InvalidPeriodUnit.Malformed The specified parameter PeriodUnit is not valid. 指定的参数PeriodUnit无效。
400 InvalidDuration.Malformed The specified parameter Duration is not valid. 指定的参数Duration无效。
403 OperationDenied.DBClusterPayType The operation is not permitted due to the pay type of cluster. 由于集群的付费类型,不允许执行此操作。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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

变更历史

更多信息,参考变更详情。