すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeRestoreTaskList

    ドキュメントセンター

    Data Management:DescribeRestoreTaskList

    最終更新日:Apr 24, 2026

    Database Backup Service (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:DescribeRestoreTaskList

    get

    *BackupPlan

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    任意

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

    説明

    このパラメーターまたは RestoreTaskId を指定する必要があります。

    dbs1hvb0wwwXXXXX
    RestoreTaskId

    string

    任意

    復元タスクの ID。複数の ID をコンマで区切って指定できます。CreateRestoreTask 操作を呼び出して、復元タスク ID を取得できます。

    説明

    このパラメーターまたは BackupPlanId のいずれかを指定する必要があります。両方のパラメーターを指定すると、エラーが返されます。

    s102h7rf5anq
    PageSize

    integer

    任意

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

    説明

    デフォルト値は 30 です。

    30
    PageNum

    integer

    任意

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

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用される、クライアントで生成されたトークン。クライアント側でトークンを生成しますが、異なるリクエスト間で一意である必要があります。

    ETnLKlblzczshOTUbOCzxxxxxxx
    StartTimestamp

    integer

    任意

    復元タスクを照会する時間範囲の開始時刻。UNIX タイムスタンプ形式で時刻を指定します。タイムスタンプはミリ秒レベルのタイムスタンプです。

    1570701361528
    EndTimestamp

    integer

    任意

    復元タスクを照会する時間範囲の終了時刻。UNIX タイムスタンプ形式で時刻を指定します。タイムスタンプはミリ秒レベルのタイムスタンプです。

    1570701361528

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    PageNum

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

    9C397502-B4F2-4E22-AD97-C81F0049F3F3
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

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

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    返されたページの総数。

    1
    TotalElements

    integer

    復元ジョブの総数。

    1
    PageSize

    integer

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

    30
    Items

    object

    RestoreTaskDetail

    array<object>

    復元ジョブの詳細。

    object

    RestoreStatus

    string

    復元ジョブのステータス。有効な値：

    • init：復元ジョブが初期化中であるか、事前チェックに失敗しました。

    • running：復元ジョブは実行中です。

    • stop：復元ジョブは失敗しました。

    • pause：復元ジョブは一時停止中です。

    • check_pass：事前チェックは成功しました。

    running
    FullStruAfterRestoreProgress

    integer

    復元後の完全なスキーマ復元の進捗。

    100
    CrossRoleName

    string

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

    test123
    RestoreDir

    string

    復元パス。

    /home/test
    CrossAliyunId

    string

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

    2xxx7778xxxxxxxxxx
    RestoreObjects

    string

    復元オブジェクト。

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

    string

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

    dbsxxxx
    DestinationEndpointRegion

    string

    宛先インスタンスのリージョン。

    cn-hangzhou
    RestoreTaskCreateTime

    integer

    復元ジョブが作成された時刻。ミリ秒単位の UNIX タイムスタンプで表されます。

    1554560477000
    DestinationEndpointUserName

    string

    宛先エンドポイントのデータベースアカウント。

    testUser
    RestoreTaskFinishTime

    integer

    復元ジョブが完了した時刻。ミリ秒単位の UNIX タイムスタンプで表されます。

    1554560477000
    DestinationEndpointIpPort

    string

    宛先データベースインスタンスの接続アドレス。

    100.X.X.10:33204
    DestinationEndpointDatabaseName

    string

    宛先エンドポイントのデータベース名。

    test
    DestinationEndpointInstanceType

    string

    宛先インスタンスのタイプ。有効な値：

    • RDS

    • ECS

    • Express：Express Connect、VPN Gateway、または Smart Access Gateway を介して接続されたデータベース。

    • Agent：バックアップゲートウェイを介して接続されたデータベース。

    • DDS：ApsaraDB for MongoDB インスタンス。

    • Other：IP アドレスとポートを介してインターネット経由で接続されたデータベース。

    • dg：パブリック IP アドレスを持たず、データベースゲートウェイ (DG) を介して接続された自己管理データベース。

    RDS
    DestinationEndpointOracleSID

    string

    Oracle SID。

    説明

    このパラメーターは Oracle データベースに必須です。

    test
    FullStruforeRestoreProgress

    integer

    復元前の完全なスキーマ復元の進捗。

    100
    ErrMessage

    string

    エラーメッセージ。

    NULL
    RestoreTaskId

    string

    復元ジョブの ID。

    1iyixxxxxx
    FullDataRestoreProgress

    integer

    完全データ復元の進捗。

    100
    ContinuousRestoreProgress

    integer

    増分ログ復元の進捗。

    100
    DestinationEndpointInstanceID

    string

    宛先インスタンスの ID。

    rm-bp1p8c2947XXX
    BackupSetId

    string

    復元に使用された完全バックアップセットの ID。

    urjlfmxxxxx
    BackupGatewayId

    integer

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

    324234332
    RestoreTaskName

    string

    復元ジョブの名前。

    dbsr1g3xxxx_Restore_Task_1775009514575
    RestoreTime

    integer

    データが復元される特定の時点。ミリ秒単位の UNIX タイムスタンプで表されます。

    1554560477000
    DestinationEndpointHost

    string

    宛先インスタンスの IP アドレスまたはドメイン名。

    127.0.0.1
    DestinationEndpointPort

    string

    宛先データベースのポート番号。

    3306
    DestinationEndpointEnableSsl

    string

    宛先データベースへの接続が SSL 暗号化されているかどうかを示します。

    true
    BackupGatewayIdentifier

    string

    宛先エンドポイントのバックアップゲートウェイの一意の ID。

    TESTGATEWAY
    BackupSourceOssRegion

    string

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

    cn-beijing
    RestoreDestinationMode

    string

    宛先エンドポイントにデータを復元するために使用されるメソッド。

    EXIST_INSTANCE
    PhysicalFullBackupRecoverProgress

    integer

    完全な物理復元の進捗。このパラメーターは、MySQL および SQL Server の物理バックアップに適用されます。

    100
    PhysicalFullAndIncrementBackupRecoverProgress

    integer

    完全および増分物理復元の進捗。このパラメーターは、MySQL の物理バックアップに適用されます。

    100
    PhysicalIncrementBackupRecoverProgress

    integer

    増分物理復元の進捗。このパラメーターは、SQL Server の物理バックアップに適用されます。

    100
    PhysicalDatabaseOnlineProgress

    integer

    物理復元後にデータベースをオンラインにする進捗。このパラメーターは、SQL Server の物理バックアップに適用されます。

    100
    PhysicalBackupRecoverProgress

    integer

    物理復元の進捗。このパラメーターは、Oracle の物理バックアップに適用されます。

    100

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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