检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
获取项目ID 调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,您可以从地区和终端节点中获取。接口的认证鉴权请参见认证鉴权。
示例2:停止流水线 场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI:POST
流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI:POST v3/pipelines/{pipeline_id}/status API文档详情请参见:获取流水线状态。 API Explorer在线调试请参见:
com/v3/pipelines/{pipeline_id}/start 请求体示例 {} 响应示例 { "build_id": "xxx", "pipeline_id": "824e784b3f43492e99152a....." } 父主题: 应用示例
URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/steps/{step_run_id}/refuse 表1 路径参数 参数 是否必选
URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/steps/{step_run_id}/logs 表1 路径参数 参数 是否必选
URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/steps/{step_run_id}/pass 表1 路径参数 参数 是否必选
/v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/{step_run_id}/manual/pass 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
/v5/{project_id}/api/pipelines/{pipeline_id}/{pipelineRunId}/cancel-queuing/{id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。 约束限制:
stepRunId 是 String 流水线步骤ID project_id 是 String 参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 pipeline_id 是 String 参数解释: 流水线ID。 约束限制: 不涉及 取值范围:
不论job1的最终状态如何。 jobs.<job_id>.steps 每个任务由定义在steps中的多个步骤组成,每个步骤可运行一个指定的插件。 jobs.<job_id>.steps<*>.name 使用jobs.<job_id>.steps<*>.name定义步骤的名称,在图形化界面中会展示该名称。
应用示例 示例1: 执行流水线 示例2:停止流水线 示例3:获取流水线状态
GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/artifacts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。
GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/outputs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:
URI PUT /v5/{project_id}/api/pipelines/{pipeline_id}/unban 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。
/v5/{project_id}/api/pipeline/variable/group/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 参数组ID project_id 是 String 参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围:
/v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。 约束限制:
/v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。 约束限制:
/v5/{project_id}/api/pipeline-permissions/{pipeline_id}/role-permission 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。 约束限制: 不涉及