すべてのプロダクト
Search

このプロダクト

    :DescribeBackupPolicy

    ドキュメントセンター

    :DescribeBackupPolicy

    最終更新日:Dec 11, 2025

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

    get

    *dbcluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含む、リージョン内のすべてのクラスターの詳細を照会できます。

    pc-*************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PreferredBackupPeriod

    string

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

    • 月曜日

    • 火曜日

    • 水曜日

    • 木曜日

    • 金曜日

    • 土曜日

    • 日曜日

    説明

    高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    DataLevel1BackupRetentionPeriod

    string

    レベル 1 バックアップの保持期間。有効な値: 3～14。単位: 日。

    説明

    高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    7
    RequestId

    string

    リクエスト ID。

    EADFCE0F-9FB5-4685-B395-1440B******
    PreferredBackupTime

    string

    自動バックアップが実行される時間範囲。時間は HH:mmZ-HH:mmZ 形式です。時間は UTC で表示されます。

    07:00Z-08:00Z
    BackupRetentionPolicyOnClusterDeletion

    string

    クラスターを削除するときにバックアップを保持するポリシー:

    • ALL: すべてのバックアップを永続的に保持します。

    • LATEST: 最後のバックアップを永続的に保持します。

    • NONE (デフォルト): バックアップセットを保持しません。

    NONE
    PreferredNextBackupTime

    string

    次回のバックアップの時間。時間は YYYY-MM-DDThh:mmZ 形式です。時間は UTC で表示されます。

    2020-11-16T07:30Z
    DataLevel2BackupRetentionPeriod

    string

    レベル 2 バックアップの保持期間。有効な値:

    • 0: レベル 2 バックアップ機能は無効です。

    • 30～7300: レベル 2 バックアップの保持期間 (日数)。

    • -1: レベル 2 バックアップは永続的に保持されます。

    説明

      • クラスターを作成するときのデフォルト値は 0 です。これは、レベル 2 バックアップ機能が無効になっていることを意味します。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    0
    BackupFrequency

    string

    バックアップの頻度。有効な値:

    • Normal (デフォルト): 標準バックアップ。バックアップは 1 日に 1 回実行されます。

    • 2/24H: 拡張バックアップ。バックアップは 2 時間ごとに実行されます。

    • 3/24H: 拡張バックアップ。バックアップは 3 時間ごとに実行されます。

    • 4/24H: 拡張バックアップ。バックアップは 4 時間ごとに実行されます。

    説明

    • 拡張バックアップを有効にすると、24 時間以内に完了したすべてのバックアップが保持されます。24 時間以上前に完了したバックアップについては、システムは毎日 00:00 以降に完了した最初のバックアップのみを保持します。他のバックアップは削除されます。

    • 拡張バックアップを有効にすると、PreferredBackupPeriod パラメーターは自動的に週のすべての日 (月曜日から日曜日) に設定されます。

    Normal
    DataLevel1BackupFrequency

    string

    バックアップの頻度。有効な値:

    • Normal (デフォルト): 標準バックアップ。バックアップは 1 日に 1 回実行されます。

    • 2/24H: 高頻度バックアップ。バックアップは 2 時間ごとに実行されます。

    • 3/24H: 高頻度バックアップ。バックアップは 3 時間ごとに実行されます。

    • 4/24H: 高頻度バックアップ。バックアップは 4 時間ごとに実行されます。

    説明

      • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

      • PolarDB for MySQL クラスターが存在するリージョンでリージョン間バックアップ機能が利用できない場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    Normal
    DataLevel1BackupPeriod

    string

    レベル 1 バックアップのサイクル。有効な値:

    • 月曜日

    • 火曜日

    • 水曜日

    • 木曜日

    • 金曜日

    • 土曜日

    • 日曜日

    説明

      • 少なくとも 2 日を選択してください。複数の値はコンマ (,) で区切ります。

      • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

      • PolarDB for MySQL クラスターが存在するリージョンでリージョン間バックアップ機能が利用できない場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    Monday,Tuesday
    DataLevel1BackupTime

    string

    自動バックアップが実行される時間範囲。時間は hh:mmZ-hh:mmZ 形式で、UTC で表示されます。指定する時間範囲は、14:00Z-15:00Z のように、1 時間間隔で正時である必要があります。

    説明

    • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

    • PolarDB for MySQL クラスターが存在するリージョンでリージョン間バックアップ機能が利用できない場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

    15:00Z-16:00Z
    DataLevel2BackupPeriod

    string

    レベル 2 バックアップのサイクル。有効な値:

    • 月曜日

    • 火曜日

    • 水曜日

    • 木曜日

    • 金曜日

    • 土曜日

    • 日曜日

    説明

      • 少なくとも 2 日を選択してください。複数の値はコンマ (,) で区切ります。

      • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

      • PolarDB for MySQL クラスターが存在するリージョンでリージョン間バックアップ機能が利用できない場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    Monday,Tuesday
    DataLevel2BackupAnotherRegionRetentionPeriod

    string

    リージョン間レベル 2 バックアップの保持期間。有効な値:

    • 0: リージョン間レベル 2 バックアップ機能は無効です。

    • 30～7300: レベル 2 バックアップの保持期間 (日数)。

    • -1: レベル 2 バックアップは永続的に保持されます。

    説明

      • クラスターを作成するときのデフォルト値は 0 です。これは、レベル 2 バックアップのリージョン間バックアップ機能が無効になっていることを意味します。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    30
    DataLevel2BackupAnotherRegionRegion

    string

    リージョン間レベル 2 バックアップのターゲットリージョン。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

    説明

    高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedDataPolicies パラメーターを使用してください。

    cn-hangzhou
    BackupPolicyLevel

    string

    バックアップポリシーのレベル。有効な値:

    • Normal: 標準バックアップ

    • Advanced: 高度なバックアップ

    説明

    • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

    Normal
    AdvancedPolicyOption

    string

    高度なバックアップポリシーのオプション。有効な値:

    • enable: 高度なバックアップが有効です。

    • disable: 高度なバックアップは無効です。有効にできます。

    • notSupport: 高度なバックアップはサポートされていません。

    説明

    • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

    disable
    AdvancedDataPolicies

    object

    AdvancedDataPolicy

    array<object>

    高度なバックアップポリシーの詳細。

    説明

    • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。

    object

    PolicyId

    string

    バックアップポリシーの ID。

    71930ac2e9f15e41615e10627c******

    RetentionType

    string

    バックアップセットの保持期間タイプ。戻り値は次のとおりです。

    • never: 永続的な保持

    • delay: 指定された日数保持

    delay
    RetentionValue

    string

    バックアップを保持する日数。

    7
    FilterType

    string

    高度なポリシーのフィルタータイプ。戻り値は次のとおりです。

    • crontab: 定期的なスケジュール

    • event: イベントトリガーのスケジュール

    crontab
    FilterKey

    string

    スケジューリングタイプ。戻り値は次のとおりです。

    • dayOfWeek: 週次スケジュール

    • dayOfMonth: 月次スケジュール

    • dayOfYear: 年次スケジュール

    • backupInterval: 固定間隔スケジュール

    説明

    このパラメーターは、FilterType が crontab に設定されている場合にのみ返されます。

    dayOfWeek
    FilterValue

    string

    バックアップサイクル。

    1,2,3,4,5,6,7
    SrcType

    string

    バックアップポリシーのソースタイプ。戻り値は次のとおりです。

    • db: データベースクラスター

    • level1: レベル 1 バックアップ

    • level2: レベル 2 バックアップ

    • level2Cross: リージョン間レベル 2 バックアップ

    level1
    SrcRegion

    string

    バックアップポリシーのソースリージョン。

    cn-beijing
    DestType

    string

    バックアップポリシーの宛先タイプ。戻り値は次のとおりです。

    • level1: レベル 1 バックアップ

    • level2: レベル 2 バックアップ

    • level2Cross: リージョン間レベル 2 バックアップ

    level1
    DestRegion

    string

    バックアップポリシーのターゲットリージョン。

    cn-hangzhou
    DumpAction

    string

    レベル 1 バックアップをレベル 2 バックアップに変換するメソッド。戻り値は次のとおりです。

    • copy: コピー

    copy
    AutoCreated

    boolean

    バックアップポリシーがシステムによって自動的に生成されたかどうかを示します。戻り値は次のとおりです。

    • true: ポリシーはシステムによって生成されます。

    • false: ポリシーはカスタムポリシーです。

    true
    OnlyPreserveOneEachHour

    boolean

    時間単位のバックアップ保持ポリシー。有効な値:

    • true: 1 時間以内に作成された最も古いバックアップセットのみを保持します。

    • false: すべてのバックアップセットを保持します。

    true
    OnlyPreserveOneEachDay

    boolean

    24 時間のバックアップ保持ポリシー。

    • true: バックアップセットが 24 時間以上前に作成された場合、その日の最初のバックアップセットのみを保持します。

    • false: すべてのバックアップセットを保持します。

    true
    BakType

    string

    バックアップタイプ。戻り値は次のとおりです。

    • F: 完全バックアップ

    F

    例

    成功レスポンス

    JSONJSON

    {
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "DataLevel1BackupRetentionPeriod": "7",
  "RequestId": "EADFCE0F-9FB5-4685-B395-1440B******",
  "PreferredBackupTime": "07:00Z-08:00Z",
  "BackupRetentionPolicyOnClusterDeletion": "NONE",
  "PreferredNextBackupTime": "2020-11-16T07:30Z",
  "DataLevel2BackupRetentionPeriod": "0",
  "BackupFrequency": "Normal",
  "DataLevel1BackupFrequency": "Normal",
  "DataLevel1BackupPeriod": "Monday,Tuesday",
  "DataLevel1BackupTime": "15:00Z-16:00Z",
  "DataLevel2BackupPeriod": "Monday,Tuesday",
  "DataLevel2BackupAnotherRegionRetentionPeriod": "30",
  "DataLevel2BackupAnotherRegionRegion": "cn-hangzhou",
  "BackupPolicyLevel": "Normal",
  "AdvancedPolicyOption": "disable",
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******\n",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-hangzhou",
        "DumpAction": "copy",
        "AutoCreated": true,
        "OnlyPreserveOneEachHour": true,
        "OnlyPreserveOneEachDay": true,
        "BakType": "F"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records.

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

    変更履歴

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