可以获取流水线运行任务的日志信息,便于进一步查看任务下步骤的日志。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetPipelineLog | 系统规定参数。取值:GetPipelineLog。 |
JobId | Long | 是 | 123 | 任务ID |
OrgId | String | 是 | 5ebbc0228123212b59xxxxx | 企业标识,也称企业ID,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrgId】 |
PipelineId | Long | 是 | 123 | 流水线ID,可在流水线链接中获取,如 https://flow.aliyun.com/pipelines/【PipelineId】/current |
UserPk | String | 否 | 123 | 用户pk,非必填,只有调用接口使用的ak和用户pk不一致时,才需要 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | ”“ | 错误码 |
ErrorMessage | String | ”“ | 错误信息 |
Object | Array of job | 步骤数据 |
|
ActionName | String | 构建 | 任务名称 |
BuildProcessNodes | Array of buildProcessNode | 节点数据 |
|
NodeIndex | Integer | 1 | 节点顺序 |
NodeName | String | 执行命令 | 节点名称 |
Status | String | success | 节点状态 fail 失败 running 运行中 success 成功 ready 等待执行 |
JobId | Long | 123 | 任务id |
StartTime | String | 2020-07-29 11:15:31.0 | 任务开始时间 |
RequestId | String | ASSDS-ASSASX-XSAXSA-XSAXSAXS | 请求id,每次请求都是唯一值,便于后续排查问题 |
Success | Boolean | true | true 接口调用成功,false 接口调用失败 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetPipelineLog
&JobId=123
&OrgId=5ebbc0228123212b59xxxxx
&PipelineId=123
&<公共请求参数>
正常返回示例
JSON
格式
{"RequestId":"ASSDS-ASSASX-XSAXSA-XSAXSAXS","Object":[{"ActionName":"构建","StartTime":"2020-07-29 11:15:31.0","JobId":"123","BuildProcessNodes":[{"Status":"success","NodeName":"执行命令","NodeIndex":"1"}]}],"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. | 企业信息有误,未找到该企业 |
访问错误中心查看更多错误码。