DescribePreCheckProgressList によるバックアッププラン＆リストアジョブプレチェック進捗の監視 - DMS

この操作は、バックアッププランまたは復元ジョブの事前チェックの進捗状況を照会するために使用されます。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BackupPlanId	string	任意	バックアッププランの ID。説明 BackupPlanId または RestoreTaskId のいずれかを指定する必要があります。	dbsr1l3ro21****
RestoreTaskId	string	任意	復元ジョブの ID。	dbasdsa****
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。	ETnLKlblzczshOTUbOCziJZNwH****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Status	string	事前チェックのステータス。有効な値： running：事前チェックは進行中です。 failed：事前チェックは失敗しました。 finish：事前チェックは完了しました。	finish
HttpStatusCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	C4A45FE1-A903-470D-B113-F12A4DF942AB
Progress	integer	事前チェックの進捗状況。値の範囲は 0～100 です。	100
ErrCode	string	エラーコード。	Param.NotFound
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
ErrMessage	string	エラーメッセージ。	The specified parameter %s value is not valid.
Items	object
PreCheckProgressDetail	array<object>	進捗状況の詳細リスト。
	object	レスポンスパラメーター。
FinishTime	integer	タスクが完了した時間。この値は UNIX タイムスタンプです。	1704351396000
State	string	進捗状況のステータス。有効な値： init：タスクは初期化中です。 warning：タスクに対して警告が報告されます。 catched：タスクは異常です。 running：タスクは進行中です。 failed：タスクは失敗しました。 finish：タスクは完了しました。	warning
BootTime	integer	タスクが開始された時間。この値は UNIX タイムスタンプです。	1704351395000
JobId	string	進捗 ID。	qxwmxh2b****
Item	string	事前チェック項目のコード。	CHECK_BINLOG_ON
ErrMsg	string	エラーメッセージ。	java.lang.RuntimeException: Could not find any schema ......
OrderNum	string	シーケンス番号。	30
Names	string	事前チェック項目が属するグループ。	CHECK_BINLOG_ON_DETAIL

例

成功レスポンス

JSONJSON

{
  "Status": "finish",
  "HttpStatusCode": 200,
  "RequestId": "C4A45FE1-A903-470D-B113-F12A4DF942AB",
  "Progress": 100,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Items": {
    "PreCheckProgressDetail": [
      {
        "FinishTime": 1704351396000,
        "State": "warning",
        "BootTime": 1704351395000,
        "JobId": "qxwmxh2b****",
        "Item": "CHECK_BINLOG_ON",
        "ErrMsg": "java.lang.RuntimeException: Could not find any schema ......",
        "OrderNum": "30",
        "Names": "CHECK_BINLOG_ON_DETAIL"
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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