すべてのプロダクト
Search

このプロダクト

    :DescribeRestoreTaskList

    ドキュメントセンター

    :DescribeRestoreTaskList

    最終更新日:Mar 20, 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。

    説明

    BackupPlanId または RestoreTaskId のいずれかを指定する必要があります。

    dbs1hvb0wwwXXXXX
    RestoreTaskId

    string

    任意

    復元ジョブの ID。 複数の ID を指定できます。コンマ (,) で区切ります。CreateRestoreTask 操作を呼び出してこのパラメーターを取得します。

    説明

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

    s102h7rf5anq
    PageSize

    integer

    任意

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

    説明

    デフォルト値：30。

    30
    PageNum

    integer

    任意

    ページ番号。値は 0 以上で、integer データ型の最大値を超えてはなりません。デフォルト値：0。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。これにより、重複したリクエストを防ぎます。

    ETnLKlblzczshOTUbOCzxxxxxxx
    StartTimestamp

    integer

    任意

    バックアップの開始時刻。

    1570701361528
    EndTimestamp

    integer

    任意

    バックアップの終了時刻。

    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

    ページごとに返されるエントリ数。

    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

    復元パス。

    100.X.X.10:33204
    CrossAliyunId

    string

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

    2xxx7778xxxxxxxxxx
    RestoreObjects

    string

    復元オブジェクト。

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

    string

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

    dbs1hvb0wXXXX
    DestinationEndpointRegion

    string

    データベースのリージョン。

    cn-hangzhou
    RestoreTaskCreateTime

    integer

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

    1554560477000
    DestinationEndpointUserName

    string

    データベースアカウント。

    test
    RestoreTaskFinishTime

    integer

    復元ジョブが完了した時刻。この値は UNIX タイムスタンプです。単位：ミリ秒。

    1554560477000
    DestinationEndpointIpPort

    string

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

    100.X.X.10:33204
    DestinationEndpointDatabaseName

    string

    データベース名。

    test
    DestinationEndpointInstanceType

    string

    データベースの場所。有効値：

    • RDS

    • ECS

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

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

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

    • other：インターネット経由で接続されたデータベース。

    RDS
    DestinationEndpointOracleSID

    string

    Oracle システム ID (SID)。

    test
    FullStruforeRestoreProgress

    integer

    復元前の構造復元の進捗。

    0
    ErrMessage

    string

    エラーメッセージ。

    NULL
    RestoreTaskId

    string

    復元ジョブの ID。

    s1XXXXXX
    FullDataRestoreProgress

    integer

    完全データ復元の進捗。

    100
    ContinuousRestoreProgress

    integer

    増分ログ復元の進捗。

    100
    DestinationEndpointInstanceID

    string

    データベースインスタンスの ID。

    rm-bp1p8c2947XXX
    BackupSetId

    string

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

    1ibh2f5uXXX
    BackupGatewayId

    integer

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

    324234332
    RestoreTaskName

    string

    復元ジョブの名前。

    test
    RestoreTime

    integer

    復元時刻。この値は UNIX タイムスタンプです。単位：ミリ秒。

    1554560477000
    DestinationEndpointHost

    string

    127.0.0.1
    DestinationEndpointPort

    string

    3306
    DestinationEndpointEnableSsl

    string

    true
    BackupGatewayIdentifier

    string

    TESTGATEWAY
    BackupSourceOssRegion

    string

    cn-beijing
    RestoreDestinationMode

    string

    EXIST_INSTANCE
    PhysicalFullBackupRecoverProgress

    integer

    PhysicalFullAndIncrementBackupRecoverProgress

    integer

    PhysicalIncrementBackupRecoverProgress

    integer

    PhysicalDatabaseOnlineProgress

    integer

    PhysicalBackupRecoverProgress

    integer

    例

    成功レスポンス

    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": "100.X.X.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[     {         \\\"DBName\\\":\\\"test\\\"       } ]",
        "BackupPlanId": "dbs1hvb0wXXXX",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "test",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 0,
        "ErrMessage": "NULL",
        "RestoreTaskId": "s1XXXXXX",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "1ibh2f5uXXX",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "test",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 0,
        "PhysicalFullAndIncrementBackupRecoverProgress": 0,
        "PhysicalIncrementBackupRecoverProgress": 0,
        "PhysicalDatabaseOnlineProgress": 0,
        "PhysicalBackupRecoverProgress": 0
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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