Obtaining All Custom Parameters of a Pipeline of the Old Version
Function
This API is used to obtain all custom parameters of a pipeline of the old version.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-pipeline-vars
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
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of customVarVOVO objects |
Definition: Custom parameters. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition: Parameter name. Value range: N/A |
sequence |
Integer |
Definition: Parameter ID. Value range: N/A |
type |
String |
Definition: Parameter type. Value range: N/A |
value |
String |
Definition: Parameter value. Value range: N/A |
is_secret |
Boolean |
Definition: Whether the parameter is private. Value range:
|
description |
String |
Definition: Parameter description. Value range: N/A |
is_runtime |
Boolean |
Definition: Whether a parameter can be set at runtime. Value range:
|
limits |
Array of limits objects |
Definition: List of limited enumerated values. Value range: N/A |
is_reset |
Boolean |
Definition: Whether an auto-increment parameter is reset. Value range:
|
latest_value |
String |
Definition: The latest value of an auto-increment parameter. Value range: N/A |
required |
Boolean |
Definition: Mandatory or not. Value range:
|
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot