Gets a list of pipelines.
Prerequisites
Replace <domain> in your API request URL with the endpoint that you obtain. For more information, see Endpoint.
Obtain your access token. For more information, see Obtain an access token.
Authorization information
Application | Resource | Required permission |
Flow | Pipelines | Read-only |
Request syntax
GET https://{domain}/oapi/v1/flow/organizations/pipelinesRequest headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | The access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Location | Required | Description | Example |
createStartTime | integer | query | No | Creation start time. | 1729178040000 |
createEndTime | integer | query | No | Creation end Time. | 1729178040000 |
executeStartTime | integer | query | No | Execution start time. | 1729178040000 |
executeEndTime | integer | query | No | Execution end time. | 1729178040000 |
pipelineName | string | query | No | Pipeline name. | Pipeline A |
statusList | string | query | No | Pipeline status. Separate multiple values by commas (,). Valid values:
| RUNNING,SUCCESS |
perPage | integer | query | No | Number of entries per page. Default value: 10. Maximum value: 30. | 10 |
page | integer | query | No | Current page. Default value: 1. | 1 |
Sample request
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/flow/organizations/pipelines?createStartTime=1729178040000&createEndTime=1729178040000&executeStartTime=1729178040000&executeEndTime=1729178040000&pipelineName=Pipeline A&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 |
- | array | ||
- | object | ||
createAccountId | string | Creator. | 22121222 |
createTime | integer | Creation time. | 1729178040000 |
pipelineId | integer | Pipeline ID. | 124 |
pipelineName | string | Pipeline name. | Pipeline |
Sample success response
[
{
"createAccountId": "22121222",
"createTime": 1729178040000,
"pipelineId": 124,
"pipelineName": "Pipeline"
}
]Response headers
Parameter | Description | Example |
x-next-page | Next page. | 3 |
x-page | Current page. | 2 |
x-per-page | Number of data per page. | 10 |
x-prev-page | Previous page. | 1 |
x-total | Total data volume. | 100 |
x-total-pages | Total number of pages. | 10 |
Error codes
For a list of error codes, see Service error codes.