Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining Custom Parameters Required for Pipeline Running

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

Online Debugging

CLI Examples

View PDF

Obtaining Custom Parameters Required for Pipeline Running

Function

This API is used to obtain custom parameters required for pipeline running.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-runtime-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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset.
limit	No	Integer	Number of records of each query.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A
X-Language	No	String	Definition: Language type. Constraints: N/A Value range: zh-cn: Chinese. en-us: English. Default value: en-us.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
offset	Integer	Definition: Offset where the query starts. Constraints: N/A Value range: The offset value must be no less than 0. Default value: 0.
limit	Integer	Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A
total	Integer	Total number of records.
variables	Array of PipelineVariable objects	Customized pipeline parameters

**Table 5** PipelineVariable
Parameter	Type	Description
name	String	Definition: Custom parameter name. Value range: Enter a maximum of 128 characters. Only letters, digits, and underscores (_) are supported.
sequence	Integer	Parameter description: Sequence number. Value range: 1–2147483647
type	String	Parameter description: Custom parameter type. Value range: N/A
value	String	Definition: Default value of the custom parameter. Value range: N/A
is_secret	Boolean	Definition: Private parameter or not. Value range: true: The parameter is private. false: The parameter is not private.
description	String	Parameter description: Custom parameter description. Value range: N/A
is_runtime	Boolean	Definition: Whether a parameter can be set at runtime. Value range: true: The parameter can be set at runtime. false: The parameter cannot be set at runtime.
limits	Array of strings	Parameter description: List of limited enumerated values. Value range: N/A
is_reset	Boolean	Definition: Whether an auto-increment parameter is reset. Value range: true: The parameter is reset. false: The parameter is not reset.
latest_value	String	Parameter description: The latest value of an auto-increment parameter. Value range: N/A

Example Requests

GET https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pipelines/633839ac12a2465ba86dfc5cd212ee1a/list-runtime-vars

Example Responses

Status code: 200

{
  "offset" : 1,
  "limit" : 10,
  "total" : 0,
  "variables" : [ {
    "name" : "name",
    "sequence" : 1,
    "type" : "string",
    "is_strict" : false,
    "value" : "zs",
    "is_secret" : false,
    "description" : "",
    "is_runtime" : false,
    "limits" : [ ],
    "is_reset" : false,
    "latest_value" : ""
  }, {
    "name" : "age",
    "sequence" : 2,
    "type" : "string",
    "is_strict" : false,
    "value" : "18",
    "is_secret" : false,
    "description" : "",
    "is_runtime" : false,
    "limits" : [ ],
    "is_reset" : false,
    "latest_value" : ""
  } ]
}