查询环境信息
获取 NineData 所有可用环境列表,支持通过环境名称过滤。
请求地址:/openapi/v1/env/list
请求方法:GET
请求参数
参数 | 类型 | 是否必选 | 说明 | 示例 |
---|---|---|---|---|
name | String | 否 | 环境名称。 | 生产环境 |
current | Integer | 否 | 当前页,从 1 开始,默认 1。 | 1 |
pageSize | Integer | 否 | 分页大小,默认 10。 | 50 |
返回参数
参数 | 类型 | 说明 | 示例 |
---|---|---|---|
success | Bool | 接口调用是否成功。返回值:ture 、false 。 | ture |
requestId | String | 请求 ID。 | Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO |
data | Array | 环境列表,包含环境 ID(envId)、环境名称(name)等信息。 | { "envId": "env-product", "name": "生产" } |
current | Integer | 当前页码。 | 1 |
pageSize | Integer | 每页的大小。 | 10 |
total | Integer | 环境总数。 | 2 |
调用成功示例
{
"success": true,
"requestId": "Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO",
"data": [{
"envId": "env-product",
"name": "生产"
}, {
"envId": "env-dev",
"name": "测试"
}],
"current": 1,
"pageSize": 10,
"total": 2
}