ListPipelineJobs - 按任务分类获取流水线执行的任务

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

调试

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

授权信息

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

请求语法

POST /organization/{organizationId}/pipeline/{pipelineId}/jobs

请求参数

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

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

5ebbc0228123212b59xxxxx
pipelineIdstring

流水线 id

1111
categorystring

任务分类,暂只支持 DEPLOY

DEPLOY

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessagestring

错误信息

”“
successboolean

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

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

错误码

”“
jobsarray<object>

流水线执行任务

object

流水线执行任务

jobNamestring

任务名称

任务名称
identifierstring

任务的标识

ss_saxsxsxs
lastJobIdlong

最后运行的任务 id

123
lastJobParamsstring

最后运行的任务的参数

{}

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "”“",
  "success": true,
  "errorCode": "”“",
  "jobs": [
    {
      "jobName": "任务名称",
      "identifier": "ss_saxsxsxs",
      "lastJobId": 123,
      "lastJobParams": "{}"
    }
  ]
}

错误码

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.工作空间不存在

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

变更历史

变更时间变更内容概要操作
暂无变更历史