すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeAutoRenewAttribute

最終更新日:Jun 18, 2025

この操作を呼び出して、サブスクリプション ApsaraDB for PolarDB クラスターの自動更新属性を照会します。

リクエストパラメーター

パラメーター

データ型

必須 / 任意

説明

Action

String

必須

実行する操作。 値を DescribeAutoRenewAttribute に設定します。

RegionId

String

必須

リージョンの ID。長さは最大 50 文字です。 DescribeRegions 操作を呼び出して、使用可能なリージョンを照会できます。

DBClusterIds

String

任意

照会する ApsaraDB for PolarDB クラスターの ID。 クラスター ID が複数ある場合は、コンマ (,) で区切ります。

PageSize

String

任意

返される各ページのエントリ数。 設定可能な値は次のとおりです。

  • 30

  • 50

  • 100

デフォルト値:30。

PageNumber

String

任意

返されるページのページ番号。 有効な値:0 以外の正の整数。 デフォルト値:1。

レスポンスパラメーター

パラメーター

データ型

説明

<共通レスポンスパラメーター>

N/A

RequestId

String

リクエストの ID。

PageNumber

Integer

返されたページのページ番号。

TotalRecordCount

Integer

返されたエントリの総数。

PageRecordCount

Integer

返されたページの総数。

Items

List<AutoRenewAttribute>

クラスターの更新情報のリスト。

AutoRenewAttribute

パラメーター

データ型

説明

DBClusterId

String

ApsaraDB for PolarDB クラスターの ID。

RegionId

String

リージョンの ID。

AutoRenewEnabled

Boolean

自動更新が有効になっているかを示します。 有効な値は次のとおりです。

  • true:有効

  • false:無効

Duration

Integer

サブスクリプションクラスターの更新期間。

PeriodUnit

String

更新期間の単位。 有効な値は次のとおりです。

  • Year

  • Month

RenewalStatus

String

クラスターの更新ステータス。 有効な値は次のとおりです。

  • AutoRenewal:クラスターは自動的に更新されます。

  • Normal:クラスターは手動で更新されます。 システムは SMS メッセージを送信して、クラスターの有効期限が切れる前に通知します。

  • NotRenewal:クラスターは更新されません。 システムは期限切れのリマインダーを送信しませんが、クラスターが期限切れになる 3 日前に SMS メッセージを送信して、クラスターが更新されていないことを通知するだけです。

リクエストの例

https://polardb.aliyuncs.com/?Action=DescribeAutoRenewAttribute
&RegionId=cn-hangzhou
&DBClusterId=pc-xxxxxxxxxxxxxxxx
&<[共通リクエストパラメーター]>

レスポンスの例

XML 形式

<DescribeAutoRenewAttributeResponse>  
    <Items>
        <AutoRenewAttribute>
            <RenewalStatus>Normal</RenewalStatus>
            <Duration>1</Duration>
            <RegionId>cn-hangzhou</RegionId>
            <AutoRenewEnabled>true</AutoRenewEnabled>
            <PeriodUnit>Month</PeriodUnit>
            <DBClusterId>pc-xxxxxxxxxxxxxxxx</DBClusterId>
        </AutoRenewAttribute>
    </Items>
    <TotalRecordCount>1</TotalRecordCount>
    <PageNumber>1</PageNumber>
    <RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D</RequestId>
    <PageRecordCount>1</PageRecordCount>
</DescribeAutoRenewAttributeResponse>

JSON 形式

{
    "Items": {
        "AutoRenewAttribute": [
            {
                "RenewalStatus": "AutoRenewal",
                "Duration": 1,
                "RegionId": "cn-hangzhou",
                "AutoRenewEnabled": true,
                "PeriodUnit": "Month",
                "DBClusterId": "pc-xxxxxxxxxxxxxxxx"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D",
    "PageRecordCount": 1
}