すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeFullBackupList

    ドキュメントセンター

    Data Management:DescribeFullBackupList

    最終更新日:Apr 24, 2026

    この操作は、Database Backup (DBS) の完全バックアップタスクを一覧表示します。

    今すぐお試しください

    この 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:DescribeFullBackupList

    get

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアッププランの ID。

    dbsr179qz******
    PageSize

    integer

    任意

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

    • 30

    • 50

    • 100

    デフォルト値：30。

    30
    PageNum

    integer

    任意

    返すページのページ番号。値は 0 以上の整数である必要があります。デフォルト値：0。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用できるトークン。

    ETnLKlblzczshOTUbOCzxxxxxxx
    ShowStorageType

    boolean

    任意

    バックアップセットのストレージタイプを返すかどうかを指定します。

    true
    BackupSetId

    string

    任意

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

    1iukx5h******
    StartTimestamp

    integer

    任意

    クエリする時間範囲の開始時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過した秒数を表す UNIX タイムスタンプです。

    1676887100
    EndTimestamp

    integer

    任意

    クエリする時間範囲の終了時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過した秒数を表す UNIX タイムスタンプです。

    1676887128
    ShowProgress

    string

    任意

    バックアップの進捗に関するリアルタイム情報を返すかどうかを指定します。

    true
    BackupSetStatus

    string

    任意

    バックアップセットのステータス。このパラメーターを使用してバックアップセットをフィルターできます。

    finish

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    PageNum

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

    636BC118-6080-4119-A6B5-C199CEC1037D
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

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

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

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

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    総ページ数。

    1
    TotalElements

    integer

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

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    Items

    object

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

    FullBackupFile

    array<object>

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

    object

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

    FinishTime

    integer

    バックアップタスクが完了した時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

    1676887128000
    BackupStatus

    string

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

    • schedule：バックアップタスクは保留中です。

    • running：バックアップタスクは実行中です。

    • finish：バックアップタスクは完了しました。

    • stop：バックアップタスクは失敗しました。

    • pause：バックアップタスクは一時停止中です。

    finish
    SourceEndpointIpPort

    string

    データベースへの接続に使用されるエンドポイント。

    121.XXX.XXX.144:3306
    CreateTime

    integer

    バックアップタスクが作成された時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

    1676886947000
    ErrMessage

    string

    バックアップタスクが失敗した場合に返されるエラーメッセージ。

    NULL
    BackupObjects

    string

    バックアップオブジェクト。

    [{\"DBName\":\"test\"}]
    EndTime

    integer

    バックアップが完了した時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

    1676887128000
    StartTime

    integer

    バックアップが開始された時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

    1676887100000
    BackupSetExpiredTime

    integer

    バックアップセットの有効期限が切れる時刻。この値は、1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

    1677491900000
    StorageMethod

    string

    バックアップセットのストレージクラス。有効な値：

    • Standard：標準

    • IA：低頻度アクセス

    • Archive：アーカイブ

    • UNKNOWN：この値は、ストレージクラスが取得されない場合に返されます。

    Standard
    BackupSetId

    string

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

    1iukx5h******
    BackupSize

    integer

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

    580
    SourceEndpointInstanceType

    string

    ソースデータベースのインスタンスタイプ。

    rds
    SourceEndpointInstanceId

    string

    ソースインスタンスの ID。

    rm-testxx
    SourceEndpointRegion

    string

    ソースインスタンスが存在するリージョン。

    cn-beijing
    SourceEndpointHost

    string

    ソースデータベースのエンドポイント。

    127.0.0.1
    StorageEncryptMethod

    string

    バックアップストレージの暗号化メソッド。

    encrypted
    CrossRoleName

    string

    クロスアカウントバックアップ用に作成された RAM ロールの名前。

    ram-for-dbs
    CrossAliyunId

    string

    クロスアカウントバックアップに使用される Alibaba Cloud アカウントの ID。

    2xxx7778xxxxxxxxxx
    SourceEndpointEnableSsl

    string

    ソースデータベースで SSL 暗号化が有効になっているかどうかを示します。

    true
    LogicalStructureBackupProgress

    integer

    論理スキーマバックアップの進捗。

    100
    LogicalFullBackupProgress

    integer

    論理完全バックアップの進捗。

    100
    BackupGatewayIdentifier

    string

    バックアップゲートウェイの ID。

    TESTGATEWAY
    SourceEndpointUserName

    string

    ソースデータベースのユーザー名。

    dbs_backup
    SourceEndpointPort

    string

    ソースデータベースのポート番号。

    3306

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": {
    "FullBackupFile": [
      {
        "FinishTime": 1676887128000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "121.XXX.XXX.144:3306",
        "CreateTime": 1676886947000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1676887128000,
        "StartTime": 1676887100000,
        "BackupSetExpiredTime": 1677491900000,
        "StorageMethod": "Standard",
        "BackupSetId": "1iukx5h******",
        "BackupSize": 580,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "StorageEncryptMethod": "encrypted",
        "CrossRoleName": "ram-for-dbs",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "SourceEndpointEnableSsl": "true",
        "LogicalStructureBackupProgress": 100,
        "LogicalFullBackupProgress": 100,
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "SourceEndpointUserName": "dbs_backup",
        "SourceEndpointPort": "3306"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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