DescribeRestoreTaskList - - Alibaba Cloud ドキュメントセンター

この操作は、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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BackupPlanId	string	任意	バックアッププランの ID です。説明このパラメーターまたは RestoreTaskId のいずれかを指定する必要があります。	dbs1hvb0wwwXXXXX
RestoreTaskId	string	任意	復元ジョブの ID です。複数のジョブを照会するには、ID をカンマ (,) で区切ります。CreateRestoreTask 操作を呼び出してこのパラメーターを取得できます。説明このパラメーターまたは BackupPlanId のいずれかを指定する必要があります。両方を指定するとエラーが報告されます。	s102h7rf5anq
PageSize	integer	任意	各ページに返すエントリ数です。有効値：1～100。説明デフォルト値は 30 です。	30
PageNum	integer	任意	ページ番号です。値は 0 以上の整数である必要があります。デフォルト値は 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	クロスアカウントバックアップに使用される Resource Access Management (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

例

成功レスポンス

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
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Request.Forbidden	Have no Permissions

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

変更履歴

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