すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    最終更新日:Oct 08, 2026

    高度なバックアップポリシーを照会します。

    操作説明

    高度なバックアップポリシーを照会します。この操作は、クラウドディスクレプリカセットおよびクラウドディスクシャードクラスターインスタンスのみサポートしています。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:DescribeAdvancedBackupPolicy

    get

    *インスタンス。

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID。

    dds-bp18b0934e70****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    111E7B16-0A87-4CBA-B271-F34AD61E099F
    DBInstanceId

    string

    インスタンスの ID。

    dds-bp14bf67a76d****
    PreferredBackupTime

    string

    バックアップ時間。フォーマットは HH:mmZ-HH:mmZ (協定世界時 (UTC)) です。

    09:00Z-10:00Z
    SnapshotBackupType

    string

    スナップショットバックアップタイプ。有効な値:

    • Flash: 数秒以内のバックアップ。

    • Standard: 標準バックアップ。

    列挙値:

    • Standard :

      標準バックアップ。

    • Flash :

      数秒以内のバックアップ。

    Standard
    BackupRetentionPolicyOnClusterDeletion

    integer

    バックアップデータの保持ポリシー。有効な値:

    • 0: インスタンスのリリース時に、インスタンスのすべてのバックアップセットがすぐに削除されます。

    • 1: インスタンスのリリース時に、最後のバックアップセットが long-term 保持 (LTR) を使用して保持されます。

    • 2: インスタンスのリリース時に、すべてのバックアップセットが long-term 保持 (LTR) を使用して保持されます。

    列挙値:

    • 0 :

      すべてのバックアップセットをすぐに削除します。

    • 1 :

      long-term 保持 (LTR) を使用して最後のバックアップセットを保持します

    • 2 :

      long-term 保持 (LTR) を使用してすべてのバックアップセットを保持します

    2
    PreferredNextBackupTime

    string

    バックアップが開始される時間範囲。フォーマットは HH:mmZ-HH:mmZ (協定世界時 (UTC)) で、01:00Z-02:00Z のようになります。バックアップはこの時間範囲内の時間に開始されます。

    2024-06-19T19:11Z
    AdvancedBackupDataPolicies

    array<object>

    バックアップポリシーのリスト。

    object

    PolicyId

    string

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

    xxxxxx
    ActionType

    string

    操作タイプ。有効な値:

    • DELETE: 削除。

    • CREATE: 作成。

    • UPDATE: 更新。

    xx
    RetentionType

    string

    バックアップセットの保持エポックタイプ。有効な値:

    • never: long-term 保持 (LTR)。

    • delay: 固定日数の保持。

    列挙値:

    • never :

      long-term 保持 (LTR)

    • delay :

      固定日数の保持。

    delay
    RetentionPeriod

    integer

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

    7
    BackupPolicy

    string

    高度なバックアップポリシーのスケジューリングタイプ。有効な値:

    • dayOfWeek: 週次スケジューリング。

    • dayOfMonth: 月次スケジューリング。

    • dayOfYear: 年次スケジューリング。

    • backupInterval: 固定間隔スケジューリング (高頻度バックアップ)。

    列挙値:

    • dayOfWeek :

      週次スケジューリング。

    • dayOfMonth :

      月次スケジューリング。

    • dayOfYear :

      年次スケジューリング。

    • backupInterval :

      固定間隔スケジューリング (高頻度バックアップ)

    dayOfWeek
    PreferredBackupPeriod

    string

    バックアップサイクル。

    • BackupPolicy=dayOfWeek の場合: 1,2,3,4,5,6,7 は月曜日から日曜日を示します。

    • BackupPolicy=dayOfMonth の場合: 1,3,-1 は各月の 1 日、3 日、および最終日を示します。

    • BackupPolicy=dayOfYear の場合: 01-07 は 1 月 7 日を示します。

    • BackupPolicy=backupInterval の場合: 30 は 30 分ごとのバックアップを示します。

    1,2,3
    SrcRegion

    string

    インスタンスが存在するリージョン。

    cn-beijing
    SrcType

    string

    バックアップポリシーのソースタイプ。有効な値:

    • db: 同リージョンバックアップ。

    • level1: クロスリージョンバックアップ。

    列挙値:

    • level1 :

      クロスリージョンバックアップ。

    • db :

      同リージョンバックアップ。

    db
    DestRegion

    string

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

    cn-beijing
    DestType

    string

    バックアップポリシーの送信先タイプ。有効な値:

    • level1: 同リージョンバックアップ。

    • level2Cross: クロスリージョンバックアップ。

    列挙値:

    • level1 :

      同リージョンバックアップ。

    • level2Cross :

      クロスリージョンバックアップ。

    level1
    PreserveOneEachHour

    boolean

    1 時間以内のスパースバックアップを有効にするかどうかを指定します。有効な値:

    • true: バックアップ頻度が分単位の場合、現在時刻から 1 時間以内に取得されたすべてのスナップショットが保持されます。現在時刻から 1 時間以上 24 時間以内に取得されたスナップショットについては、各正時の後の最初のスナップショットのみが保持されます。

    • false: 1 時間以内のスパースバックアップは無効化されます。高頻度バックアップの保持期間内のすべてのスナップショットが保持されます。

    False
    AdvancedBackupLogPolicies

    array<object>

    ログバックアップポリシーのリスト。

    object

    EnableLogBackup

    integer

    ログバックアップが有効かどうかを示します。有効な値:

    • 1: 有効。

    • 0: 無効。

    列挙値:

    • 0 :

      無効。

    • 1 :

      有効。

    1
    RetentionType

    string

    ログバックアップの保持エポックタイプ。有効な値:

    • never: long-term 保持 (LTR)。

    • delay: 固定日数の保持。

    列挙値:

    • never :

      long-term 保持 (LTR)

    • delay :

      固定日数の保持。

    delay
    RetentionPeriod

    string

    ログバックアップを保持する日数。このパラメーターは、RetentionType が delay に設定されている場合にのみ効果があります。

    4
    SrcRegion

    string

    ソースインスタンスが存在するリージョン。

    cn-hangzhou
    SrcType

    string

    ログバックアップポリシーのソースタイプ。有効な値:

    • db: 同リージョンバックアップ。

    • level1: クロスリージョンバックアップ。

    列挙値:

    • level1 :

      クロスリージョンバックアップ。

    • db :

      同リージョンバックアップ。

    et
    DestRegion

    string

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

    cn-guangzhou
    DestType

    string

    ログバックアップポリシーの送信先タイプ。有効な値:

    • level1: 同リージョンバックアップ。

    • level2Cross: クロスリージョンバックアップ。

    列挙値:

    • level1 :

      同リージョンバックアップ。

    • level2Cross :

      クロスリージョンバックアップ。

    RDS
    PolicyId

    string

    ログバックアップポリシーの ID。このフィールドは、クロスリージョンログバックアップポリシーにのみ存在します。

    xxxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "DBInstanceId": "dds-bp14bf67a76d****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "SnapshotBackupType": "Standard",
  "BackupRetentionPolicyOnClusterDeletion": 2,
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "AdvancedBackupDataPolicies": [
    {
      "PolicyId": "xxxxxx",
      "ActionType": " xx",
      "RetentionType": "delay",
      "RetentionPeriod": 7,
      "BackupPolicy": "dayOfWeek",
      "PreferredBackupPeriod": "1,2,3",
      "SrcRegion": "cn-beijing",
      "SrcType": "db",
      "DestRegion": "cn-beijing",
      "DestType": "level1",
      "PreserveOneEachHour": true
    }
  ],
  "AdvancedBackupLogPolicies": [
    {
      "EnableLogBackup": 1,
      "RetentionType": "delay",
      "RetentionPeriod": "4",
      "SrcRegion": "cn-hangzhou",
      "SrcType": "et",
      "DestRegion": "cn-guangzhou",
      "DestType": "RDS",
      "PolicyId": "xxxx"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidPreferredBackupPeriod.Malformed Specified parameter PreferredBackupPeriod is not valid.
    400 InvalidPreferredBackupTime.Malformed Specified parameter PreferredBackupTime is not valid.

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

    変更履歴

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