すべてのプロダクト
Search

このプロダクト

    :ModifyBackupPolicy

    ドキュメントセンター

    :ModifyBackupPolicy

    最終更新日:Jan 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:ModifyBackupPolicy

    update

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID です。

    dds-bp16cb162771****
    PreferredBackupTime

    string

    任意

    バックアップを実行する時間範囲。時間は HH:mmZ-HH:mmZ 形式で指定します。時間は協定世界時 (UTC) で表示されます。

    説明

    時間範囲は 1 時間である必要があります。

    03:00Z-04:00Z
    PreferredBackupPeriod

    string

    任意

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

    • 月曜日

    • 火曜日

    • 水曜日

    • 木曜日

    • 金曜日

    • 土曜日

    • 日曜日

    重要

    データセキュリティを確保するために、MongoDB インスタンスを少なくとも週に 2 回バックアップしてください。

    説明

    複数のバックアップサイクルを指定するには、コンマ (,) で区切ります。

    Monday,Wednesday,Friday,Sunday
    BackupRetentionPeriod

    integer

    任意

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

    説明

    • 2021 年 9 月 10 日より前に作成されたインスタンスの場合、デフォルトの保存期間は 7 日間です。

    • 2021 年 9 月 10 日以降に作成されたインスタンスの場合、デフォルトの保存期間は 30 日間です。

    30
    EnableBackupLog

    integer

    任意

    ログバックアップを有効にするかどうかを指定します。有効な値:

    • 0: ログバックアップを無効にします。これがデフォルト値です。

    • 1: ログバックアップを有効にします。

    重要

    シャードクラスターインスタンスのログバックアップを無効にすることはできません。

    0
    LogBackupRetentionPeriod

    integer

    任意

    ログバックアップを保持する日数。デフォルト値: 7。

    有効値: 7 ～ 730。

    7
    SnapshotBackupType

    string

    任意

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

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

    • Standard: 従来のバックアップ。これがデフォルト値です。

    Standard
    BackupInterval

    string

    任意

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

    • -1: 高頻度バックアップは無効になっています。

    • 30: 30 分ごと。

    • 60: 1 時間ごと。

    • 120: 2 時間ごと。

    • 180: 3 時間ごと。

    • 240: 4 時間ごと。

    • 360: 6 時間ごと。

    • 480: 8 時間ごと。

    • 720: 12 時間ごと。

    説明

    • SnapshotBackupType を Standard に設定した場合、このパラメータの値は -1 です。

    • 高頻度バックアップは、SnapshotBackupType を Flash に設定し、このパラメータを 0 より大きい値に設定した場合にのみ有効になります。

    -1
    HighFrequencyBackupRetention

    integer

    任意

    高頻度バックアップを保持する日数。このパラメータを指定する前に、BackupInterval パラメータを設定する必要があります。デフォルトの保存期間は 1 日です。

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    任意

    インスタンスをリリースする際のバックアップの保持ポリシー。

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

    • 1: インスタンスがリリースされると自動バックアップが実行され、このバックアップは長期間保持されます。

    • 2: インスタンスがリリースされると自動バックアップが実行され、インスタンスのすべてのバックアップセットが長期間保持されます。

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

    2
    CrossBackupType

    string

    任意

    地理的冗長バックアップのポリシー。有効な値:

    • update: 地理的冗長ポリシーを変更します。

    • delete: 地理的冗長ポリシーを削除します。

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    update
    SrcRegion

    string

    任意

    インスタンスのリージョン ID です。

    説明

    • 削除されたインスタンスを復元する場合は、このパラメータが必要です。

    • 地理的冗長性を有効にする場合は、このパラメータが必要です。

    cn-beijing
    DestRegion

    string

    任意

    地理的冗長バックアップのリージョン ID です。

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    cn-hangzhou
    CrossRetentionType

    string

    任意

    地理的冗長バックアップの保持ポリシー。有効な値:

    • delay: バックアップを指定された期間保持します。

    • never: バックアップを永続的に保持します。

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    delay
    CrossRetentionValue

    integer

    任意

    地理的冗長バックアップを保持する日数。有効値: 3 ～ 1825。

    説明

    • 地理的冗長性を有効にする場合は、このパラメータが必要です。

    • CrossRetentionType を delay に設定する場合は、このパラメータが必要です。

    7
    CrossBackupPeriod

    string

    任意

    地理的冗長バックアップを実行する曜日。有効な値:

    1. 月曜日

    2. 火曜日

    3. 水曜日

    4. 木曜日

    5. 金曜日

    6. 土曜日

    7. 日曜日

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    • 複数の日を指定するには、コンマ (,) で区切ります。

    • バックアップ方法を従来のバックアップに設定した場合、このパラメータで指定された曜日は、PreferredBackupPeriod で指定された曜日のサブセットである必要があります。

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

    integer

    任意

    クロスリージョンログバックアップを有効にするかどうかを指定します。有効な値:

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    • 1: クロスリージョンログバックアップを有効にします。この値は、シャードクラスターインスタンスに必要です。地理的冗長性のある時点復旧を有効にする場合は、レプリカセットインスタンスにもこの値が必要です。

    • 0: クロスリージョンログバックアップを無効にします。

    1
    CrossLogRetentionType

    string

    任意

    クロスリージョンログバックアップの保持ポリシー。有効な値:

    • delay: バックアップを指定された期間保持します。

    • never: バックアップを永続的に保持します。

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    delay
    CrossLogRetentionValue

    integer

    任意

    クロスリージョンログバックアップを保持する日数。有効値: 3 ～ 1825。値は CrossRetentionValue の値以下である必要があります。

    説明

    地理的冗長性を有効にする場合は、このパラメータが必要です。

    3
    InstanceType

    string

    任意

    インスタンスタイプ。有効な値:

    • replicate

    • sharding

    説明

    • 削除されたインスタンスを復元する場合は、このパラメータが必要です。

    • 地理的冗長バックアップからインスタンスを複製する場合は、このパラメータが必要です。

    replicate
    PreserveOneEachHour

    boolean

    任意

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

    • true: バックアップ頻度が分単位の場合、過去 1 時間以内に生成されたすべてのスナップショットが保持されます。1 時間以上 24 時間未満前に生成されたスナップショットの場合、毎正時以降に生成された最初のスナップショットのみが保持されます。

    • false: すべてのスナップショットは、高頻度バックアップの保存期間内に保持されます。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    644A359C-B871-4DD3-97B5-ED91EF5809C2

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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