DescribeRestorePlans API を使用した復元タスクのクエリ - Security Center

復元タスクを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:DescribeRestorePlans

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceName	string	任意	サーバーの名前。	sql-test-001
PageSize	integer	任意	各ページで返されるエントリ数。デフォルト値: 20。このパラメーターを空のままにした場合、各ページで 20 個のエントリが返されます。説明このパラメーターを空のままにしないことを推奨します。	20
CurrentPage	integer	任意	返されるページの番号。デフォルト値: 1。	1
Status	string	任意	復元タスクのステータス。有効な値: init: 初期化中 created: 作成中 running: 実行中 completed: 完了 error: 失敗 restoring: 復元中	running

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエストの ID。問題の特定とトラブルシューティングに使用されます。	BE120DAB-F4E7-4C53-ADC3-A97578AB****
PageInfo	object	ページネーション情報。
CurrentPage	integer	返されるページのページ番号。	1
PageSize	integer	1 ページあたりに返されるエントリ数。	20
TotalCount	integer	返されるエントリの合計数。	33
Count	integer	現在のページで返されるエントリ数。	20
RestorePlans	array<object>	復元タスクで構成される配列。
	object	復元タスクに関する情報。
Status	string	復元タスクのステータス。有効な値: init: 初期化中 created: 作成中 running: 実行中 completed: 完了 error: 失敗 restoring: 復元中	running
RestorePoint	integer	データが復元される時点。	165875100****
UpdatedTime	integer	復元タスクが最終更新されたタイムスタンプ。単位: ミリ秒。	166849080****
DatabaseName	string	データベースの名前。	Bankup****
InstanceName	string	データベースが存在するサーバーの名前。	sql-test-001
TargetInstanceName	string	送信先サーバーの名前。	hbr-detection-hh
TargetDatabaseName	string	ターゲットデータベースの名前。	OABak
PolicyName	string	ランサムウェア対策ポリシーの名前。	KtDataBase
PolicyId	integer	ランサムウェア対策ポリシーの ID。	123
TargetInstanceId	string	送信先サーバーの ID。	i-2zehqflgbl9ep2he****
CreatedTime	integer	復元タスクが作成されたタイムスタンプ。単位: ミリ秒。	1655174753****

例

成功レスポンス

JSONJSON

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578AB****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 33,
    "Count": 20
  },
  "RestorePlans": [
    {
      "Status": "running",
      "RestorePoint": 0,
      "UpdatedTime": 0,
      "DatabaseName": "Bankup****",
      "InstanceName": "sql-test-001",
      "TargetInstanceName": "hbr-detection-hh",
      "TargetDatabaseName": "OABak",
      "PolicyName": "KtDataBase",
      "PolicyId": 123,
      "TargetInstanceId": "i-2zehqflgbl9ep2he****",
      "CreatedTime": 0
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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