Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Details About a Parameter Group

Updated on 2025-09-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Details About a Parameter Group

Function

This API is used to query details about a parameter group.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: Parameter group ID. Constraints: N/A Value range: N/A Default value: N/A
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	Definition: Parameter group name. Value range: N/A
project_id	String	Definition: Project name. Value range: N/A
domain_id	String	Definition: Tenant ID. Value range: The value consists of 32 characters, including digits and letters.
name	String	Definition: Parameter group name. Value range: N/A
description	String	Definition: Parameter group description. Value range: N/A
variables	Array of variables objects	Definition: Parameter list. Value range: N/A
related_pipelines	Array of related_pipelines objects	Definition: Associated pipeline. Value range: N/A
creator_id	String	Definition: Creator ID. Value range: The value consists of 32 characters, including digits and letters.
updater_id	String	Definition: Editor ID Value range: The value consists of 32 characters, including digits and letters.
creator_name	String	Definition: Creator name. Value range: N/A
updater_name	String	Definition: Editor name. Value range: N/A
create_time	Integer	Definition: Creation time. Value range: N/A
update_time	Integer	Definition: Update time. Value range: N/A

**Table 3** variables
Parameter	Type	Description
name	String	Definition: Parameter name. Value range: N/A
sequence	Integer	Definition: Sequence number of a parameter. Value range: N/A
type	String	Definition: Parameter type. Value range: N/A
value	String	Definition: Default parameter value. Value range: N/A
is_secret	Boolean	Definition: Whether the parameter is private. Value range: true: The parameter is private. false: The parameter is not private.
description	String	Definition: Description. Value range: N/A

**Table 4** related_pipelines
Parameter	Type	Description
id	String	Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters.
name	String	Definition: Pipeline name. Value range: N/A

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/e9b95653dd854146b9ff48d33c2d9d66

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" : [ {
    "id" : "0747d5a7099e45f69dc1d099945909a9",
    "name" : "cloudtest"
  } ],
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "12-5",
  "updater_name" : "12-5",
  "create_time" : 1718957748000,
  "update_time" : 1718958969000
}