跳到主要内容

查询环境信息

获取 NineData 所有可用环境列表,支持通过环境名称过滤。

请求地址:/openapi/v1/env/list

请求方法:GET

请求参数

参数类型是否必选说明示例
nameString环境名称。生产环境
currentInteger当前页,从 1 开始,默认 1。1
pageSizeInteger分页大小,默认 10。50

返回参数

参数类型说明示例
successBool接口调用是否成功。返回值:turefalseture
requestIdString请求 ID。Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO
dataArray环境列表,包含环境 ID(envId)、环境名称(name)等信息。{
"envId": "env-product",
"name": "生产"
}
currentInteger当前页码。1
pageSizeInteger每页的大小。10
totalInteger环境总数。2

调用成功示例

{
"success": true,
"requestId": "Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO",
"data": [{
"envId": "env-product",
"name": "生产"
}, {
"envId": "env-dev",
"name": "测试"
}],
"current": 1,
"pageSize": 10,
"total": 2
}