开放接口 - 清竹科技

##一、接口简介

开放接口用于其它应用数据读取接入，您可以采用自己的形式展现数据。
##二、接口规范
###1、接口地址
接口访问地址为：http://您的服务器IP:服务端口/api/服务模块/接口类型.方法名
###2、请求方式
接口采用http协议，只接受POST请求，参数以表单形式提交
###3、签名
a、将所有参数根据参数名排序后拼接成字符串，如提交参数b=2&a=1，那么排序后：a=1&b=2，参数值无需转为url编码
b、拼接接口密钥，如密钥值为secret，那么拼接结果：a=1&b=2secret
c、将拼接后的字符串进行md5计算：md5(a=1&b=2secret)，结果不区分大小写
###4、公共参数
所有请求均需加上公共参数，以下为公共参数列表

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|QPP_TimeStamp|long|无|必填参数，接口请求的时间戳，用于与服务器时间验证是否同步|
|QPP_Sign|string|无|签名，用于接口安全性验证，签名算法请见《二.3》|
##三、接口列表
###1、操作系统
####a、获取监控统计数据报表
接口地址：http://yourhost:port/api/os/MonitorData.Get

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|DateType|int|无|获取数据的日期类型：可选值为：1为秒数据、2为分数据、3为时数据、4为天数据、5为月数据、6为年数据|
|StartDateTime|DateTime|无|拉取限定开始时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
|StartDateTime|DateTime|无|拉取限定结束时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
####b、获取实时监控数据
接口地址：http://yourhost:port/api/os/MonitorData.GetForthwith
无参数
###2、Hyper-V
####a、获取所有虚拟机的统计数据列表
接口地址：http://yourhost:port/api/vm/MonitorData.GetAllTotal

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|DateType|int|无|获取数据的日期类型：可选值为：2为分数据、3为时数据、4为天数据、5为月数据、6为年数据|
|sKey|string|无|虚拟机名称，非必填，根据虚拟机名称筛选结果|
####b、根据虚拟机名称获取监控统计数据报表
接口地址：http://yourhost:port/api/vm/MonitorData.Get

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|DateType|int|无|获取数据的日期类型：可选值为：1为秒数据、2为分数据、3为时数据、4为天数据、5为月数据、6为年数据|
|VMName|string|无|必填项，要获取的虚拟机名称|
|StartDateTime|DateTime|无|拉取限定开始时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
|StartDateTime|DateTime|无|拉取限定结束时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
####c、根据虚拟机名称获取实时监控数据
接口地址：http://yourhost:port/api/vm/MonitorData.GetForthwith

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|VMName|string|无|必填项，要获取的虚拟机名称|
###2、IIS
####a、获取所有站点的统计数据列表
接口地址：http://yourhost:port/api/ws/MonitorData.GetAllTotal

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|DateType|int|无|获取数据的日期类型：可选值为：2为分数据、3为时数据、4为天数据、5为月数据、6为年数据|
|sKey|string|无|站点名称，非必填，根据站点名称筛选结果|
####b、根据站点名称获取监控统计数据报表
接口地址：http://yourhost:port/api/ws/MonitorData.Get

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|DateType|int|无|获取数据的日期类型：可选值为：1为秒数据、2为分数据、3为时数据、4为天数据、5为月数据、6为年数据|
|WSName|string|无|必填项，要获取的站点名称|
|StartDateTime|DateTime|无|拉取限定开始时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
StartDateTime|DateTime|无|拉取限定结束时间，根据时间类型，酌情设置拉取范围，不要因设置太长导致拉取数据缓慢|
####c、根据站点名称获取实时监控数据
接口地址：http://yourhost:port/api/ws/MonitorData.GetForthwith

|参数名|数据类型|默认值|说明|
| ------------ | ------------ | ------------ | ------------ |
|WSName|string|无|必填项，要获取的站点名称|