Use OpenAPI to list pipelines.
Endpoint and authorization information
Obtain the endpoint: Replace {domain} in the API request syntax.
Product | Resource | Required permission |
Pipeline | Pipeline | Read-only |
Request syntax
GET https://{domain}/oapi/v1/flow/organizations/pipelinesRequest headers
Parameter | Type | Required | Description | Example value |
x-yunxiao-token | string | Yes | Your personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Location | Required | Description | Example value |
createStartTime | integer | query | No | The start time of pipeline creation. | 1729178040000 |
createEndTime | integer | query | No | The end time of pipeline creation. | 1729178040000 |
executeStartTime | integer | query | No | The start time of pipeline execution. | 1729178040000 |
executeEndTime | integer | query | No | The end time of pipeline execution. | 1729178040000 |
pipelineName | string | query | No | The pipeline name. | Pipeline A |
statusList | string | query | No | The pipeline status. Separate multiple values with commas. Valid values: SUCCESS, RUNNING, FAIL, CANCELED, WAITING. | RUNNING,SUCCESS |
perPage | integer | query | No | The number of items per page. Default is 10. Maximum is 30. | 10 |
page | integer | query | No | The current page number. Default is 1. | 1 |
Sample requests
curl -X 'GET' \
'https://{domain}/oapi/v1/flow/organizations/pipelines?createStartTime=1729178040000&createEndTime=1729178040000&executeStartTime=1729178040000&executeEndTime=1729178040000&pipelineName=Pipeline%20A&statusList=RUNNING,SUCCESS&perPage=10&page=1' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example value |
| - | array | ||
| - | object | ||
createAccountId | string | Creator | 22121222 |
createTime | integer | The time when the pipeline was created. | 1729178040000 |
pipelineId | integer | The pipeline ID. | 124 |
pipelineName | string | The pipeline name. | Pipeline |
Sample response
[
{
"createAccountId": "22121222",
"createTime": 1729178040000,
"pipelineId": 124,
"pipelineName": "Pipeline"
}
]Response headers
Parameter | Description | Example value |
x-next-page | Go to the next page. | 3 |
x-page | The current page number. | 2 |
x-per-page | The number of items per page. | 10 |
x-prev-page | Previous | 1 |
x-total | Total data volume. | 100 |
x-total-pages | The total number of pages. | 10 |
Error codes
For more information, see the error code center.