GetJobStatus で非同期タスクの進捗を監視 - DataWorks - Alibaba Cloud - DataWorks

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:GetJobStatus

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
JobId	string	必須	非同期 API の呼び出し後に返されるタスク ID。	70ecdaec-bf21-4c11-8ecb-4f77453ceea8

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	5E2BFE96-C0E0-5A98-85C8-633EC803198D
JobStatus	object	タスクステータスのリアルタイム結果。
JobId	string	非同期タスクの ID。	C664CDE3-9C0B-5792-B17F-6C543783BBBC
JobType	string	タスクタイプ。 Create: 作成タスク。 Update: 更新タスク。 Cancel: キャンセルタスク。	Create
Completed	string	操作が完了しているかどうかを示します。有効な値: True: 現在のタスクは完了しています。 False: 現在のタスクはまだ実行中です。	False
Status	string	タスクのステータス。有効な値: Success: 成功。 Fail: 失敗した。 Cancel: キャンセル済み。 Running: 実行中。	Success
Error	string	タスクの失敗情報。	Not Found
CreateTime	string	作成時間。値は `1729063449802` のような 13 桁の数値です。	1729063449802

例

成功レスポンス

JSONJSON

{
  "RequestId": "5E2BFE96-C0E0-5A98-85C8-633EC803198D",
  "JobStatus": {
    "JobId": "C664CDE3-9C0B-5792-B17F-6C543783BBBC",
    "JobType": "Create",
    "Completed": "False",
    "Status": "Success",
    "Error": "Not Found",
    "CreateTime": "1729063449802"
  }
}

エラーコード

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

変更履歴

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