Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Available Predefined Parameters
Updated on 2025-09-08 GMT+08:00

Querying Available Predefined Parameters

Function

This API is used to query available predefined parameters.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-system-vars

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline 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

[items]

Array of ListPipelineSystemVarsResp objects

Definition:

Response body details.

Value range:

N/A

Table 3 ListPipelineSystemVarsResp

Parameter

Type

Description

name

String

Definition:

Parameter name.

Value range:

N/A

value

String

Definition:

Parameter value.

Value range:

N/A

type

String

Definition:

Parameter type.

Value range:

N/A

description

String

Definition:

Parameter description.

Value range:

N/A

isShow

Boolean

Definition:

Display or not.

Value range:

  • true: display.

  • false: not display.

ordinal

Integer

Definition:

Sequence number of a parameter.

Value range:

N/A

isAlias

Boolean

Definition:

Parameter alias.

Value range:

N/A

kind

String

Definition:

Context type of a parameter.

Value range:

N/A

contextName

String

Definition:

Context name.

Value range:

N/A

sourceIdentifier

String

Definition:

Parameter identifier.

Value range:

N/A

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/0747d5a7099e45f69dc1d099945909a9/list-system-vars

Example Responses

None

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.