Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Associating a Pipeline with a Parameter Group

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Associating a Pipeline with a Parameter Group

Function

This API is used to associate a pipeline with a parameter group.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline/variable/group/relation

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
pipeline_id	Yes	String	Pipeline ID.
pipeline_group_ids	Yes	Array of strings	Parameter group ID list.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
success	Boolean	Parameter description: Whether the operation is successful. Value range: None.

Example Requests

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/relation

{
  "pipeline_id" : "0747d5a7099e45f69dc1d099945909a9",
  "pipeline_group_ids" : [ "e9b95653dd854146b9ff48d33c2d9d66" ]
}