全部產品
Search

搜尋本產品

    ：GetWorkflow - 擷取工作流程的詳情

    文件中心

    ：GetWorkflow - 擷取工作流程的詳情

    更新時間：Mar 21, 2026

    擷取指定的工作流程的詳細資料。

    介面說明

    需要購買 DataWorks 基礎版及以上版本才能使用。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Id

    integer

    是

    工作流程的唯一識別碼。

    1234
    EnvType

    string

    否

    專案環境。

    • Prod：生產

    • Dev：開發

    Prod

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求的 ID。用於定位日誌，排查問題。

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

    object

    工作流程的詳細資料。

    Id

    integer

    工作流程的唯一識別碼。

    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：跨周期依賴一級子節點

    • CrossCycleDependsOnSelf：跨周期依賴自己

    • CrossCycleDependsOnOtherNode：跨周期依賴其他節點

    • Normal：同周期依賴

    Normal
    UpstreamOutput

    string

    上遊任務的輸出標識符。（同周期依賴且設定 input 內容時，返回此欄位）

    pre.odps_sql_demo_0
    UpstreamTaskId

    integer

    上遊任務的 Id。（跨周期依賴其他節點與同周期依賴未設定 input 內容時，返回此欄位，其他情況不返回）

    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

    重試次數，當任務設定為可重跑時生效。

    3
    RerunInterval

    integer

    重試時間間隔，單位秒。

    60
    RuntimeResource

    object

    運行環境配置，如資源群組資訊。

    ResourceGroupId

    string

    任務回合組態的調度資源群組標識符。

    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

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。