获取流水线运行需要的自定义参数
功能介绍
获取流水线运行需要的自定义参数
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-runtime-vars
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
pipeline_id |
是 |
String |
参数解释: 流水线ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量 |
limit |
否 |
Integer |
每次查询的条目数量 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
语言类型 中文:zh-cn 英文:en-us,默认en-us |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移 |
limit |
Integer |
大小 |
total |
Integer |
记录总数 |
variables |
Array of PipelineVariable objects |
流水线自定义参数 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数名称。 取值范围: 不涉及。 |
sequence |
Integer |
参数解释: 序号。 取值范围: [1, 2147483647]。 |
type |
String |
参数解释: 类型。 取值范围: 不涉及。 |
value |
String |
参数解释: 默认值。 取值范围: 不涉及。 |
is_secret |
Boolean |
参数解释: 是否私密。 取值范围: true - 私密;false - 不私密。 |
description |
String |
参数解释: 描述。 取值范围: 不涉及。 |
is_runtime |
Boolean |
参数解释: 是否运行时设置。 取值范围: true -运行时设置;false -非运行时设置。 |
limits |
Array of strings |
参数解释: 限定枚举值列表。 取值范围: 不涉及。 |
is_reset |
Boolean |
参数解释: 自增长参数是否被重置。 取值范围: true -被重置;false -不被重置。 |
latest_value |
String |
参数解释: 自增长参数最新值。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pipelines/633839ac12a2465ba86dfc5cd212ee1a/list-runtime-vars
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。