# 查询流水线运行使用的参数 - ListRunVariables #### 功能介绍 查询流水线运行使用的参数 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/run-variables 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pipelineRunId | 是 | String | 流水线运行实例ID，[启动流水线](https://support.huaweicloud.com/api-pipeline/RunPipeline.html)接口的返回值即为流水线运行实例ID。 | | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-pipeline/pipeline_03_0036.html)。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | | pipeline_id | 是 | String | **参数解释**： 流水线ID，可以通过[查询流水线列表](https://support.huaweicloud.com/api-pipeline/ListPipelines.html)接口获取，其中pipelines.pipelineId即为流水线ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mode | 是 | Integer | 查询模式，0-自定义参数；1-系统参数；2-参数组参数 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ListRunVariablesResp] objects | 响应体 | 表4ListRunVariablesResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名称 | | sequence | String | 参数序列号 | | type | String | 参数类型 | | value | String | 参数值 | | is_secret | Boolean | 是否私密参数,true:是私密参数，false：非私密参数 | | description | String | 描述 | | is_runtime | String | 是否运行时设置，true：表示运行时必须设置，false表示运行时可以不进行设置 | | limits | String | 参数限制值 | | is_reset | Boolean | 是否重置 | | latest_value | String | 最后一次运行的参数值 | | required | Boolean | 是否必输,true:比如输入，false:可以不输入 | | variableGroupName | String | 参数组名称 | #### 请求示例 ``` GET https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/53acae73a3f44b2994f9b20a710721c6/pipeline-runs/13a48f79f7104f9785720cf2c11890ba/run-variables?mode=0 ``` #### 响应示例 **状态码：200** 响应体 - 流水线运行参数查询结果。 ``` [ { "name" : "PROJECT_ID", "sequence" : null, "type" : "string", "value" : "071112d87d3e4ed49130c691936202e9", "is_secret" : false, "description" : "当前流水线所属项目ID", "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", "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" : "流水线执行编号", "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", "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" : "执行时代码最后一次提交的短ID", "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" : "流水线执行时间戳。例如：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" : "流水线触发类型，包括Manual，Scheduler，RollBack，以及Webhook类型：CreateTag，Note，Issue，MR，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" : "代码仓地址(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" : "流水线执行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" : "仓库名称", "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" : "仓库运行源分支名称", "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" : "仓库运行目标分支名称", "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" : "仓库标签名称", "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", "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" : "执行时代码最后一次提交的短ID", "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" : "代码仓地址(HTTPS)", "is_runtime" : null, "limits" : null, "is_reset" : false, "latest_value" : null, "required" : true, "variableGroupName" : null } ] ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 响应体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。