DescribeAutoRenewAttribute API による ClickHouse 自動更新ステータス確認 - ApsaraDB for ClickHouse

ClickHouse Community-Compatible クラスターの自動更新ステータスを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeAutoRenewAttribute

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-beijing
DBClusterIds	string	任意	クラスター ID。	cc-uf6g4417bo*****
PageSize	integer	任意	ページあたりのエントリー数。	30
PageNumber	integer	任意	ページ番号。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D0CEC6AC-7760-409A-A0D5-E*******
PageNumber	integer	ページ番号。	1
PageRecordCount	integer	現在のページのレコード数。	5
TotalRecordCount	integer	エントリーの総数。	51
Items	object
AutoRenewAttribute	array<object>	自動更新情報。
	object
DBClusterId	string	クラスター ID。	cc-2ze57pg09*****
PeriodUnit	string	サブスクリプション期間の単位。有効な値: Month および Year。	Year
Duration	integer	サブスクリプション期間。	1
RenewalStatus	string	更新ステータス。有効な値: AutoRenewal: クラスターは自動的に更新されます。 Normal: クラスターは手動で更新されます。 NotRenewal: クラスターは有効期限が切れても更新されません。	AutoRenewal
AutoRenewEnabled	boolean	自動更新が有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。
RegionId	string	リージョン ID。	cn-beijing

例

成功レスポンス

JSONJSON

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E*******",
  "PageNumber": 1,
  "PageRecordCount": 5,
  "TotalRecordCount": 51,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "cc-2ze57pg09*****",
        "PeriodUnit": "Year",
        "Duration": 1,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": true,
        "RegionId": "cn-beijing"
      }
    ]
  }
}

エラーコード

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

変更履歴

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