CreatePipeline_云效2020_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求语法

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

路径参数

字段名称	字段详情
organizationIdstring	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】示例值:5ebbc0228123212b59xxxxx参考取值来源: GetCodeupOrganization ListOrganizations

请求参数

字段名称	字段详情
namestring	流水线名称示例值:示例流水线
contentstring	流水线 YAML 描述，可参考文档 https://help.aliyun.com/document_detail/2249317.html 编写示例值:sources: # sources 配置流水线源节点 my_repo: # 流水线源唯一标识 id type: codeup # 流水线源类型 name: 代码源名称 # 代码源的展示名称 endpoint: <your-codeup-repository-url> # 代码源的 url branch: master # 代码源的默认分支 triggerEvents: push # 代码源监听事件 certificate: # certificate 认证信息 type: serviceConnection # 认证类型为服务连接 serviceConnection: <your-service-connection-id> # 服务连接 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: <your-machine-group-id> 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

字段名称

字段详情

namestring

流水线名称

示例值:示例流水线

contentstring

流水线 YAML 描述，可参考文档 https://help.aliyun.com/document_detail/2249317.html 编写

示例值:sources: # sources 配置流水线源节点 my_repo: # 流水线源唯一标识 id type: codeup # 流水线源类型 name: 代码源名称 # 代码源的展示名称 endpoint: <your-codeup-repository-url> # 代码源的 url branch: master # 代码源的默认分支 triggerEvents: push # 代码源监听事件 certificate: # certificate 认证信息 type: serviceConnection # 认证类型为服务连接 serviceConnection: <your-service-connection-id> # 服务连接 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: <your-machine-group-id> 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

返回参数

字段名称	字段详情
successboolean	true 接口调用成功，false 接口调用失败示例值:true
errorCodestring	错误码示例值:""
errorMessagestring	错误信息示例值:""
pipelinIdinteger<int64>	流水线 id 注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:11XXX
requestIdstring	请求 id，每次请求都是唯一值，便于后续排查问题示例值:ASSDS-ASSASX-XSAXSA-XSAXSAXS

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidParam.ParamNotPresent	The parameter is invalid.	诊断
400	InvalidUser.NotFound	The user that is invoking the API service is not a registered user.	诊断
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.	诊断
404	InvalidPipeline.NotFound	The pipeline is not found.	诊断
404	InvalidPipelineRun.NotFound	The pipeline execution instance is not found.	诊断

变更历史

暂无变更历史