You need to enable JavaScript to run this app.
导航
RunPipeline
最近更新时间:2024.09.27 14:46:38首次发布时间:2024.07.02 21:03:13

运行流水线。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=RunPipeline&Version=2023-05-01

请求参数

参数类型是否必选示例值描述
ActionStringRunPipeline接口名称。当前 API 的名称为 RunPipeline
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
WorkspaceIdString9d3f01e4f7ee4293a7cfc0c2****工作区 ID。
IdString67d0485e1efb44128f0d990c****流水线 ID。

Parameters

Array of TriggerParameter

触发流水线时需要传入的参数,当前指流水线动态变量。
如果您的流水线设置了动态变量,支持在此处配置动态变量的运行值。

ResourcesArray of TriggerResource-触发流水线时需要传入的资源配置,当前指代码源配置。
DescriptionString这是一段描述运行描述。

TriggerParameter

参数类型是否必选示例值描述
KeyStringkey动态变量 Key。
ValueStringvalue动态变量 Value。

TriggerResource

参数类型是否必选示例值描述
ResourceIdString60cb460122422352a334****代码源 ID。
ReferenceStringmaster流水线运行使用的代码 Reference,支持填写 Commit ID/Tag/Branch。

请求示例

POST https://open.volcengineapi.com/?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"
        }
    ]
}

返回参数

参数类型示例值描述
IdString0485ca86130647f0b5bbd5b0090a****流水线运行 ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "RunPipeline",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "0485ca86130647f0b5bbd5b0090a****"
    }
}

错误码

当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。