使用CreatePipeline API创建YAML流水线-云效-阿里云-云效(Alibaba Cloud DevOps)-阿里云帮助中心

调试

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

授权信息

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

请求语法

POST /organization/{organizationId}/pipelines HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx

请求参数

名称	类型	必填	描述	示例值
name	string	是	流水线名称	示例流水线
content	string	是	流水线 YAML 描述，可参考文档 https://help.aliyun.com/document_detail/2249317.html 编写	sources: # sources 配置流水线源节点 my_repo: # 流水线源唯一标识 id type: codeup # 流水线源类型 name: 代码源名称 # 代码源的展示名称 endpoint: # 代码源的 url branch: master # 代码源的默认分支 triggerEvents: push # 代码源监听事件 certificate: # certificate 认证信息 type: serviceConnection # 认证类型为服务连接 serviceConnection: # 服务连接 id stages: # stages 配置流水线阶段 build_stage: # 流水线阶段标识 id name: 构建阶段 # 流水线阶段的展示名称 jobs: # jobs 配置流水线任务 build_job: # 流水线任务标识 id name: 构建任务 # 流水线任务的展示名称 runsOn: public/cn-beijing # 流水线任务运行的集群环境 steps: # steps 配置流水线步骤 build_step: # 流水线步骤标识 id step: JavaBuild # 选择执行步骤 name: java构建 # 流水线执行步骤的展示名称 with: # 步骤的参数 run: \| mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip upload_step: step: ArtifactUpload name: 构建物上传 with: uploadType: flowPublic artifact: default filePath: - target/ - deploy.sh deploy_stage: name: 部署阶段 jobs: deploy_job: name: 主机组部署任务 component: VMDeploy # 选择执行组件 with: # 执行组件的参数 artifact: $[stages.build_stage.build_job.upload_step.artifacts.default] machineGroup: artifactDownloadPath: /home/admin/app/package.tgz executeUser: root run: \| mkdir -p /home/admin/application/ tar zxvf /home/admin/app/package.tgz -C /home/admin/application/ sh /home/admin/application/deploy.sh restart

返回参数

名称	类型	描述	示例值
	object	Schema of Response
success	boolean	true 接口调用成功，false 接口调用失败	true
errorCode	string	错误码	""
errorMessage	string	错误信息	""
pipelinId	integer	流水线 id	11XXX
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS

示例

正常返回示例

JSON格式

{
  "success": true,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pipelinId": 0,
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS\n"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParam.ParamNotPresent	The parameter is invalid.	参数有误，请检查参数
400	InvalidUser.NotFound	The user that is invoking the API service is not a registered user.	调用 API 的用户，未注册为云效用户
403	Forbidden.AccessDenied	The user is not authorized to perform the operation.	用户无权限执行相关操作
403	Forbidden.UserNotAdminOrOwner	The current user is not an admin or owner in the organization and is not authorized to perform the operation.	当前用户非该企业管理员或拥有者，无权进行操作。
403	Forbidden.UserNotInCurrentOrganization	The user is not in the organization and is not authorized to perform the operation.	当前用户不在该企业中，无权进行操作。
404	InvalidOrganization.NotFound	The organization is not found.	企业不存在，请检查企业ID是否正确
404	InvalidPipeline.NotFound	The pipeline is not found.	流水线不存在
404	InvalidPipelineRun.NotFound	The pipeline execution instance is not found.	流水线运行实例不存在

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

变更历史

更多信息，参考变更详情。