查询环境列表
功能介绍
查询符合条件的环境列表。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| GET | /v1.0/apigw/envs[?page_no, page_size,name] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:name、page_size、page_no。
| 名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| name | 否 | String | 环境名称 |
| page_size | 否 | Integer | 每页显示的条数,默认值:20 |
| page_no | 否 | Integer | 页码,默认值:1 |
| precise_search | 否 | String | 指定需要精确匹配查找的参数名称,目前仅支持name |
请求消息
无
响应消息
| 名称 | 类型 | 说明 |
|---|---|---|
| total | Integer | 符合条件的环境总数 |
| size | Integer | 本次返回的列表长度 |
| envs | 字典数据类型 | 本次返回的环境列表 |
| 参数 | 类型 | 说明 |
|---|---|---|
| id | String | 环境ID |
| name | String | 环境名称 |
| create_time | Timestamp | 创建时间 |
| remark | String | 描述信息 |
响应消息样例:
{
"total": 2,
"size": 2,
"envs": [{
"id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"name": "RELEASE",
"remark": "生产环境",
"create_time": "2017-12-29T03:39:03.165657Z"
},
{
"id": "0035dd2e76dd4e3fa45fef634318ada4",
"name": "DEVELOP",
"remark": "开发环境",
"create_time": "2017-12-28T12:50:47Z"
}]
} 状态码
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Server Internal Error |