Querying the Parameter Group List

Function

This API is used to query the parameter group list.

Calling Method

For details, see Calling APIs.

URI

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

**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
offset	Yes	Long	Offset.
limit	Yes	Long	Number of records on each page.
name	No	String	Fuzzy search by name.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
pipeline_variable_groups	Array of pipeline_variable_groups objects	Details list.
offset	Integer	Offset.
limit	Integer	Number of records on each page.
total	Integer	Total number.

**Table 4** pipeline_variable_groups
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	Array of related_pipelines objects	Associated pipeline.
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.

**Table 5** related_pipelines
Parameter	Type	Description
id	String	Pipeline ID.
name	String	Pipeline name.

Example Requests

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

{
  "offset" : 0,
  "limit" : 10,
  "name" : ""
}

Example Responses

Status code: 200

Response body.

{
  "pipeline_variable_groups" : [ {
    "id" : "e9b95653dd854146b9ff48d33c2d9d66",
    "project_id" : "e2e18230a85d4d6ab0b56cb6d2246c18",
    "domain_id" : "4b267c81b33648d982e5c2067e4c77b9",
    "name" : "121212",
    "description" : "",
    "variables" : [ ],
    "related_pipelines" : [ {
      "id" : "0747d5a7099e45f69dc1d099945909a9",
      "name" : "cloudtest"
    }, {
      "id" : "dc73b5ed58a64ab7a469b9480e5f6632",
      "name" : "PY3-0401-pipeline"
    } ],
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator_name" : "north-5",
    "updater_name" : "north-5",
    "create_time" : 1718957748000,
    "update_time" : 1718958969000
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 1
}