运行代码化流水线
功能介绍
运行代码化流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pac/pipelines/{pipeline_id}/run
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言类型。 约束限制: 不涉及。 取值范围:
默认取值: en-us。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
branch |
是 |
String |
参数解释: 运行分支。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 运行描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
variables |
否 |
Array of variables objects |
参数解释: 运行参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
choose_jobs |
否 |
Array of strings |
参数解释: 选择的任务列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
pipeline_run_id |
String |
参数解释: 流水线运行实例ID,启动流水线接口的返回值即为流水线运行实例ID。 取值范围: 32位字符,仅由数字和字母组成。 |
请求示例
POST https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pac/pipelines/c23f79a760aa4ad28b98f24e70373c4e/run
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。