文档

ListPipelineJobHistorys - 获取流水线任务的执行历史

更新时间:

获取流水线任务的执行历史。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /organization/{organizationId}/pipeline/{pipelineId}/job/historys

请求参数

名称类型必填描述示例值
organizationIdstring

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

5ebbc0228123212b59xxxxx
pipelineIdstring

流水线 Id

123
categorystring

任务分类,暂时只支持 DEPLOY

DEPLOY
identifierstring

任务标识

10_ssasasa
nextTokenstring

下一页 token

xsaxsa
maxResultslong

每页最大数据,最多支持 50

10

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessagestring

错误信息

”“
successboolean

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

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

错误码

”“
jobsobject []

任务列表

jobNamestring

任务名称

任务名称
identifierstring

任务标识

10_xaxxsxa
pipelineIdlong

流水线 id

123
executeNumberinteger

任务第几次执行

1
jobIdlong

任务 id

123
pipelineRunIdlong

流水线运行实例 id

123
sourcesstring

任务运行的代码源信息

{}
statusstring

任务执行状态

SUCCESS
operatorAccountIdstring

运行人 aliyunPK

ssaasssa
nextTokenstring

下一页 token

xsxxs
totalCountinteger

任务总数

20

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "”“",
  "success": true,
  "errorCode": "”“",
  "jobs": [
    {
      "jobName": "任务名称",
      "identifier": "10_xaxxsxa",
      "pipelineId": 123,
      "executeNumber": 1,
      "jobId": 123,
      "pipelineRunId": 123,
      "sources": "{}",
      "status": "SUCCESS",
      "operatorAccountId": "ssaasssa"
    }
  ],
  "nextToken": "xsxxs",
  "totalCount": 20
}

错误码

HTTP status code错误码错误信息描述
400InvalidCluster.NotFoundNo cluster is available to generate the workspace.没有可用的集群,无法创建工作空间
400InvalidCodeUrl.NotSupportSVNThe parameter codeUrl is invalid. SVN is not supported.参数错误,不支持svn
400InvalidParam.ParamNotPresentThe parameter is invalid.参数有误,请检查参数
400InvalidResource.NotFoundNo resource is found. You cannot create the workspace. Please try again later.没有资源,无法创建工作空间,请稍后尝试
400InvalidResourceRole.NotFounThe member role is invalid.无效的成员角色,请检查参数
400InvalidResourceRole.NotFoundThe member role is invalid.无效的成员角色,请检查参数
400InvalidUser.NotFoundThe user that is invoking the API service is not a registered user.调用 API 的用户,未注册为云效用户
400InvalidUser.ResourceMemberCouldNotDeleteOwnerResource owner cannot be deleted.无法删除资源owner
400InvalidUser.ResourceMemberNotExistsThe resource member does not exist.该资源成员不存在,请检查参数
400InvalidUser.UserNotInCurrentOrganizationThe user is not in the organization.当前用户不在该企业中
403Forbidden.AccessDeniedThe user is not authorized to perform the operation.用户无权限执行相关操作
403Forbidden.UserNotAdminOrOwnerThe current user is not an admin or owner in the organization and is not authorized to perform the operation.当前用户非该企业管理员或拥有者,无权进行操作。
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。
404InvalidIdentifier.NotFoundspace id is error or not exist.数据不存在
404InvalidOrganization.NotFoundThe organization is not found.企业不存在,请检查企业ID是否正确
404InvalidPipeline.NotFoundThe pipeline is not found.流水线不存在
404InvalidPipelineRun.NotFoundThe pipeline execution instance is not found.流水线运行实例不存在
404InvalidUser.UserNotInCurrentOrganizationThe current user is not in the organization and has no permission to operate.当前用户不在该企业中,无权进行操作。
404InvalidWorkspace.NotFoundThe workspace is not found.工作空间不存在

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)