全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeAutoRenewAttribute - 查询集群自动续费状态

更新时间:Jun 17, 2024

查询PolarDB包年包月集群自动续费状态。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

说明 您可以通过接口 DescribeRegions 查看地域 ID 详情。
cn-hangzhou
DBClusterIdsstring

集群 ID,支持传入多个集群 ID,多个集群 ID 间用英文逗号(,)分隔。

pc-****************
PageSizeinteger

每页记录数,取值范围为 30、50、100,默认值为 30。

30
PageNumberinteger

页码。取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
ResourceGroupIdstring

资源组 ID。

rg-re*********

返回参数

名称类型描述示例值
object
TotalRecordCountinteger

总记录数。

1
PageRecordCountinteger

总页数。

1
RequestIdstring

请求 ID。

65D7ACE6-4A61-4B6E-B357-8CB24A******
PageNumberinteger

页数。

1
Itemsobject []

集群续费信息列表。

DBClusterIdstring

集群 ID。

pc-*****************
PeriodUnitstring

时长单位:

  • Year:年。
  • Month:月。
Month
Durationinteger

续费时长。

4
RenewalStatusstring

续费状态,取值范围如下:

  • AutoRenewal:自动续费。
  • Normal:手动续费,到期前短信提醒。
  • NotRenewal:到期不续费,到期前无提醒,只在到期前第三天发送不续费提醒。
AutoRenewal
AutoRenewEnabledboolean

是否开启自动续费:

  • true:开启。
  • false:关闭。
true
RegionIdstring

地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******",
  "PageNumber": 1,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "pc-*****************",
        "PeriodUnit": "Month",
        "Duration": 4,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": true,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.指定的参数RegionId无效
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.由于某些未知错误、异常或失败,请求处理失败。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.由于服务器临时故障,请求失败。

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

变更历史

变更时间变更内容概要操作
暂无变更历史