すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeBackupDataList

    ドキュメントセンター

    Data Management:DescribeBackupDataList

    最終更新日:Dec 01, 2025

    PolarDB for MySQL クラスターのバックアップの詳細を照会します。

    操作説明

    対象エンジン

    PolarDB for MySQL

    説明

    この API 操作は、特定のお客様のみが利用できます。この操作を使用するには、DBS カスタマーサービスの DingTalk グループ (ID: 35585947) に参加してアクセスをリクエストしてください。

    関連ドキュメント

    PolarDB for 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:DescribeBackupDataList

    list

    DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceName

    string

    任意

    PolarDB クラスターの ID。

    pc-2ze3nrr64c5******
    RegionCode

    string

    任意

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

    cn-hangzhou
    SceneType

    string

    任意

    バックアップシナリオ。このパラメーターは、インスタンスが存在するリージョンでのレベル 1 バックアップを示す LEVEL_1 のみをサポートします。

    LEVEL_1
    StartTime

    string

    任意

    照会する時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時間は UTC である必要があります。

    2024-04-17T17:00:16Z
    EndTime

    string

    任意

    照会する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時間は UTC である必要があります。

    2024-04-17T17:00:32Z
    BackupStatus

    string

    任意

    バックアップセットのステータス。有効な値：

    • OK：バックアップは成功です。

    • ERROR：バックアップは失敗しました。

    OK
    BackupId

    string

    任意

    バックアップセットの ID。

    213064****
    BackupMethod

    string

    任意

    バックアップ方法。有効な値：

    • Physical：物理バックアップ

    • Logical：論理バックアップ

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

    Snapshot
    BackupMode

    string

    任意

    バックアップモード。有効な値：

    • Automated：自動バックアップ

    • Manual：手動バックアップ

    Automated
    BackupType

    string

    任意

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

    • FullBackup：完全バックアップ

    • IncrementBackup：増分バックアップ

    FullBackup
    BackupScale

    string

    任意

    バックアップ範囲。有効な値：

    • DBInstance：インスタンスバックアップ

    • DBTable：データベースとテーブルのバックアップ

    DBInstance
    PageSize

    integer

    任意

    各ページに返すエントリ数。デフォルト値は 20 です。

    20
    PageNumber

    integer

    任意

    ページ番号。値は 0 より大きく、整数データ型の最大値を超えない整数である必要があります。デフォルト値は 1 です。

    1
    InstanceIsDeleted

    boolean

    任意

    インスタンスが削除されたかどうかを指定します。有効な値：

    • true：インスタンスは削除されています。

    • false：インスタンスは削除されていません。これがデフォルト値です。

    false
    InstanceRegion

    string

    任意

    インスタンスの元のリージョン。

    cn-hangzhou
    DataSourceId

    string

    任意

    このパラメーターは予約済みであり、指定する必要はありません。

    test****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるパラメーターの詳細。

    Data

    object

    返されたデータ。

    Content

    array<object>

    タスクの詳細。

    array<object>

    タスクの詳細。

    BackupId

    string

    バックアップセットの ID。

    213088****
    BackupName

    string

    バックアップセットの名前。

    logic_backup
    BackupMode

    string

    バックアップモード。有効な値：

    • Automated：自動バックアップ

    • Manual：手動バックアップ

    Automated
    BackupType

    string

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

    • FullBackup：完全バックアップ

    • IncrementBackup：増分バックアップ

    FullBackup
    BackupScale

    string

    バックアップ範囲。有効な値：

    • DBInstance：インスタンスバックアップ

    • DBTable：データベースとテーブルのバックアップ

    DBInstance
    BackupMethod

    string

    バックアップ方法。有効な値：

    • Physical：物理バックアップ

    • Logical：論理バックアップ

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

    Snapshot
    BackupSize

    integer

    バックアップセットのサイズ (バイト単位)。

    25669140480
    BackupStatus

    string

    バックアップセットのステータス。有効な値：

    • OK：バックアップは成功です。

    • ERROR：バックアップは失敗しました。

    OK
    BackupStartTime

    string

    バックアップの開始時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式です。時間は UTC で表示されます。

    2024-04-17T17:00:16Z
    BackupEndTime

    string

    バックアップの終了時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式です。時間は UTC で表示されます。

    2024-04-17T17:00:32Z
    ConsistentTime

    integer

    整合性スナップショットの時点。値は UNIX タイムスタンプです。単位：秒。

    1713373221
    BackupLocation

    string

    バックアップのストレージパス。

    logic
    InstanceName

    string

    インスタンスの ID。

    pc-2ze3nrr64c5******
    Engine

    string

    データベースエンジンタイプ。

    polardb_mysql
    EngineVersion

    string

    データベースエンジンバージョン。

    5.7
    SupportDeletion

    integer

    バックアップセットが削除可能かどうかを示します。有効な値：

    • 0：バックアップセットは削除可能です。

    • 1：バックアップセットは削除できません。

    0
    Encryption

    string

    暗号化情報。

    psk2
    IsAvail

    integer

    バックアップセットが利用可能かどうかを示します。有効な値：

    • 1：バックアップセットは利用可能です。

    • 0：バックアップセットは利用できません。

    1
    Checksum

    string

    チェックサム。

    84a4c16431f969712e6895992719****
    BackupDownloadURL

    string

    バックアップセットのパブリックダウンロード URL。

    説明

    このパラメーターは、BackupMethod が Physical (物理バックアップ) または Logical (論理バックアップ) に設定されている場合にのみ返されます。

    http://oss.com/****
    BackupIntranetDownloadURL

    string

    バックアップセットの内部ダウンロード URL。

    説明

    このパラメーターは、BackupMethod が Physical (物理バックアップ) または Logical (論理バックアップ) に設定されている場合にのみ返されます。

    http://oss.com/****
    ExpectExpireType

    string

    バックアップセットの予想される有効期限タイプ。有効な値：

    • NEVER

    • EXPIRED

    • DELAY

    DELAY
    ExpectExpireTime

    string

    バックアップセットの予想される有効期限。時間は yyyy-MM-ddTHH:mm:ssZ 形式です。時間は UTC で表示されます。

    2024-04-19T05:00:49Z
    PolarSnapshot

    object

    PolarDB クラスターのレベル 2 ダンプに関する情報。

    説明

    PolarSnapshot 関連の情報は、同じリージョンの PolarDB クラスターでレベル 2 ダンプ機能が有効になり、レベル 1 バックアップが正常にダンプされた後にのみ返されます。

    DumpId

    integer

    ダンプの ID。

    abc****
    DumpSize

    integer

    ダンプバックアップのサイズ (バイト単位)。

    25669140589
    expectExpireType

    string

    バックアップセットの予想される有効期限タイプ。有効な値：

    • NEVER

    • EXPIRED

    • DELAY

    DELAY
    ExpectExpireTime

    string

    バックアップセットの予想される有効期限。時間は yyyy-MM-ddTHH:mm:ssZ 形式です。時間は UTC で表示されます。

    2024-04-19T05:00:49Z
    PageSize

    integer

    ページサイズ。

    20
    PageNumber

    integer

    ページ番号。

    1
    TotalPages

    integer

    総ページ数。

    1
    TotalElements

    integer

    バックアップセットの総数。

    1
    Extra

    string

    追加情報。

    dbtest
    RequestId

    string

    リクエスト ID。

    95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
    ErrCode

    string

    エラーコード。

    Request.Forbidden

    Success

    string

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

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    Code

    string

    ステータスコード。

    Success
    Message

    string

    返されたメッセージ。

    The specified parameter %s value is not valid.

    例

    成功レスポンス

    JSONJSON

    {
  "Data": {
    "Content": [
      {
        "BackupId": "213088****",
        "BackupName": "logic_backup",
        "BackupMode": "Automated",
        "BackupType": "FullBackup",
        "BackupScale": "DBInstance",
        "BackupMethod": "Snapshot",
        "BackupSize": 25669140480,
        "BackupStatus": "OK",
        "BackupStartTime": "2024-04-17T17:00:16Z",
        "BackupEndTime": "2024-04-17T17:00:32Z",
        "ConsistentTime": 1713373221,
        "BackupLocation": "logic",
        "InstanceName": "pc-2ze3nrr64c5******",
        "Engine": "polardb_mysql",
        "EngineVersion": "5.7",
        "SupportDeletion": 0,
        "Encryption": "psk2",
        "IsAvail": 1,
        "Checksum": "84a4c16431f969712e6895992719****",
        "BackupDownloadURL": "http://oss.com/****",
        "BackupIntranetDownloadURL": "http://oss.com/****",
        "ExpectExpireType": "DELAY",
        "ExpectExpireTime": "2024-04-19T05:00:49Z",
        "PolarSnapshot": {
          "DumpId": 0,
          "DumpSize": 25669140589,
          "expectExpireType": "DELAY",
          "ExpectExpireTime": "2024-04-19T05:00:49Z"
        }
      }
    ],
    "PageSize": 20,
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalElements": 1,
    "Extra": "dbtest"
  },
  "RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
  "ErrCode": "Request.Forbidden\t",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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