すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeBackupPolicy

    ドキュメントセンター

    Data Management:DescribeBackupPolicy

    最終更新日:Jun 23, 2026

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

    操作説明

    サポートされているエンジン

    PolarDB MySQL エディション

    説明

    この API は現在、特定のお客様のみご利用いただけます。アクセスが必要な場合は、DBS カスタマーコンサルティンググループ（DingTalk グループ番号: 35585947）からお申し込みください。

    関連ドキュメント

    PolarDB MySQL エディションバックアップポリシー。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:DescribeBackupPolicy

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionCode

    string

    任意

    バックアップセットが配置されているリージョン。

    cn-beijing
    InstanceName

    string

    任意

    PolarDB インスタンス ID。

    pc-2ze3nrr64c5****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

    54A63B3B-AA10-1CC3-A6BB-6CCE98D19628
    Message

    string

    返されたメッセージ。

    instanceName can not be empty.
    Data

    object

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

    PreferredBackupDate

    string

    基本バックアップのバックアップサイクル。7 桁の文字列が返され、左から右の各桁がそれぞれ月曜日から日曜日に対応します。1 はバックアップが実行されることを示し、0 はバックアップが実行されないことを示します。

    1010101
    PreferredBackupWindowBegin

    string

    基本バックアップウィンドウの開始時刻。

    23:00Z
    PreferredBackupWindow

    string

    基本バックアップウィンドウ。

    23:00Z-24:00Z
    BackupRetentionPeriod

    integer

    基本バックアップの保持期間。高度なバックアップポリシーが有効な場合、これはレベル 1 バックアップポリシーの最長保持期間です。

    7
    BackupRetentionPolicyOnClusterDeletion

    string

    削除されたインスタンスのアーカイブバックアップ保持ポリシー。有効な値:

    • NONE: 保持しない

    • LATEST: 最後の 1 つを保持する

    • ALL: すべてを保持する。

    LATEST
    HighFrequencyBakInterval

    integer

    高クロック周波数バックアップ間隔。たとえば、120 は 2 時間ごとのバックアップを示します。単位: 分。

    120
    BackupPriority

    integer

    セカンダリインスタンスのバックアップセット。有効な値:

    • 1: セカンダリインスタンスを優先

    • 2: プライマリインスタンスを強制

    説明

    このパラメーターは RDS SQL Server インスタンスにのみ適用されます。その他のエンジンの場合、戻り値は 0 です。

    0
    EnableLogBackup

    integer

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

    • 1: 有効

    • 0: 無効。

    1
    LogBackupRetention

    integer

    ログバックアップの保持期間。

    7
    LogBackupLocalRetentionNumber

    string

    保持されるローカルログファイルの数。

    10
    EnableBackup

    integer

    バックアップが有効かどうかを示します。

    1
    LocalLogRetentionSpace

    integer

    ローカルログスペースの最大使用量レート。

    30
    HighSpaceUsageProtection

    string

    インスタンスのスペース使用量が 80% を超えた場合、または残りスペースが 5 GB 未満の場合にログを強制的にクリーンアップするかどうかを示します:

    • Disable: クリーンアップしない

    • Enable: クリーンアップする。

    Enable
    Category

    string

    秒レベルバックアップが有効かどうかを示します。有効な値:

    • Flash: 秒レベルバックアップ有効

    • Standard: 標準バックアップ

    説明

    このパラメーターは MySQL にのみ適用されます。

    Standard
    IncBackupInterval

    integer

    高クロック周波数増分バックアップ間隔。

    -1
    EnableIncBackup

    integer

    増分バックアップが有効かどうかを示します。

    0
    BackupMethod

    string

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

    • Physical: 物理バックアップ

    • Snapshot: スナップショットバックアップ。

    Physical
    AdvanceLogPolicies

    array<object>

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

    object

    ポリシーの詳細。

    PolicyId

    string

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

    dc13b153acc91141789122c23835****
    SrcType

    string

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

    • db：データベース

    • level1：レベル 1 バックアップ

    • level2：レベル 2 バックアップ

    • level2Cross：レベル 2 クロスリージョンバックアップ

    level1
    SrcRegion

    string

    バックアップポリシーのソースリージョン。

    cn-beijing
    DestType

    string

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

    • db：データベース

    • level1：レベル 1 バックアップ

    • level2：レベル 2 バックアップ

    • level2Cross：レベル 2 クロスリージョンバックアップ

    level1
    DestRegion

    string

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

    cn-shanghai
    EnableLogBackup

    integer

    予約済み。

    1
    LogRetentionType

    string

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

    • never：ログバックアップは永続的に保持されます。

    • delay：ログバックアップは指定された日数保持されます。

    delay
    LogRetentionValue

    string

    ログバックアップの保持期間 (日数)。

    3
    FilterType

    string

    高度なポリシーのフィルタータイプ。 有効な値：

    crontab：定期スケジュール

    event：イベント駆動型スケジュール

    crontab
    FilterKey

    string

    スケジュールタイプ。 有効な値：

    dayOfWeek：週次スケジュール

    dayOfMonth：月次スケジュール

    dayOfYear：年次スケジュール

    backupInterval：固定間隔スケジュール

    注：このパラメーターは、FilterType が crontab の場合にのみ返されます。

    dayOfWeek
    FilterValue

    string

    バックアップサイクル。

    1,2,3,4,5,6,7
    AdvanceDataPolicies

    array<object>

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

    object

    ポリシーの詳細。

    PolicyId

    string

    高度なポリシー ID。

    71930ac2e9f15e41615e10627c******
    FilterType

    string

    高度なポリシーのフィルタータイプ。 有効な値：

    • crontab：定期スケジュール

    • event：イベント駆動型スケジュール

    crontab
    FilterKey

    string

    スケジュールタイプ。 有効な値：

    • dayOfWeek：週次スケジュール

    • dayOfMonth：月次スケジュール

    • dayOfYear：年次スケジュール

    • backupInterval：固定間隔スケジュール

    説明

    このパラメーターは、FilterType が crontab に設定されている場合にのみ返されます。

    dayOfWeek
    FilterValue

    string

    バックアップサイクル。

    1,2,3,4,5,6,7
    DumpAction

    string

    ダンプアクション。 有効な値：

    • copy：バックアップをコピーします。

    • move：バックアップを移動します。

    copy
    RetentionType

    string

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

    • never：バックアップセットは永続的に保持されます。

    • delay：バックアップセットは指定された日数保持されます。

    delay
    RetentionValue

    string

    保持期間 (日数)。 このパラメーターは、RetentionType が delay に設定されている場合にのみ有効です。

    7
    SrcType

    string

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

    • db：データベース

    • level1：レベル 1 バックアップ

    • level2：レベル 2 バックアップ

    • level2Cross：レベル 2 クロスリージョンバックアップ

    db
    SrcRegion

    string

    バックアップポリシーのソースリージョン。

    cn-beijing
    DestType

    string

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

    • db：データベース

    • level1：レベル 1 バックアップ

    • level2：レベル 2 バックアップ

    • level2Cross：レベル 2 クロスリージョンバックアップ

    level1
    DestRegion

    string

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

    cn-beijing
    BakType

    string

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

    • F：完全バックアップ

    • L：ログバックアップ

    F
    AutoCreated

    boolean

    バックアップポリシーがシステム生成ポリシーであるかどうかを示します。 有効な値：

    • true：ポリシーはシステムによって生成されます。

    • false：ポリシーはユーザーによって定義されます。

    true
    StorageClass

    string

    データストレージタイプ。

    STANDARD
    AdvanceIncPolicies

    array<object>

    高度な増分バックアップポリシー。

    object

    PolicyId

    string

    高度なポリシー ID。

    smp-l0bfdmlr4c***
    FilterType

    string

    高度なポリシーのフィルタータイプ。 有効な値：crontab (定期スケジュール) および event (イベント駆動型スケジュール)。

    crontab
    FilterKey

    string

    スケジュールタイプ。FilterType が crontab に設定されている場合にのみ有効です。 有効な値：dayOfWeek (週次スケジュール)、dayOfMonth (月次スケジュール)、dayOfYear (年次スケジュール)、および backupInterval (固定間隔スケジュール)。

    dayOfMonth
    FilterValue

    string

    フィルターの値。

    1
    DumpAction

    string

    ダンプアクション。 有効な値：copy および move。

    Copy
    RetentionType

    string

    保持タイプ。 有効な値：never (永続的に保持) および delay (指定された日数保持)。

    delay
    RetentionValue

    string

    保持期間 (日数)。

    365
    SrcType

    string

    バックアップポリシーのソースタイプ。 有効な値：db (データベース)、level1 (レベル 1 バックアップ)、level2 (レベル 2 バックアップ)、および level2Cross (レベル 2 クロスリージョンバックアップ)。

    db
    SrcRegion

    string

    バックアップポリシーのソースリージョン。

    cn-hangzhou
    DestType

    string

    バックアップポリシーの送信先タイプ。 有効な値：db (データベース)、level1 (レベル 1 バックアップ)、level2 (レベル 2 バックアップ)、および level2Cross (レベル 2 クロスリージョンバックアップ)。

    db
    DestRegion

    string

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

    cn-hangzhou
    BakType

    string

    バックアップタイプ。 有効な値：F (完全バックアップ) および L (ログバックアップ)。

    F
    AutoCreated

    boolean

    ポリシーがシステムによって生成されたかどうかを示します。

    true
    PreferredNextBackupTime

    string

    2025-07-08T16:05Z
    EnablePitrProtection

    boolean

    LogBackupLocalRetention

    integer

    7
    ColdRetention

    integer

    30
    ColdKeepPolicy

    integer

    1
    ColdKeepCount

    integer

    1
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    Code

    string

    状態コード。

    Success
    Success

    string

    リクエストが成功したかどうかを示します。有効な値:

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true
    ErrCode

    string

    エラーコード。

    Success

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "54A63B3B-AA10-1CC3-A6BB-6CCE98D19628",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupDate": "1010101",
    "PreferredBackupWindowBegin": "23:00Z",
    "PreferredBackupWindow": "23:00Z-24:00Z",
    "BackupRetentionPeriod": 7,
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "HighFrequencyBakInterval": 120,
    "BackupPriority": 0,
    "EnableLogBackup": 1,
    "LogBackupRetention": 7,
    "LogBackupLocalRetentionNumber": "10",
    "EnableBackup": 1,
    "LocalLogRetentionSpace": 30,
    "HighSpaceUsageProtection": "Enable",
    "Category": "Standard",
    "IncBackupInterval": -1,
    "EnableIncBackup": 0,
    "BackupMethod": "Physical",
    "AdvanceLogPolicies": [
      {
        "PolicyId": "dc13b153acc91141789122c23835****",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-shanghai",
        "EnableLogBackup": 1,
        "LogRetentionType": "delay",
        "LogRetentionValue": "3",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "DumpAction": "copy",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcType": "db",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-beijing",
        "BakType": "F",
        "AutoCreated": true,
        "StorageClass": "STANDARD"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "PolicyId": "smp-l0bfdmlr4c***",
        "FilterType": "crontab",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DumpAction": "Copy",
        "RetentionType": "delay",
        "RetentionValue": "365",
        "SrcType": "db",
        "SrcRegion": "cn-hangzhou",
        "DestType": "db",
        "DestRegion": "cn-hangzhou",
        "BakType": "F",
        "AutoCreated": true
      }
    ],
    "PreferredNextBackupTime": "2025-07-08T16:05Z",
    "EnablePitrProtection": false,
    "LogBackupLocalRetention": 7,
    "ColdRetention": 30,
    "ColdKeepPolicy": 1,
    "ColdKeepCount": 1
  },
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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