GET 接口列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/server |
| 所属业务 | 系统管理 |
| 来源模块/系统 | 接口管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
接口列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 搜索接口ID/接口名称/分组名称 |
| status | query | string | 否 | 状态 0禁用 1启用 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序 id name server_group_id status |
| sort | query | string | 否 | 升/降序 asc desc |
| module | query | string | 否 | 模块类型 |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | 接口列表 |
data.list[].id | integer(int32) | 否 | — | 接口ID |
data.list[].name | string | 否 | — | 接口名称 |
data.list[].module | string | 否 | — | 模块类型 |
data.list[].url | string | 否 | — | 地址 |
data.list[].username | string | 否 | — | 用户名 |
data.list[].password | string | 否 | — | 密码 |
data.list[].hash | string | 否 | — | hash |
data.list[].status | integer(int32) | 否 | — | 是否启用 0禁用 1启用 |
data.list[].server_group_id | integer(int32) | 否 | — | 接口分组ID |
data.list[].server_group_name | string | 否 | — | 接口分组名称 |
data.list[].host_num | integer(int32) | 否 | — | 已开通数量 |
data.list[].module_name | string | 否 | — | 模块名称 |
data.list[].dcim_type | string | 否 | — | — |
data.count | integer(int32) | 否 | — | 接口总数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |