通過 OpenAPI 擷取流水線列表。
服務存取點與授權資訊
產品 | 資源 | 要求的權限 |
流水線 | 流水線 | 唯讀 |
請求文法
GET https://{domain}/oapi/v1/flow/organizations/pipelines要求標頭
參數 | 類型 | 是否必填 | 描述 | 樣本值 |
x-yunxiao-token | string | 是 | 個人存取權杖。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 樣本值 |
createStartTime | integer | query | 否 | 建立開始時間。 | 1729178040000 |
createEndTime | integer | query | 否 | 建立結束時間。 | 1729178040000 |
executeStartTime | integer | query | 否 | 執行開始時間。 | 1729178040000 |
executeEndTime | integer | query | 否 | 執行結束時間。 | 1729178040000 |
pipelineName | string | query | 否 | 流水線名稱。 | 流水線 A |
statusList | string | query | 否 | 流水線運行狀態,多個逗號分割,SUCCESS,RUNNING,FAIL,CANCELED,WAITING。 | RUNNING,SUCCESS |
perPage | integer | query | 否 | 每頁資料條數,預設10,最大支援30。 | 10 |
page | integer | query | 否 | 當前頁,預設1。 | 1 |
請求樣本
curl -X 'GET' \
'https://{domain}/oapi/v1/flow/organizations/pipelines?createStartTime=1729178040000&createEndTime=1729178040000&executeStartTime=1729178040000&executeEndTime=1729178040000&pipelineName=流水線A&statusList=RUNNING,SUCCESS&perPage=10&page=1' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回參數
參數 | 類型 | 描述 | 樣本值 |
| - | array | ||
| - | object | ||
createAccountId | string | 建立人。 | 22121222 |
createTime | integer | 建立時間。 | 1729178040000 |
pipelineId | integer | 流水線 Id。 | 124 |
pipelineName | string | 流水線名稱。 | 流水線 |
返回樣本
[
{
"createAccountId": "22121222",
"createTime": 1729178040000,
"pipelineId": 124,
"pipelineName": "流水線"
}
]回應標頭
參數 | 描述 | 樣本值 |
x-next-page | 下一頁。 | 3 |
x-page | 當前頁。 | 2 |
x-per-page | 每頁資料條數。 | 10 |
x-prev-page | 上一頁。 | 1 |
x-total | 總資料量。 | 100 |
x-total-pages | 總分頁數。 | 10 |
錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。