El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
Querying Parameters Used in a Pipeline
Function
This API is used to query parameters used in a pipeline.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/run-variables
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
pipelineRunId |
Yes |
String |
Pipeline run ID. |
|
project_id |
Yes |
String |
Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A. |
|
pipeline_id |
Yes |
String |
Parameter description: Pipeline ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
mode |
Yes |
Integer |
Query mode. 0: user-defined parameter; 1: system parameter; 2: parameter group. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
[items] |
Array of ListRunVariablesResp objects |
Response body. |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Parameter name. |
|
sequence |
String |
Parameter sequence number. |
|
type |
String |
Parameter type. |
|
value |
String |
Parameter value. |
|
is_secret |
Boolean |
Whether the parameter is private. |
|
description |
String |
Description. |
|
is_runtime |
String |
Whether the parameter can be set during runtime. |
|
limits |
String |
Parameter limit value. |
|
is_reset |
Boolean |
Reset or not. |
|
latest_value |
String |
Parameter value of the latest run. |
|
required |
Boolean |
Required or not. |
|
variableGroupName |
String |
Parameter group name. |
Example Requests
GET https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/53acae73a3f44b2994f9b20a710721c6/pipeline-runs/13a48f79f7104f9785720cf2c11890ba/run-variables?mode=0
Example Responses
Status code: 200
Response body.
[ {
"name" : "PROJECT_ID",
"sequence" : null,
"type" : "string",
"value" : "071112d87d3e4ed49130c691936202e9",
"is_secret" : false,
"description" : "ID of the project to which the current pipeline belongs",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "PIPELINE_ID",
"sequence" : null,
"type" : "string",
"value" : "53acae73a3f44b2994f9b20a710721c6",
"is_secret" : false,
"description" : "ID of the current pipeline",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "PIPELINE_NUMBER",
"sequence" : null,
"type" : "string",
"value" : "34",
"is_secret" : false,
"description" : "Pipeline execution number",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "COMMIT_ID",
"sequence" : null,
"type" : "string",
"value" : "fc315b91f027d252be756ade0b4263f6b6be58f4",
"is_secret" : false,
"description" : "ID of the last commit for execution",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "COMMIT_ID_SHORT",
"sequence" : null,
"type" : "string",
"value" : "fc315b91",
"is_secret" : false,
"description" : "Short ID of the last code commit for execution",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "TIMESTAMP",
"sequence" : null,
"type" : "string",
"value" : "20240621144916",
"is_secret" : false,
"description" : "Pipeline execution timestamp. For example: 20211222124301",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "PIPELINE_TRIGGER_TYPE",
"sequence" : null,
"type" : "string",
"value" : "Manual",
"is_secret" : false,
"description" : "Pipeline triggering type, including Manual, Scheduler, RollBack, and WebHook (CreateTag, Note, Issue, MR, and Push).",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "REPO_URL",
"sequence" : null,
"type" : "string",
"value" : "https://001/test.git",
"is_secret" : false,
"description" : "Code repository address (HTTPS)",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "PIPELINE_RUN_ID",
"sequence" : null,
"type" : "string",
"value" : "13a48f79f7104f9785720cf2c11890ba",
"is_secret" : false,
"description" : "Pipeline execution ID",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_REPOSITORY_NAME",
"sequence" : null,
"type" : "string",
"value" : "test",
"is_secret" : false,
"description" : "Repository name",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_SOURCE_BRANCH",
"sequence" : null,
"type" : "string",
"value" : "",
"is_secret" : false,
"description" : "Name of the branch of the code source",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_TARGET_BRANCH",
"sequence" : null,
"type" : "string",
"value" : "branch-001",
"is_secret" : false,
"description" : "Name of the target branch of the code source",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_TAG",
"sequence" : null,
"type" : "string",
"value" : "",
"is_secret" : false,
"description" : "Repository tag name",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_COMMIT_ID",
"sequence" : null,
"type" : "string",
"value" : "fc315b91f027d252be756ade0b4263f6b6be58f4",
"is_secret" : false,
"description" : "ID of the last code commit for execution",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_COMMIT_ID_SHORT",
"sequence" : null,
"type" : "string",
"value" : "fc315b91",
"is_secret" : false,
"description" : "Short ID of the last code commit for execution",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
}, {
"name" : "test_REPO_URL",
"sequence" : null,
"type" : "string",
"value" : "https://1/test.git",
"is_secret" : false,
"description" : "Code repository address (HTTPS)",
"is_runtime" : null,
"limits" : null,
"is_reset" : false,
"latest_value" : null,
"required" : true,
"variableGroupName" : null
} ]Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response body. |
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
