ListPipelineJobs - 按任务分类获取流水线执行的任务_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 按任务分类获取流水线执行的任务。

适用版本

标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID 。
产品
资源
所需权限
产品
资源
所需权限
流水线
流水线
只读

请求语法

GET https://{domain}/oapi/v1/flow/organizations/{organizationId}/pipelines/{pipelineId}/listTasksByCategory/{category}

请求头

参数	类型	是否必填	描述	示例值

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	企业 Id。	5ebbc0228123212b59xxxxx
pipelineId	string	path	是	流水线 id。	123
category	string	path	是	任务分类，暂只支持 DEPLOY。	DEPLOY

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/pipelines/123/listTasksByCategory/DEPLOY' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值

参数	类型	描述	示例值
-	array
-	object
identifier	string	任务标识。	ss_saxsxsxs
jobName	string	任务名称。	任务名称
lastJobId	integer	最后运行的任务 id。	123
lastJobParams	string	最后运行的任务的参数。	{}

返回示例

[
    {
        "identifier": "ss_saxsxsxs",
        "jobName": "任务名称",
        "lastJobId": 123,
        "lastJobParams": "{}"
    }
]

错误码

访问错误码中心查看 API 相关错误码。

产品	资源	所需权限
流水线	流水线	只读