Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Details About a Parameter Group
Updated on 2025-03-25 GMT+08:00

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

Parameter group ID.

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

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Parameter group name.

project_id

String

Project name.

domain_id

String

Tenant ID.

name

String

Parameter group name.

description

String

Description.

variables

Array of variables objects

Parameter list.

related_pipelines

Array of related_pipelines objects

Associated pipeline.

creator_id

String

Creator ID.

updater_id

String

Editor ID.

creator_name

String

Creator name.

updater_name

String

Name of the editor.

create_time

Integer

Creation time.

update_time

Integer

Update time.

Table 3 variables

Parameter

Type

Description

name

String

Parameter name.

sequence

Integer

Parameter No.

type

String

Parameter type.

value

String

Default parameter value.

is_secret

Boolean

Whether the parameter is private or not.

description

String

Description.

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
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.