Docs

Code Pipeline

The pipeline operation

RunPipeline

Run the pipeline.

Request description

To achieve low latency, it is recommended that you select the corresponding service address based on the Region where your resources are located. For details, refer to service address.

Request method: POST

Request URL: https://cp.cn-beijing.volcengineapi.com?Action=RunPipeline&Version=2023-05-01

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	RunPipeline	The API name. The name of the current API is RunPipeline.
Version	String	Yes	2023-05-01	The API version. The current version of the API is 2023-05-01.
WorkspaceId	String	Yes	9d3f01e4f7ee4293a7cfc0c2d4d6	Workspace ID.
Id	String	Yes	67d0485e1efb44128f0d990cdad6	Pipeline ID.
Parameters	Array of TriggerParameter	no	-	The parameters that need to be provided when triggering the pipeline are currently pipeline dynamic variables. If dynamic variables have been set in your pipeline, it is possible to configure their runtime values here.
Resources	Array of TriggerResource	no	-	When triggering a pipeline, you need to provide a resource configuration, which currently refers to the code source configuration.
Description	String	no	This is a description.	Operation description.

TriggerParameter

Parameter	Type	Required	Sample value	Description
Key	String	Yes	key	The dynamic variable key.
Value	String	Yes	value	Dynamic variable Value

TriggerResource

Parameter	Type	Required	Sample value	Description
ResourceId	String	Yes	60cb460122422352a334****	Code source ID.
Reference	String	Yes	master	The code reference used for pipeline execution supports entering a Commit ID, Tag, or Branch.

Sample requests

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"​
        }​
    ]​
}​

Response parameters

Parameter	Type	Sample value	Description
Id	String	0485ca86130647f0b5bbd5b0090a****	Pipeline run ID.

Sample responses

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****"​
    }​
}​

Error code

This interface currently does not have independent error codes. If an exception occurs when calling the interface, you can refer to public error code for troubleshooting.

Last updated: 2025.09.10 17:37:28