DBS ジョブ向け DescribeJobErrorCode API リファレンス - 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:DescribeJobErrorCode

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	完全バックアップまたは復元ジョブの ID。	r1iv62ud****
Language	string	任意	エラーメッセージの言語。有効な値： en: 英語 (デフォルト) cn: 中国語	en
ClientToken	string	任意	クライアントトークン。リクエストのべき等性を保証するために使用されます。	ETnLKlblzczshOTUbOCz****

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5
ErrCode	string	エラーコード。	Param.NotFound
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrMessage	string	エラーメッセージ。	The specified parameter %s value is not valid.
Item	object	エラーコードの詳細。
JobState	string	ジョブの状態。	init
ErrorMessage	string	標準化されたエラーメッセージ。	Describe preCheck progress failed.
ErrorCode	string	エラーコード。	failed
JobId	string	完全バックアップまたは復元ジョブの ID。	r1iv62ud****
JobType	string	DBS の内部ジョブタイプ ID。	testId
Language	string	エラーメッセージの言語。	en

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Item": {
    "JobState": "init",
    "ErrorMessage": "Describe preCheck progress failed.",
    "ErrorCode": "failed",
    "JobId": "r1iv62ud****",
    "JobType": "testId",
    "Language": "en"
  }
}

エラーコード

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

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

変更履歴

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