すべてのプロダクト
Search

このプロダクト

    PolarDB:UpdateBackupPolicy

    ドキュメントセンター

    PolarDB:UpdateBackupPolicy

    最終更新日:Sep 10, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardbx:UpdateBackupPolicy

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    DBInstanceName

    string

    必須

    インスタンスの ID。

    pxc-hzjasdyuoo
    BackupPeriod

    string

    任意

    バックアップサイクル。少なくとも 2 日を指定する必要があります。値は 7 桁の数値です。左から右へ、各桁は月曜日から日曜日までのバックアップが有効かどうかを示します。0 はバックアップが無効であることを示し、1 はバックアップが有効であることを示します。

    • 1 桁目: 月曜日

    • 2 桁目: 火曜日

    • 3 桁目: 水曜日

    • 4 桁目: 木曜日

    • 5 桁目: 金曜日

    • 6 桁目: 土曜日

    • 7 桁目: 日曜日

    1001000
    BackupPlanBegin

    string

    任意

    協定世界時 (UTC) での毎日のバックアップ開始時刻。

    03:00Z
    BackupSetRetention

    integer

    任意

    バックアップセットの保持期間。単位: 日。

    30
    BackupType

    string

    任意

    バックアップタイプ。現在、高速バックアップを示す "0" のみがサポートされています。

    0
    BackupWay

    string

    任意

    バックアップメソッド。有効な値:

    • P: 物理バックアップ。

    • L: 論理バックアップ。

    P
    ForceCleanOnHighSpaceUsage

    integer

    任意

    インスタンスの合計スペース使用量が 80% を超えるか、または残りのスペースが 50 GB 未満になった場合に、バイナリログを強制的にクリーンアップするかどうかを指定します。クリーンアップは最も古いログから開始され、合計スペース使用量が 80% を下回り、残りのスペースが 50 GB を超えるまで続行されます。有効な値:

    • 1: はい。

    • 0: いいえ。

    1
    IsEnabled

    integer

    任意

    バックアップを有効にするかどうかを指定します。値は 1 に固定されており、バックアップが有効であることを示します。

    1
    LocalLogRetention

    integer

    任意

    ローカルでログバックアップが保持される時間数。有効な値: 0 ～ 168 (7 × 24 時間)。0 はログバックアップがローカルに保持されないことを示します。デフォルト値: 7。

    7
    RemoveLogRetention

    integer

    任意

    リモートでログバックアップが保持される日数。有効な値: 7 ～ 730。単位: 日。デフォルト値: 7。

    7
    LogLocalRetentionSpace

    integer

    任意

    バイナリログの最大値スペース使用量 (%)。有効な値: 0 ～ 50。このパラメーターはループスペースを指定します。デフォルト値: 30。

    30
    ColdDataBackupInterval

    integer

    任意

    コールドデータバックアップの間隔。単位: 日。有効な値: 1 ～ 59。

    30
    ColdDataBackupRetention

    integer

    任意

    コールドデータバックアップの保持期間。単位: 日。有効な値: 30 ～ 730。

    30
    LocalLogRetentionNumber

    integer

    任意

    保持するローカルバイナリログの数。デフォルト値: 60。有効な値: 6 ～ 100。

    60
    IsCrossRegionDataBackupEnabled

    boolean

    任意

    クロスリージョンデータバックアップを有効にするかどうかを指定します。デフォルト値: false。

    false
    IsCrossRegionLogBackupEnabled

    boolean

    任意

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

    false
    DestCrossRegion

    string

    任意

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

    cn-shanghai
    CrossRegionDataBackupRetention

    integer

    任意

    クロスリージョンデータバックアップの保持期間。単位: 日。

    30
    CrossRegionLogBackupRetention

    integer

    任意

    クロスリージョンログバックアップの保持期間。単位: 日。

    30
    CrossRegionFilterValue

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    応答メッセージ。リクエストが成功した場合は "success" が返されます。それ以外の場合は、対応するエラーコードが返されます。

    success
    RequestId

    string

    リクエストの ID。

    FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Data

    object

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

    LogLocalRetentionSpace

    integer

    DBInstanceName

    string

    BackupWay

    string

    BackupPeriod

    string

    ForceCleanOnHighSpaceUsage

    integer

    BackupType

    string

    LocalLogRetention

    integer

    RemoveLogRetention

    integer

    BackupPlanBegin

    string

    BackupSetRetention

    integer

    IsEnabled

    integer

    ColdDataBackupInterval

    integer

    ColdDataBackupRetention

    integer

    LocalLogRetentionNumber

    integer

    IsCrossRegionDataBackupEnabled

    boolean

    IsCrossRegionLogBackupEnabled

    boolean

    DestCrossRegion

    string

    CrossRegionDataBackupRetention

    integer

    CrossRegionLogBackupRetention

    integer

    CrossRegionFilterValue

    string

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "success",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Success": true,
  "Data": {
    "LogLocalRetentionSpace": 0,
    "DBInstanceName": "",
    "BackupWay": "",
    "BackupPeriod": "",
    "ForceCleanOnHighSpaceUsage": 0,
    "BackupType": "",
    "LocalLogRetention": 0,
    "RemoveLogRetention": 0,
    "BackupPlanBegin": "",
    "BackupSetRetention": 0,
    "IsEnabled": 0,
    "ColdDataBackupInterval": 0,
    "ColdDataBackupRetention": 0,
    "LocalLogRetentionNumber": 0,
    "IsCrossRegionDataBackupEnabled": false,
    "IsCrossRegionLogBackupEnabled": false,
    "DestCrossRegion": "",
    "CrossRegionDataBackupRetention": 0,
    "CrossRegionLogBackupRetention": 0,
    "CrossRegionFilterValue": ""
  }
}

    エラーコード

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

    変更履歴

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