すべてのプロダクト
Search
ドキュメントセンター

DataWorks:GetWorkflowInstance

最終更新日:Mar 21, 2026

ワークフローインスタンスの情報を照会します。

操作説明

この機能を使用するには、DataWorks Basic Edition またはそれ以上のエディションを購入する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

Id

integer

必須

ワークフローインスタンスの ID です。

1234

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID です。

22C97E95-F023-56B5-8852-B1A77A17XXXX

WorkflowInstance

object

ワークフローインスタンスの情報です。

Id

integer

ワークフローインスタンスの ID です。

1234

WorkflowId

integer

インスタンスが属するワークフローの ID です。

1234

WorkflowTaskInstanceId

integer

ワークフローインスタンスに対応するタスクインスタンス ID です。

1234

UnifiedWorkflowInstanceId

integer

統合パイプラインインスタンス ID です。1 回のトリガーで同じデータタイムスタンプの下にトリガーされたすべてのパイプラインインスタンスについて、このフィールドの値は同一になります。

1234

Name

string

ワークフローインスタンスの名前です。

WorkInstance1

Type

string

ワークフローインスタンスのタイプです。有効な値は以下のとおりです。

  • Normal:スケジュール実行

  • Manual:手動トリガーされたノード

  • SmokeTest:テスト

  • SupplementData:データバックフィル

  • ManualWorkflow:手動トリガーされたワークフロー

  • TriggerWorkflow:トリガーされたワークフロー

Normal

Status

string

ワークフローインスタンスのステータスです。有効な値は以下のとおりです。

  • NotRun:インスタンスは実行されていません。

  • Running:インスタンスは実行中です。

  • WaitTime:インスタンスはスケジューリング時刻の到達を待機しています。

  • CheckingCondition:インスタンスの分岐条件をチェックしています。

  • WaitResource:インスタンスはリソースを待機しています。

  • Failure:インスタンスの実行に失敗しました。

  • Success:インスタンスは正常に実行されました。

  • Checking:インスタンスのデータ品質をチェックしています。

Success

BizDate

integer

データタイムスタンプです。

1710239005403

StartedTime

integer

インスタンスの実行開始時刻です。

1710239005403

FinishedTime

integer

インスタンスの実行完了時刻です。

1710239005403

ProjectId

integer

ワークスペース ID です。

100

EnvType

string

ワークスペースの環境です。有効な値は以下のとおりです。

  • Prod

  • Dev

Prod

Owner

string

ワークフローのオーナーのアカウント ID です。

1000

CreateTime

integer

作成時刻です。

1710239005403

ModifyTime

integer

更新時刻です。

1710239005403

CreateUser

string

作成者のアカウント ID です。

1000

ModifyUser

string

更新者のアカウント ID です。

1000

WorkflowParameters

string

ワークフローパラメーターです。

周期工作流: key1=value1 key2=value2 手动业务流程: {"key1":"value1", "key2": "value2"}

Tags

array<object>

タスクタグです。

object

Key

string

タグのキーです。

key1

Value

string

タグの値です。

value1

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "WorkflowInstance": {
    "Id": 1234,
    "WorkflowId": 1234,
    "WorkflowTaskInstanceId": 1234,
    "UnifiedWorkflowInstanceId": 1234,
    "Name": "WorkInstance1",
    "Type": "Normal",
    "Status": "Success",
    "BizDate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WorkflowParameters": "周期工作流:\nkey1=value1 key2=value2\n手动业务流程:\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

エラーコード

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

変更履歴

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