DescribeAutoRenewAttribute でクラスターの自動更新状態をクエリ - PolarDB - Alibaba Cloud - PolarDB

サブスクリプション型 PolarDB クラスターの自動更新ステータスについて説明します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeAutoRenewAttribute

list

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。説明詳細については、「DescribeRegions」をご参照ください。	cn-hangzhou
DBClusterIds	string	任意	クラスターの ID。複数のクラスター ID を指定できます。コンマ (,) で区切ります。	pc-****************
PageSize	integer	任意	各ページに返すエントリ数。有効値：30、50、100。デフォルト値：30。	30
PageNumber	integer	任意	ページ番号。値は 0 より大きく、整数データ型の最大値を超えない整数である必要があります。デフォルト値：1。	1
ResourceGroupId	string	任意	リソースグループの ID。	rg-re*********
CloudProvider	string	任意	インスタンスのクラウドプロバイダー。	ENS

レスポンスフィールド

フィールド	型	説明	例
	object
Items	object
AutoRenewAttribute	array<object>	クラスターに関する更新情報のリスト。
	object
AutoRenewEnabled	boolean	自動更新が有効になっているかどうかを示します。 true：自動更新は有効です。 false：自動更新は無効です。	true
DBClusterId	string	クラスター ID。	pc-*****************
Duration	integer	更新期間。	4
PeriodUnit	string	更新期間の単位。 Year Month	Month
RegionId	string	リージョン ID。	cn-hangzhou
RenewalStatus	string	更新ステータス。有効な値： AutoRenewal：自動更新が有効になっています。 Normal：手動更新が有効になっています。クラスターの有効期限が切れる前に、テキストメッセージで通知されます。 NotRenewal：クラスターは更新されません。クラスターの有効期限が切れる前に通知は送信されません。有効期限日の 3 日前に非更新リマインダーが送信されます。	AutoRenewal
PageNumber	integer	ページ番号。	1
PageRecordCount	integer	総ページ数。	1
RequestId	string	リクエスト ID。	65D7ACE6-4A61-4B6E-B357-8CB24A******
TotalRecordCount	integer	エントリの総数。	1

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。