すべてのプロダクト
Search

このプロダクト

    DataWorks:GetTaskInstance

    ドキュメントセンター

    DataWorks:GetTaskInstance

    最終更新日:Mar 21, 2026

    インスタンスの情報を照会します。

    操作説明

    本機能を利用するには、DataWorks Basic Edition 以上をご購入いただく必要があります。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    必須

    インスタンス ID。

    1234

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    RequestId

    string

    リクエスト ID。

    22C97E95-F023-56B5-8852-B1A77****
    TaskInstance

    object

    タスクインスタンスの詳細情報。

    TaskId

    integer

    このインスタンスが生成されたタスクの ID。

    1234
    TaskType

    string

    このインスタンスが生成されたタスクの種類。

    ODPS_SQL
    TaskName

    string

    このインスタンスが生成されたタスクの名前。

    SQL node

    Description

    string

    説明文。

    test
    WorkflowId

    integer

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

    1234
    WorkflowName

    string

    このインスタンスが属するワークフローの名前。

    Test workflow
    TriggerType

    string

    インスタンスのスケジューリングをトリガーする方法。これは、GetTask 操作の応答における Trigger.Type パラメーターの値と一致します。有効な値は以下のとおりです：

    • Scheduler

    • Manual

    Scheduler
    TriggerRecurrence

    string

    インスタンスがトリガーされた後の実行モード。このパラメーターは、TriggerType パラメーターが Scheduler に設定されている場合のみ有効です。有効な値は以下のとおりです：

    • Pause

    • Skip

    • Normal

    Normal
    WorkflowInstanceId

    integer

    ワークフローインスタンス ID。

    1234
    WorkflowInstanceType

    string

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

    • SmokeTest

    • SupplementData

    • Manual

    • ManualWorkflow

    • Normal

    • ManualFlow

    Normal
    UnifiedWorkflowInstanceId

    integer

    統合ワークフローインスタンス ID。同一のデータタイムスタンプでトリガーされたすべてのタスクインスタンスは、このフィールドの値が共通になります。

    1234
    Timeout

    integer

    タスク実行のタイムアウト期間（単位：秒）。

    注：このパラメーターの値は、時間単位で切り上げられます。

    3600
    RerunMode

    string

    再実行モード。有効な値は以下のとおりです：

    • AllDenied：タスクが正常終了したか失敗したかに関わらず、再実行できません。

    • AllAllowed：タスクが正常終了したか失敗したかに関わらず、再実行できます。

    • FailureAllowed：タスクが失敗した場合のみ、再実行できます。

    AllAllowed
    RunNumber

    integer

    インスタンスの実行回数。デフォルトでは、1 から開始します。

    1
    PeriodNumber

    integer

    サイクルのシーケンス番号。このパラメーターは、当日におけるタスクインスタンスのサイクルを示します。

    1
    BaselineId

    integer

    ベースライン ID。

    1234
    Priority

    integer

    タスクの優先度。有効な値は 1～8 です。数値が大きいほど優先度が高くなります。デフォルト値は 1 です。

    1
    Script

    object

    スクリプト情報。

    Content

    string

    スクリプトの内容。

    echo "helloWorld"
    Parameters

    string

    スクリプトのパラメーター。

    para1=$bizdate
    RuntimeResource

    object

    このインスタンスが関連付けられたリソースグループに関する情報。

    ResourceGroupId

    string

    タスク実行用に設定されたスケジューリング向けリソースグループの ID。

    S_res_group_524258031846018_1684XXXXXXXXX
    Image

    string

    タスク実行用に設定されたイメージの ID。

    i-xxxxxx
    Cu

    string

    タスク実行用に設定された CU のデフォルト数。

    0.25
    Runtime

    object

    インスタンスのランタイム情報。

    ProcessId

    string

    インスタンス実行 ID。

    T3_123
    Gateway

    string

    実行ホスト。

    cn-shanghai.1.2
    DataSource

    object

    関連付けられたデータソースに関する情報。

    Name

    string

    データソースの名前。

    mysql_test
    Inputs

    object

    入力情報。

    Variables

    array<object>

    変数。

    object

    Name

    string

    変数の名前。

    Key1
    Type

    string

    タイプ。有効な値は以下のとおりです：

    • Constant：定数

    • PassThrough：ノード出力

    • System：システム変数

    • NodeOutput：スクリプト出力

    Constant
    Value

    string

    変数の値。

    Value1
    Outputs

    object

    出力情報。

    TaskOutputs

    array<object>

    タスク出力。

    object

    Output

    string

    出力識別子。

    pre.odps_sql_demo_0
    Variables

    array<object>

    変数。

    object

    Name

    string

    変数の名前。

    key1
    Type

    string

    タイプ。有効な値は以下のとおりです：

    • Constant：定数

    • PassThrough：ノード出力

    • System：システム変数

    • NodeOutput：スクリプト出力

    Constant
    Value

    string

    変数の値。

    value1
    Tags

    array<object>

    タスクのタグ。

    object

    Key

    string

    タグキー。

    key1
    Value

    string

    タグ値。

    value1
    Status

    string

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

    • NotRun：インスタンスは未実行です。

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

    • WaitTime：インスタンスはスケジュール時刻の到着を待機しています。

    • CheckingCondition：インスタンスのブランチ条件を確認中です。

    • WaitResource：インスタンスはリソースの確保を待機しています。

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

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

    • Checking：インスタンスのデータ品質を確認中です。

    Success
    TriggerTime

    integer

    スケジュール時刻。

    1710239005403
    Bizdate

    integer

    データタイムスタンプ。

    1710239005403
    StartedTime

    integer

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

    1710239005403
    FinishedTime

    integer

    インスタンスの実行終了時刻。

    1710239005403
    Id

    integer

    インスタンス ID。

    1234
    ProjectId

    integer

    ワークスペース ID。

    100
    ProjectEnv

    string

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

    • Prod：本番環境

    • Dev：開発環境

    Prod
    Owner

    string

    タスク所有者のアカウント ID。

    1000
    CreateTime

    integer

    作成時刻。

    1710239005403
    ModifyTime

    integer

    更新時刻。

    1710239005403
    CreateUser

    string

    作成者のアカウント ID。

    1000
    ModifyUser

    string

    更新者のアカウント ID。

    1000
    WaitingResourceTime

    integer

    リソース確保待ちを開始したタイムスタンプ。

    1710239005403
    WaitingTriggerTime

    integer

    スケジュール時刻待ちを開始したタイムスタンプ。

    1710239005403

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Status": "Success",
    "TriggerTime": 1710239005403,
    "Bizdate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403
  }
}

    エラーコード

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

    変更履歴

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