运行流水线。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=RunPipeline&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RunPipeline | 公共参数,本接口值:RunPipeline。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
WorkspaceId | String | 是 | 9d3f01e4f7ee4293a7cfc0c2d4d6**** | 工作区 ID。 |
Id | String | 是 | 67d0485e1efb44128f0d990cdad6**** | 流水线 ID。 |
Parameters | Array of TriggerParameter | 否 | 触发流水线时需要传入的参数,当前指流水线动态变量。 | |
Resources | Array of TriggerResource | 否 | 触发流水线时需要传入的资源配置,当前指代码源配置。 | |
Description | String | 否 | 这是一段描述 | 运行描述。 |
POST /?Action=RunPipeline&Version=2023-05-01 HTTP/1.1 Content-Type:application/json { "WorkspaceId":"9d3f01e4f7ee4293a7cfc0c2d4d6****", "Id":"67d0485e1efb44128f0d990cdad6****", "Description":"test", "Parameters":[ { "key":"key1", "value":"value1" }, { "key":"key2", "value":"value2" } ], "Resources":[ { "Id":"60cb460122422352a334****", "Reference":"master" } ] }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 0485ca86130647f0b5bbd5b0090a**** | 流水线运行 ID。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202404071119222036DE1C5356DD45****", "Action": "RunPipeline", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing", }, "Result": { "Id": "0485ca86130647f0b5bbd5b0090a****" } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。