すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeBackupPolicy

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeBackupPolicy

    最終更新日:Dec 04, 2025

    指定された ApsaraDB for ClickHouse クラスターのバックアップ設定を照会します。

    操作説明

    説明

    バージョン 20.3、20.8、または 21.8 を実行している ApsaraDB for ClickHouse クラスターでは、データバックアップがサポートされています。

    今すぐお試しください

    この 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:DescribeBackupPolicy

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    cc-bp1qx68m06981****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PreferredBackupPeriod

    string

    バックアップサイクル。有効値：

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday
    Switch

    string

    バックアップ機能が有効かどうかを示します。有効値：

    • true：バックアップ機能は有効です。

    • false：バックアップ機能は無効です。

    true
    RequestId

    string

    リクエスト ID。

    F5178C10-1407-4987-9133-DE4DC9119F75
    PreferredBackupTime

    string

    バックアップ時間 (UTC)。

    15:00Z-16:00Z
    BackupRetentionPeriod

    integer

    バックアップの保存期間。デフォルト値：7。有効値：7～730。単位：日。

    7
    BackupSize

    string

    バックアップサイズ。単位：MB。

    123124

    例

    成功レスポンス

    JSONJSON

    {
  "PreferredBackupPeriod": "Monday",
  "Switch": "true",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "BackupRetentionPeriod": 7,
  "BackupSize": "123124"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

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

    変更履歴

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