すべてのプロダクト
Search

このプロダクト

    :GetWorkflow

    ドキュメントセンター

    :GetWorkflow

    最終更新日:Mar 21, 2026

    ワークフローの情報を照会します。

    操作説明

    この API オペレーションは、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:*

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    必須

    ワークフロー ID。

    1234
    EnvType

    string

    任意

    ワークスペースの環境。有効な値：

    • Prod：本番環境

    • Dev：開発環境

    Prod

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    22C97E95-F023-56B5-8852-B1A77A17XXXX
    Workflow

    object

    ワークフローの情報。

    Id

    integer

    ワークフロー ID。

    1234
    ProjectId

    integer

    ワークスペース ID。

    100
    EnvType

    string

    ワークスペースの環境。有効な値：

    • Prod：本番環境

    • Dev：開発環境

    Prod
    Owner

    string

    ワークフロー所有者のアカウント ID。

    1000
    Name

    string

    ワークフローの名前。

    Workflow
    Description

    string

    ワークフローの説明。

    Test workflow
    Trigger

    object

    トリガー方式。

    Type

    string

    トリガーの種類。有効な値：

    • Scheduler：スケジュール周期に基づくトリガー

    • Manual：手動トリガー

    Scheduler
    Recurrence

    string

    トリガー後のワークフローの実行モード。このパラメーターは、Type パラメーターが Scheduler に設定されている場合のみ有効です。有効な値：

    • Pause

    • Skip

    • Normal

    Normal
    Cron

    string

    CRON 式。このパラメーターは、Type パラメーターが Scheduler に設定されている場合のみ有効です。

    00 00 00 * * ?
    StartTime

    string

    ワークフローが定期的にスケジュールされる期間の開始時刻。このパラメーターは、Type パラメーターが Scheduler に設定されている場合のみ有効です。

    1970-01-01 00:00:00
    EndTime

    string

    ワークフローが定期的にスケジュールされる期間の終了時刻。このパラメーターは、Type パラメーターが Scheduler に設定されている場合のみ有効です。

    1970-01-01 00:00:00
    Dependencies

    array<object>

    依存関係の情報。

    object

    Type

    string

    スケジューリング依存関係の種類。有効な値：

    • CrossCycleDependsOnChildren：ノードのレベル 1 子孫ノードに対するクロスサイクル依存

    • CrossCycleDependsOnSelf：現在のノードに対するクロスサイクル依存

    • CrossCycleDependsOnOtherNode：他のノードに対するクロスサイクル依存

    • Normal：同一サイクル内のスケジューリング依存

    Normal
    UpstreamOutput

    string

    祖先タスクの出力識別子。このパラメーターは、同一サイクル内のスケジューリング依存 およびノード入力が設定されている場合にのみ返されます。

    pre.odps_sql_demo_0
    UpstreamTaskId

    integer

    祖先タスク ID。このパラメーターは、クロスサイクル依存関係 または 同一サイクル内のスケジューリング依存 およびノード入力が設定されていない場合にのみ返されます。

    1234
    Parameters

    string

    パラメーター。

    para1=$bizdate para2=$[yyyymmdd]

    Tasks

    array<object>

    タスク。

    array<object>

    Id

    integer

    タスク ID。

    1234
    ProjectId

    integer

    ワークスペース ID。

    100
    EnvType

    string

    ワークスペースの環境。有効な値：

    • Prod

    • Dev

    Prod
    Owner

    string

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

    1000
    Name

    string

    タスクの名前。

    SQL node
    Description

    string

    タスクの説明。

    Test
    WorkflowId

    integer

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

    1234
    Type

    string

    タスクの種類。

    ODPS_SQL
    BaselineId

    integer

    ベースライン ID。

    1234
    Priority

    integer

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

    1
    Timeout

    integer

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

    3600
    RerunMode

    string

    再実行モード。有効な値：

    • AllDenied：タスクが成功した場合でも失敗した場合でも、再実行できません。

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

    • AllAllowed：タスクが成功した場合でも失敗した場合でも、再実行できます。

    AllAllowed
    RerunTimes

    integer

    タスクの再実行回数。このパラメーターは、RerunMode パラメーターが AllAllowed または FailureAllowed に設定されている場合にのみ有効です。

    3
    RerunInterval

    integer

    再実行間隔。単位：秒。

    60
    RuntimeResource

    object

    実行環境の構成（例：リソースグループ情報）。

    ResourceGroupId

    string

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

    S_res_group_524258031846018_1684XXXXXXXXX
    Image

    string

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

    i-xxxxxx
    Cu

    string

    タスク実行用に設定された計算ユニット (CU) のデフォルト数。

    0.25
    DataSource

    object

    関連付けられたデータソースの情報。

    Name

    string

    データソースの名前。

    mysql_test
    CreateTime

    integer

    作成時刻。

    1710239005403
    ModifyTime

    integer

    更新時刻。

    1710239005403
    CreateUser

    string

    作成者のアカウント ID。

    1000
    ModifyUser

    string

    更新者のアカウント ID。

    1000
    TriggerRecurrence

    string

    トリガー後のタスクの実行モード。有効な値：

    • Pause

    • Skip

    • Normal

    Normal
    ClientUniqueCode

    string

    クライアントの一意コード。このパラメーターは、非同期でタスクを作成し、タスクのべき等性を実現するために使用されます。タスク作成時にこのパラメーターを指定しない場合、システムが自動的に一意コードを生成します。この一意コードはタスク ID と一意に紐付けられます。タスクの更新または削除時にこのパラメーターを指定する場合は、タスク作成時に使用した一意コードを指定する必要があります。

    Task_0bc5213917368545132902xxxxxxxx
    Outputs

    object

    出力情報。

    TaskOutputs

    array<object>

    タスクの出力。

    object

    Output

    string

    出力の識別子。

    pre.odps_sql_demo_0
    Tags

    array<object>

    タグ。

    object

    Key

    string

    タグキー。

    key1
    Value

    string

    タグ値。

    value1
    CreateTime

    integer

    作成時刻。

    1710239005403
    ModifyTime

    integer

    更新時刻。

    1710239005403
    CreateUser

    string

    作成者のアカウント ID。

    1000
    ModifyUser

    string

    更新者のアカウント ID。

    1000
    ClientUniqueCode

    string

    クライアントの一意コード。このパラメーターは、非同期でワークフローを作成し、ワークフローのべき等性を実現するために使用されます。ワークフロー作成時にこのパラメーターを指定しない場合、システムが自動的に一意コードを生成します。この一意コードはワークフロー ID と一意に紐付けられます。ワークフローの更新または削除時にこのパラメーターを指定する場合は、ワークフロー作成時に使用した一意コードを指定する必要があります。

    Workflow_0bc5213917368545132902xxxxxxxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Workflow": {
    "Id": 1234,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "Name": "Workflow",
    "Description": "Test workflow",
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "1970-01-01 00:00:00"
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": 1234
      }
    ],
    "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
    "Tasks": [
      {
        "Id": 1234,
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "Name": "SQL node",
        "Description": "Test",
        "WorkflowId": 1234,
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "TriggerRecurrence": "Normal",
        "ClientUniqueCode": "Task_0bc5213917368545132902xxxxxxxx"
      }
    ],
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx"
  }
}

    エラーコード

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

    変更履歴

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