查询变量列表
功能介绍
查询分组下的所有环境变量的列表。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| GET | /v1.0/apigw/env-variables[?page_size, page_no, env_id, group_id, variable_name] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:env_id、group_id、variable_name、page_size、page_no
| 名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| env_id | 否 | String | 环境编号 |
| group_id | 是 | String | API分组编号 |
| variable_name | 否 | String | 变量名 |
| page_size | 否 | Integer | 每页显示的条数,默认值:20 |
| page_no | 否 | Integer | 页码,默认值:1 |
| precise_search | 否 | String | 指定需要精确匹配查找的参数名称,目前仅支持variable_name |
请求消息
无
响应消息
| 名称 | 类型 | 说明 |
|---|---|---|
| variables | 字典数据类型 | 本次返回的环境变量列表 |
| total | Integer | 满足条件的环境变量总数 |
| size | Integer | 本次返回的列表长度 |
| 参数 | 类型 | 说明 |
|---|---|---|
| id | String | 环境变量编号 |
| env_id | String | 环境编号 |
| group_id | String | API分组编号 |
| variable_name | String | 变量名 |
| variable_value | String | 变量值 |
响应消息样例:
{
"total": 2,
"size": 2,
"variables": [{
"id": "09ab8135722440b9bf5d107f2a09d409",
"env_id": "cca3616af3684b329064b2a631cb3eeb",
"group_id": "73c58022f20d495aa18885d718647f09",
"variable_name": "port",
"variable_value": "8080"
},
{
"id": "104185e53e8f4c63a7e5ef4117bf870c",
"env_id": "cca3616af3684b329064b2a631cb3eeb",
"group_id": "73c58022f20d495aa18885d718647f09",
"variable_name": "address",
"variable_value": "192.168.1.5"
}]
} 状态码
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |