可以获取流水线运行步骤的日志,例如查看java构建的日志。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetPipelineStepLog

系统规定参数。取值:GetPipelineStepLog

OrgId String 5ebbc0228123212b59xxxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrgId】

PipelineId Long 12xx

流水线ID,可在流水线链接中获取,如https://flow.aliyun.com/pipelines/【PipelineId】/current

UserPk String 325654xxxxxx

用户pk,非必填,只有调用接口使用的ak和用户pk不一致时,才需要

JobId Long 123x

任务id

StepIndex String 1

步骤索引(对应节点顺)

Offset Long 1

日志偏移量,从0 开始

Limit Long 2000

单次获取日志大小,最大值为2000

返回数据

名称 类型 示例值 描述
RequestId String ASSDS-ASSASX-XSxxxxxxx-xxxx

请求id,每次请求都是唯一值,便于后续排查问题

ErrorMessage String ""

错误信息

Success Boolean true

true 接口调用成功,false 接口调用失败

ErrorCode String ""

错误码

Object Object

日志对象

Last Integer -1

下一次读取日志的偏移量(-1则表示没有更多日志了)

More Boolean false

是否还有更多日志

Logs String log

日志内容

示例

请求示例

http(s)://[Endpoint]/?Action=GetPipelineStepLog
&OrgId=5ebbc0228123212b59xxxxx
&UserPk=325654xxxxxx
&StepIndex=1
&Offset=1
&Limit=2000
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetPipelineStepLogResponse>
    <RequestId>ASSDS-ASSASX-XSxxxxxxx-xxxx</RequestId>
    <ErrorMessage>""</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>""</ErrorCode>
    <Object>
        <Last>-1</Last>
        <More>false</More>
        <Logs>log</Logs>
    </Object>
</GetPipelineStepLogResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "ASSDS-ASSASX-XSxxxxxxx-xxxx",
  "ErrorMessage" : "\"\"",
  "Success" : true,
  "ErrorCode" : "\"\"",
  "Object" : {
    "Last" : -1,
    "More" : false,
    "Logs" : "log"
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidUser.UserNotInCurrentOrganization The user does not belong to the specified organization. 当前用户不属于该企业
404 InvalidPipeline.NotFound The specified pipeline does not exist. 未找到流水线
404 InvalidUser.NotFound The specified user does not exist. 用户数据有误,未找到该用户
404 InvalidOrganization.NotFound The specified organization doe not exist. 企业信息有误,未找到该企业
500 SystemError.UnKnownError An error occurred while processing your request. 系统未知异常

访问错误中心查看更多错误码。