通過ListPipelineRuns API查詢工作流程工作清單-人工智慧平台 PAI-阿里雲

擷取工作流程工作清單，支援過濾、排序和分頁查詢。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

paiflow:ListPipelineRuns

list

*全部資源

*

無

請求文法

GET /api/v1/pipelineruns HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	工作流程工作清單的頁碼。起始值為 1，預設為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁顯示的工作流程工作數量，預設為 10。	10
SourceId	string	否	工作流程工作來源 ID。請在工作流程詳情頁面查看工作流程工作來源 ID，詳情請參見管理工作流程。	ybpy**********fb2z
Name	string	否	工作流程工作名稱。	testName
Order	string	否	排序的順序，取值如下，與 SortBy 一起使用。 ASC：升序。 DESC（預設值）：降序。	DESC
SourceType	string	否	工作流程工作來源類型，支援如下值： UNKNOWN（預設）：未指定來源類型時的預設值。 SDK：通過 SDK 建立的工作流程工作。 DESIGNER：通過 Designer 建立的工作流程工作。 M6：通過其他網站建立的工作流程工作。	UNKNOWN
Status	string	否	需要過濾的工作流程工作的狀態，目前有如下幾種狀態： Initialized Running Succeeded Failed Terminated Unknown Skipped Terminating	Succeeded
WorkspaceId	string	否	工作空間 ID。如何擷取工作空間 ID，請參見 ListWorkspaces 。	104623
UserId	string	否	使用者識別碼。	155**********904
PipelineIds	string	否	工作流程的 ID 集合，多個工作流程 ID 使用半形逗號（,）分隔。如何擷取工作流程 ID，請參見 ListPipelines 。	flow-rer7********0otv, flow-hynm********sfef
SortBy	string	否	用於排序的欄位。目前有如下欄位支援用於排序： PipelineId UserId ParentUserId StartedAt FinishedAt WorkflowServiceId Duration GmtCreateTime GmtModifiedTime	PipelineId
PipelineRunId	string	否	工作流程工作 ID，如何擷取工作流程工作 ID，請參見 ListPipelineRuns 。	flow-14vioac3k1s07k****

返回參數

名稱	類型	描述	樣本值
	object	返回結構體。
RequestId	string	請求 ID。	473469C7-**--**-A3DC0DE3C83E
TotalCount	integer	返回的工作流程工作總量。	15
PipelineRuns	array<object>	返回的工作流程工作清單。
	object	工作流程工作的詳情。
PipelineRunId	string	工作流程工作 ID。	flow-j94y**********lf7a
Name	string	工作流程工作名字。	testName
Status	string	工作流程工作狀態，目前有下面幾種狀態： Initialized Running Succeeded Failed Suspended Terminated Unknown Skipped Terminating	Succeeded
UserId	string	建立使用者識別碼。	155**********904
ParentUserId	string	建立使用者主賬戶的 ID。	155**********904
StartedAt	string	工作流程工作的開始 UTC 時間，格式 iso8601。	2021-01-30T12:51:33.028Z
FinishedAt	string	工作流程工作的結束 UTC 時間，格式 iso8601。	2021-01-30T12:52:33.028Z
NodeId	string	工作流程工作的節點 ID。	node-n06d**********fc53
Duration	integer	工作流程工作的運行時間長度，單位為秒。	60
WorkspaceId	string	所屬工作空間 ID。	15945
Message	string	工作流程工作失敗提示資訊。	error message
SourceType	string	工作流程工作來源類型，支援如下值： UNKNOWN SDK DESIGNER M6	UNKNOWN
SourceId	string	工作流程工作的來源 ID。	abcd*********hxfu
GmtCreateTime	string	建立 UTC 時間，格式 iso8601。	2021-01-30T12:51:33.028Z
GmtModifiedTime	string	最近修改 UTC 時間，格式 iso8601。	2021-01-30T12:51:33.028Z
PipelineId	string	工作流程 ID。	pipeline-j94y**********lf7a
Accessibility	string	工作流程工作的可見度，目前支援： PUBLIC PRIVATE	PUBLIC
PipelineRunUri	string	工作流程工作詳情 URL。	https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24**#/studio/task/detail/flow-dsfbjt4k07lvp1**

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E",
  "TotalCount": 15,
  "PipelineRuns": [
    {
      "PipelineRunId": "flow-j94y**********lf7a\n",
      "Name": "testName\n",
      "Status": "Succeeded",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "StartedAt": "2021-01-30T12:51:33.028Z\n",
      "FinishedAt": "2021-01-30T12:52:33.028Z\n",
      "NodeId": "node-n06d**********fc53\n",
      "Duration": 60,
      "WorkspaceId": "15945",
      "Message": "error message\n",
      "SourceType": "UNKNOWN",
      "SourceId": "abcd*********hxfu\n",
      "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
      "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
      "PipelineId": "pipeline-j94y**********lf7a\n",
      "Accessibility": "PUBLIC",
      "PipelineRunUri": "https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
    }
  ]
}

錯誤碼

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

變更歷史

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