全部产品
Search
文档中心

云原生数据库 PolarDB:ModifyAutoRenewAttribute - 设置包年包月集群自动续费状态

更新时间:Mar 01, 2024

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

调试

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

授权信息

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

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

请求参数

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

数据库集群 ID。

pc-***************
RegionIdstring

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

说明 可通过接口 DescribeRegions 查看可用的地域。
cn-hangzhou
RenewalStatusstring

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

  • AutoRenewal:自动续费。
  • Normal:手动续费。
  • NotRenewal:不再续费。

默认为 AutoRenewal

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

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

  • PeriodUnitMonth 时,取值为[1,2,3,6,12]
  • PeriodUnitYear 时,取值为[1-3]

默认为 1

1
PeriodUnitstring

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

  • Year:年。
  • Month:月。

默认为 Month

Month
ResourceGroupIdstring

资源组 ID。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    新增错误码:400
    新增错误码:403