すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    最終更新日:Aug 28, 2026

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

    操作説明

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

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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
    BackupRetentionPolicyOnClusterDeletion

    integer

    データ保持ポリシー。

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

    • 1: インスタンスがリリースされると、最後のバックアップセットが長期保持 (LTR) の term となります。

    • 2: インスタンスがリリースされると、すべてのバックアップセットが長期保持 (LTR) の term となります。

    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

    操作タイプ。

    xx
    RetentionType

    string

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

    • never: 長期保持 (LTR)。

    • delay: 固定日数の保持。

    delay
    RetentionPeriod

    integer

    バックアップが保持される日数。

    7
    BackupPolicy

    string

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

    • 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: クロスリージョンバックアップ。

    db
    DestRegion

    string

    バックアップポリシーの送信先リージョン。

    cn-beijing
    DestType

    string

    バックアップポリシーの送信先タイプ。

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

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

    level1
    PreserveOneEachHour

    boolean

    毎時のスパースバックアップが有効かどうかを示します。

    • true: バックアップ頻度が分レベルの場合、現在時刻から 1 時間以内のすべてのスナップショットが保持されます。現在時刻から 1 時間を超え 24 時間以内のスナップショットについては、各正時以降の最初のスナップショットのみが保持されます。

    • false: 毎時のスパースバックアップがシャットダウンされます。高クロック周波数バックアップの保持期間内のすべてのスナップショットが保持されます。

    False
    AdvancedBackupLogPolicies

    array<object>

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

    object

    EnableLogBackup

    integer

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

    • 1: 有効。

    • 0: 無効。

    1
    RetentionType

    string

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

    • never: 長期保持 (LTR)。

    • delay: 固定日数の保持。

    delay
    RetentionPeriod

    string

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

    4
    SrcRegion

    string

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

    cn-hangzhou
    SrcType

    string

    ログバックアップポリシーのソースタイプ。

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

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

    et
    DestRegion

    string

    ログバックアップポリシーの送信先リージョン。

    cn-guangzhou
    DestType

    string

    ログバックアップポリシーの送信先タイプ。

    • 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.

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

    変更履歴

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