文档中心

持续交付

流水线运行

RunPipeline

运行流水线。

请求说明

为获得低延迟，建议您根据资源所在的地域选择对应的服务地址，详情参见服务地址。

请求方式：POST

请求地址：https://cp.cn-beijing.volcengineapi.com?Action=RunPipeline&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	RunPipeline	接口名称。当前 API 的名称为 RunPipeline。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 2023-05-01。
WorkspaceId	String	是	9d3f01e4f7ee4293a7cfc0c2d4d6	工作区 ID。
Id	String	是	67d0485e1efb44128f0d990cdad6	流水线 ID。
Parameters	Array of TriggerParameter	否	-	触发流水线时需要传入的参数，当前指流水线动态变量。如果您的流水线设置了动态变量，支持在此处配置动态变量的运行值。
Resources	Array of TriggerResource	否	-	触发流水线时需要传入的资源配置，当前指代码源配置。
Description	String	否	这是一段描述	运行描述。

TriggerParameter

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

TriggerResource

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

请求示例

POST https://cp.cn-beijing.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": [​
        {​
            "ResourceId": "60cb460122422352a334****",​
            "Reference": "master"​
        }​
    ]​
}​

返回参数

参数	类型	示例值	描述
Id	String	0485ca86130647f0b5bbd5b0090a****	流水线运行 ID。

返回示例

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

错误码

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

最近更新时间：2025.09.04 11:03:26

这个页面对您有帮助吗？

有用

无用