添加目录结构
This commit is contained in:
方顺健
262
nezha接口文档.md
262
nezha接口文档.md
@@ -1,16 +1,256 @@
|
||||
# NEZHA接口文档 v1.0.0
|
||||
|
||||
- [1-规范说明](#1-规范说明)
|
||||
-  [1.1-通信协议](#11-通信协议)
|
||||
-  [1.2-请求方法](#12-请求方法)
|
||||
-  [1.3-字符编码](#13-字符编码)
|
||||
-  [1.4-格式说明](#14-格式说明)
|
||||
-  [1.5-响应报文结构](#15-响应报文结构)
|
||||
- [2-接口定义](#2-接口定义)
|
||||
-  [2.1-设备管理](#21-设备管理)
|
||||
-  [2.2-权限](#22-权限)
|
||||
-  [2.3-监测配置](#23-监测配置)
|
||||
-  [2.4-任务](#24-任务)
|
||||
## 目录
|
||||
|
||||
- [1 规范说明](#1-规范说明)
|
||||
-  [1.1 通信协议](#11-通信协议)
|
||||
-  [1.2 请求方法](#12-请求方法)
|
||||
-  [1.3 字符编码](#13-字符编码)
|
||||
-  [1.4 格式说明](#14-格式说明)
|
||||
-  [1.5 响应报文结构](#15-响应报文结构)
|
||||
-   [1.5.1 结构说明](#151-结构说明)
|
||||
-   [1.5.2 响应报文示例](#152-响应报文示例)
|
||||
- [2. 接口定义](#2-接口定义)
|
||||
-  [2.1 设备管理](#21-设备管理)
|
||||
-   [2.1.1 节点管理](#211-节点管理)
|
||||
-    [2.1.1.1 节点列表查询](#2111-节点列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.2 节点详情查询](#2112-节点详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.3 节点新增](#2113-节点新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.4 节点修改](#2114-节点修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.5 节点状态变更](#2115-节点状态变更)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.6 查询可用机柜](#2116-查询可用机柜)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.7 IP校验](#2117-ip校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.1.8 节点名称校验](#2118-节点名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-   [2.1.2 节点组管理](#212-节点组管理)
|
||||
-    [2.1.2.1 节点组列表查询](#2121-节点组列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.2 节点组详情查询](#2122-节点组详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.3 节点组下的节点列表查询](#2123-节点组下的节点列表查询)
|
||||
-    [2.1.2.4 节点组新增](#2124-节点组新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.5 节点组修改](#2125-节点组修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.6 节点组删除](#2126-节点组删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.7 可分配节点查询](#2127-可分配节点查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.8 节点组分配节点](#2128-节点组分配节点)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.9 节点组移除节点](#2129-节点组移除节点)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.2.10 节点组名称校验](#21210-节点组名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-   [2.1.3 机房管理](#213-机房管理)
|
||||
-    [2.1.3.1 机房列表查询](#2131-机房列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.2 机房详情查询](#2132-机房详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.3 机房新增](#2133-机房新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.4 机房修改](#2134-机房修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.5 机房删除](#2135-机房删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.6 机房名称校验](#2136-机房名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.7 机房修改时行列校验](#2137-机房修改时行列校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.3.8 机房内机柜列表查询](#2138-机房内机柜列表查询)
|
||||
-   [2.1.4 机柜管理](#214-机柜管理)
|
||||
-    [2.1.4.1 机柜列表查询](#2141-机柜列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.2 机柜详情查询](#2142-机柜详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.3 机柜新增](#2143-机柜新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.4 机柜修改](#2144-机柜修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.5 机柜删除](#2145-机柜删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.6 机柜名称校验](#2146-机柜名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.7 校验U位数量是否可用](#2147-校验u位数量是否可用)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.1.4.8 查询机柜可选的机房及行号列号](#2148-查询机柜可选的机房及行号列号)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-  [2.2 权限](#22-权限)
|
||||
-   [2.2.1 业务系统](#221-业务系统)
|
||||
-    [2.2.1.1 业务系统列表查询](#2211-业务系统列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.2 业务系统详情查询](#2212-业务系统详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.3 业务系统新增](#2213-业务系统新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.4 业务系统修改](#2214-业务系统修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.5 业务系统删除](#2215-业务系统删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.6 查询业务系统下的节点](#2216-查询业务系统下的节点)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.7 业务系统分配节点](#2217-业务系统分配节点)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.8 业务系统移除节点](#2218-业务系统移除节点)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.9 业务系统名称校验](#2219-业务系统名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.1.10 用户组列表](#22110-用户组列表)
|
||||
-   [2.2.2 用户组](#222-用户组)
|
||||
-    [2.2.2.1 用户组列表查询](#2221-用户组列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.2.2 用户组详情查询](#2222-用户组详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.2.3 用户组新增](#2223-用户组新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.2.4 用户组修改](#2224-用户组修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.2.5 用户组删除](#2225-用户组删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.2.2.6 业务系统列表](#2226-业务系统列表)
|
||||
-    [2.2.2.7 用户组名称校验](#2227-用户组名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-  [2.3 监测配置](#23-监测配置)
|
||||
-   [2.3.1 监测类别](#231-监测类别)
|
||||
-    [2.3.1.1 监测类别列表查询](#2311-监测类别列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.2 监测类别详情查询](#2312-监测类别详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.3 监测类别新增](#2313-监测类别新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.4 监测类别修改](#2314-监测类别修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.5 监测类别删除](#2315-监测类别删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.6 元数据字典查询](#2316-元数据字典查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.1.7 监测类别名称校验](#2317-监测类别名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-   [2.3.2 监测设置](#232-监测设置)
|
||||
-    [2.3.2.1 监测设置列表查询](#2321-监测设置列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.2.2 监测设置详情查询](#2322-监测设置详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.2.3 监测设置新增](#2323-监测设置新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.2.4 监测设置修改](#2324-监测设置修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.2.5 监测设置删除](#2325-监测设置删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.2.6 监测设置名称校验](#2326-监测设置名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-   [2.3.3 告警设置](#233-告警设置)
|
||||
-    [2.3.3.1 告警设置列表查询](#2331-告警设置列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.3.2 告警设置详情查询](#2332-告警设置详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.3.3 告警设置新增](#2333-告警设置新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.3.4 告警设置修改](#2334-告警设置修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.3.5 告警设置删除](#2335-告警设置删除)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.3.3.6 告警名称校验](#2336-告警名称校验)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-  [2.4 任务](#24-任务)
|
||||
-   [2.4.1 任务](#241-任务)
|
||||
-    [2.4.1.1 任务列表查询](#2411-任务列表查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.2 任务详情查询](#2412-任务详情查询)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.3 任务新增](#2413-任务新增)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.4 任务修改](#2414-任务修改)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.5 周期任务停用/启用](#2415-周期任务停用/启用)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.6 新增逆向任务](#2416-新增逆向任务)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
-    [2.4.1.7 结果查看](#2417-结果查看)
|
||||
-     [请求参数](#请求参数)
|
||||
-     [返回结果](#返回结果)
|
||||
- [3 附录A 响应码说明](#3-附录a-响应码说明)
|
||||
|
||||
|
||||
|
||||
## 1 规范说明
|
||||
|
||||
|
||||
Reference in New Issue
Block a user