可以根据流水线构建号,获取流水线的运行状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetPipelineInstanceBuildNumberStatus | 系统规定参数。取值:GetPipelineInstanceBuildNumberStatus。 |
OrgId | String | 是 | 5ebbc0228123212b59xxxxx | 企业标识,也称企业ID,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrgId】 |
PipelineId | Long | 是 | 1234 | 流水线ID,可在流水线链接中获取,如 https://flow.aliyun.com/pipelines/【PipelineId】/current |
UserPk | String | 否 | 1234354314543321 | 用户pk,非必填,只有调用接口使用的ak和用户pk不一致时,才需要 |
BuildNum | Long | 否 | 123 | 构建号,详情页可查看 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | "" | 错误码 |
ErrorMessage | String | "" | 错误信息 |
Object | Struct | 实例信息 |
|
Groups | Array of group | 分组 |
|
Name | String | JAVA构建 | 分组名称 |
Stages | Array of stage | 阶段 |
|
Components | Array of component | 任务 |
|
JobId | Long | 1234 | 任务id |
Name | String | JAVA构建 | 任务名称 |
Status | String | SUCCESS | 任务状态 FINISH 运行完成 RUNNING 运行中 CANCELED 已取消 WAITING 等待中 INIT 未开始 SUCCESS 成功 |
Sign | String | Group1-Stage1 | 阶段标识 |
Status | String | SUCCESS | 阶段状态 FINISH 运行完成 RUNNING 运行中 CANCELED 已取消 WAITING 等待中 INIT 未开始 SUCCESS 成功 |
Status | String | SUCCESS | 分组状态 FINISH 运行完成 RUNNING 运行中 CANCELED 已取消 WAITING 等待中 INIT 未开始 SUCCESS 成功 |
Status | String | SUCCESS | 流水线运行状态 FAIL 失败 SUCCESS 成功 RUNNING 运行中 CANCELED 已取消 |
RequestId | String | ASSDS-ASSASX-XSAXSA-XSAXSAXS | 请求id,每次请求都是唯一值,便于后续排查问题 |
Success | Boolean | true | true 接口调用成功,false 接口调用失败 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetPipelineInstanceBuildNumberStatus
&OrgId=5ebbc0228123212b59xxxxx
&PipelineId=1234
&<公共请求参数>
正常返回示例
JSON
格式
{"RequestId":"ASSDS-ASSASX-XSAXSA-XSAXSAXS","Object":{"Status":"SUCCESS","Groups":[{"Status":"SUCCESS","Name":"JAVA构建","Stages":[{"Status":"SUCCESS","Sign":"Group1-Stage1","Components":[{"Status":"SUCCESS","JobId":"1234","Name":"JAVA构建"}]}]}]},"ErrorCode":"\"\"","ErrorMessage":"\"\"","Success":"true"}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidPipeline.NotFound | The specified pipeline does not exist. | 未找到流水线 |
404 | InvalidUser.NotFound | The specified user does not exist. | 用户数据有误,未找到该用户 |
400 | InvalidUser.UserNotInCurrentOrganization | The user does not belong to the specified organization. | 当前用户不属于该企业 |
500 | SystemError.UnKnownError | An error occurred while processing your request. | 系统未知异常 |
404 | InvalidOrganization.NotFound | The specified organization doe not exist. | 企业信息有误,未找到该企业 |
访问错误中心查看更多错误码。