Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Parameter Groups Associated with a Pipeline

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

Online Debugging

CLI Examples

View PDF

Querying Parameter Groups Associated with a Pipeline

Function

This API is used to query parameter groups associated with a pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipeline/variable/group/pipeline

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pipelineId	Yes	String	Pipeline ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Parameter group ID.
project_id	String	Project ID.
domain_id	String	Tenant ID.
name	String	Parameter group name.
description	String	Description.
variables	Array of strings	Parameter list.
related_pipelines	String	Associated pipeline ID.
creator_id	String	Creator ID.
updater_id	String	Updater ID.
creator_name	String	Creator name.
updater_name	String	Updater name.
create_time	Integer	Creation time.
update_time	Integer	Update time.

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/pipeline?pipelineId=dc73b5ed58a64ab7a469b9480e5f6632

Example Responses

Status code: 200

Response body.

{
  "id" : "e9b95653dd854146b9ff48d33c2d9d66",
  "project_id" : "e2e18230a85d4d6ab0b56cb6d2246c18",
  "domain_id" : "4b267c81b33648d982e5c2067e4c77b9",
  "name" : "121212",
  "description" : "",
  "variables" : [ {
    "name" : "12",
    "sequence" : 1,
    "type" : "string",
    "value" : "12",
    "is_secret" : false,
    "description" : ""
  } ],
  "related_pipelines" : null,
  "creator_id" : "1212",
  "updater_id" : "1212",
  "creator_name" : "12-5",
  "updater_name" : "12-5",
  "create_time" : 1718957748000,
  "update_time" : 1718958969000
}