すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeBackupPolicy

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeBackupPolicy

    最終更新日:Mar 26, 2026

    MongoDB インスタンスのバックアップポリシーを照会します。

    今すぐお試しください

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

    get

    *dbinstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bp16cb162771****
    InstanceType

    string

    任意

    インスタンスタイプ。

    • replicate: レプリカセット インスタンス

    • sharding: シャードクラスター インスタンス

    sharding
    SrcRegion

    string

    任意

    インスタンスが配置されているリージョン。

    cn-beijing

    レスポンスフィールド

    パラメーター

    型

    説明

    例

    object

    返されるデータ。

    PreferredBackupPeriod

    string

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

    • Monday: 月曜日。

    • Tuesday: 火曜日。

    • Wednesday: 水曜日。

    • Thursday: 木曜日。

    • Friday: 金曜日。

    • Saturday: 土曜日。

    • Sunday: 日曜日。

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

    string

    リクエスト ID。

    5A9464CA-F7DC-5434-90B1-DF7F197C****
    PreferredBackupTime

    string

    HH:mmZ-HH:mmZ 形式（UTC 時間）のバックアップ時間。

    09:00Z-10:00Z
    BackupRetentionPeriod

    string

    バックアップの保存期間（日数）。

    30
    PreferredNextBackupTime

    string

    次回の定期バックアップ時間。 yyyy-mm-ddthh:mmz 形式（UTC 時間）。

    2024-06-19T19:11Z
    EnableBackupLog

    integer

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

    • 0: 無効（デフォルト）。

    • 1: 有効。

    1
    LogBackupRetentionPeriod

    integer

    ログバックアップの保存期間（日数）。有効な値： 7 ～ 730。

    7
    SnapshotBackupType

    string

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

    • Flash: 秒レベルのバックアップ。

    • Standard: 通常のバックアップ（デフォルト）。

    Standard
    BackupInterval

    integer

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

    • -1: 高頻度バックアップは無効です。

    • 15: 15 分ごと。

    • 30: 30 分ごと。

    • 60: 1 時間ごと。

    • 120: 2 時間ごと。

    • 180: 3 時間ごと。

    • 240: 4 時間ごと。

    • 360: 6 時間ごと。

    • 480: 8 時間ごと。

    • 720: 12 時間ごと。

    -1
    HighFrequencyBackupRetention

    string

    高頻度バックアップの保存期間（日数）。

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    バックアップ保存ポリシー。

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

    2. 1: インスタンスのリリース時に自動的にバックアップされ、バックアップセットは長期間保持されます

    3. 2: インスタンスのリリース時に自動的にバックアップされ、クラスターのすべてのバックアップセットは長期間保持されます

    詳細については、「長期バックアップ保存」をご参照ください。

    0
    SrcRegion

    string

    ソースインスタンスが配置されているリージョン。

    cn-hangzhou
    DestRegion

    string

    地理的冗長バックアップが配置されているリージョン。

    cn-shenzhen
    CrossRetentionType

    string

    地理的冗長バックアップの保存タイプ。

    • delay: 一定期間保持

    • never: 有効期限切れにならない

    delay
    CrossRetentionValue

    integer

    地理的冗長バックアップの保存期間。

    7
    CrossBackupPeriod

    string

    地理的冗長バックアップの保存時間。

    1. Monday: 月曜日。

    2. Tuesday: 火曜日。

    3. Wednesday: 水曜日。

    4. Thursday: 木曜日。

    5. Friday: 金曜日。

    6. Saturday: 土曜日。

    7. Sunday: 日曜日。

    説明

    地理的冗長バックアップに必要

    Monday
    EnableCrossLogBackup

    integer

    クロスリージョンログバックアップが有効かどうかを示します。

    説明

    地理的冗長バックアップに必要

    • 1: 有効（シャードクラスター インスタンスの場合は 1 である必要があります）

    • 0: 無効（レプリカセット インスタンスの場合は 0 である必要があります）

    1
    CrossLogRetentionType

    string

    地理的冗長ログバックアップの保存タイプ。

    • delay: 一定期間保持

    • never: 有効期限切れにならない

    delay
    CrossLogRetentionValue

    integer

    地理的冗長ログバックアップの保存期間。

    7
    PreserveOneEachHour

    boolean

    1 時間以内の疎バックアップが有効かどうかを示します。

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

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

    例

    成功レスポンス

    JSONJSON

    {
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1,
  "HighFrequencyBackupRetention": "1",
  "BackupRetentionPolicyOnClusterDeletion": 0,
  "SrcRegion": "cn-hangzhou",
  "DestRegion": "cn-shenzhen",
  "CrossRetentionType": "delay",
  "CrossRetentionValue": 7,
  "CrossBackupPeriod": "Monday",
  "EnableCrossLogBackup": 1,
  "CrossLogRetentionType": "delay",
  "CrossLogRetentionValue": 7,
  "PreserveOneEachHour": true
}

    エラーコード

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

    変更履歴

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