すべてのプロダクト
Search

このプロダクト

    :DescribeBackups

    ドキュメントセンター

    :DescribeBackups

    最終更新日:Sep 11, 2025

    PolarDB クラスターのバックアップ情報をクエリします。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeBackups

    get

    *Backup

    acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスターの ID です。

    pc-****************
    BackupId

    string

    任意

    バックアップ ID です。

    11111111
    BackupStatus

    string

    任意

    バックアップのステータス。有効な値:

    • Success: バックアップは成功しました。

    • Failed: バックアップは失敗しました。

    Success
    BackupMode

    string

    任意

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

    • Automated: 自動バックアップ

    • Manual: 手動バックアップ

    Automated
    StartTime

    string

    必須

    クエリする時間範囲の開始時刻。時刻は YYYY-MM-DDThh:mmZ 形式で指定します。時刻は UTC である必要があります。

    2020-11-14T00:00Z
    EndTime

    string

    必須

    クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻は YYYY-MM-DDThh:mmZ 形式で指定します。時刻は UTC である必要があります。

    2020-11-16T00:00Z
    BackupRegion

    string

    任意

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

    説明

    このパラメーターは PolarDB for MySQL でのみサポートされています。

    cn-hangzhou
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値:

    • 30

    • 50

    • 100

    デフォルト値: 30。

    30
    PageNumber

    integer

    任意

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalRecordCount

    string

    エントリの総数。

    1
    PageRecordCount

    string

    現在のページで返されたエントリ数。

    1
    RequestId

    string

    リクエスト ID。

    24A1990B-4F6E-482B-B8CB-75C612******
    PageNumber

    string

    ページ番号。

    1
    Items

    object

    Backup

    array<object>

    バックアップセットの詳細。

    object

    BackupSetSize

    string

    バックアップファイルのサイズ。単位: バイト。

    説明

    スナップショットはデータブロックを共有するため、スナップショットバックアップを削除した後に解放されるストレージ領域は、バックアップファイルのサイズよりもはるかに小さくなります。詳細については、「バックアップに関するよくある質問」をご参照ください。

    4639948800
    ConsistentTime

    string

    一貫性のあるスナップショットの時点。この値は UNIX タイムスタンプです。単位: 秒。

    1605425407
    BackupStatus

    string

    バックアップのステータス。有効な値:

    • Success: バックアップは成功しました。

    • Failed: バックアップは失敗しました。

    Success
    BackupType

    string

    バックアップタイプ。完全バックアップのみがサポートされています。値は FullBackup に固定されています。

    FullBackup
    BackupStartTime

    string

    バックアップの開始時刻。時刻は UTC です。

    2020-11-15T07:30:05Z
    ExpectExpireTime

    string

    バックアップセットの予想される有効期限。このパラメーターは、スパースバックアップ機能が有効になっているインスタンスでのみサポートされます。

    2022-10-24T08:13:23Z
    ExpectExpireType

    string

    バックアップセットの予想される有効期限タイプ。このパラメーターは、スパースバックアップ機能が有効になっているインスタンスでのみサポートされます。

    枚举值：
    • NEVER :

      NEVER

    • EXPIRED :

      EXPIRED

    • DELAY :

      DELAY

    EXPIRED
    IsAvail

    string

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

    • 0: 利用不可

    • 1: 利用可能

    0
    BackupEndTime

    string

    バックアップの終了時刻。時刻は UTC です。

    2020-11-15T07:30:20Z
    BackupId

    string

    バックアップ ID です。

    61*******
    DBClusterId

    string

    クラスター ID です。

    pc-****************
    BackupsLevel

    string

    バックアップセットのレベル。有効な値:

    • Level-1: レベル 1 バックアップ

    • Level-2: レベル 2 バックアップ

    Level-1
    BackupMode

    string

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

    • Automated: 自動バックアップ

    • Manual: 手動バックアップ

    Automated
    BackupMethod

    string

    データバックアップメソッド。スナップショットバックアップのみがサポートされています。値は Snapshot に固定されています。

    Snapshot
    TotalLevel2BackupSize

    string

    指定されたリージョン内のレベル 2 バックアップの合計サイズ。単位: バイト。

    説明

    • このパラメーターは、PSL4 または PSL5 ストレージタイプを使用するクラスターでのみサポートされます。

    • このパラメーターは、レベル 2 バックアップ機能が有効になっているクラスターでのみサポートされます。

    • このパラメーターが返されない場合、レベル 2 バックアップのサイズは 0 です。

    4639948800

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot"
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    400 InvalidBackupStatus.Malformed The specified parameter BackupStatus is not valid.
    400 InvalidBackupMode.Malformed The specified parameter BackupMode is not valid.
    400 InvalidStartTime.Malformed The specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The specified parameter EndTime is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records.

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

    変更履歴

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