云服务器内容精选

  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/devicetraffic/statistic/site/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?timeDimension=day&top=5&beginTime=1537408636&endTime=1537495036 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:接口调用成功,响应体参考DeviceTrafficStatisticResp。 表3 DeviceTrafficStatisticResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 查询到的TopN设备或者全部设备流量列表信息。 - 表4 DeviceStatisticInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid - - 设备ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceName string 0~256个字符。 - 设备名称。 "device1" upTraffic float [0-340282350000000000000000000000000000000] - 上行流量。 34225.0 downTraffic float [0-340282350000000000000000000000000000000] - 下行流量。 34225.0 unit string 0~256个字符。 - 流量单位。 "Byte" status int32 [0-10] - 设备状态,0---在线、1---告警、3---离线、4---未注册。 0 onlineUsers int32 [0-2147483647] - 终端连接数。 10 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:接口调用成功,响应体参考DeviceTrafficStatisticResp。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceName" : "device1", "upTraffic" : 34225.0, "downTraffic" : 34225.0, "unit" : "Byte", "status" : 0, "onlineUsers" : 10 } ] } 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/v1/performanceservice/basicperformance/devicetraffic/statistic/site/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 timeDimension 是 string day week month year day 统计周期,day---天、week---周、month---月、year---年。 "day" top 是 int32 0 5 10 15 20 5 top数据个数,支持0、5、10、15、20。0代表查询全部设备的上下行流量。 5 beginTime 是 int64 [0-2208959999] - 起始格林威治时间(时间精度对应到秒)。 1537408636 endTime 是 int64 [0-2208959999] - 结束格林威治时间(时间精度对应到秒)。 1537495036
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/interfaceperformance/device/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?interfaceName=interface1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:接口调用成功,响应体参考InterfacePerformanceResp。 表3 InterfacePerformanceResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 查询接口的性能数据。 - 表4 InterfacePerformance对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mac string 0~256个字符。 - MAC地址。 "xx:xx:xx:xx:xx:xx" interfacePackets REFERENCE 详细请参见表5。 接口速率信息 - 表5 interfacePackets对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string 0~256个字符。 - 接口名称。 "interface1" outBandwidth string 0~256个字符。 - 出方向宽带占用率。 "10" inputBandwidth string 0~256个字符。 - 入方向宽带占用率。 "80" upwardTraffic int64 [0-2147483647] - 上行流量(最新采集周期内增量值)。 100 downwardTraffic int64 [0-2147483647] - 下行流量(最新采集周期内增量值)。 100 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:接口调用成功,响应体参考InterfacePerformanceResp。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "mac" : "xx:xx:xx:xx:xx:xx", "interfacePackets" : [ { "interfaceName" : "interface1", "outBandwidth" : "10", "inputBandwidth" : "80", "upwardTraffic" : 100, "downwardTraffic" : 100 } ] } ] } 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/v1/performanceservice/basicperformance/interfaceperformance/device/{deviceId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceName 是 string - - 接口名称。 "interface1"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/trend/5cd2d350-b530-4469-8df6-4e5b6c70ff6d?deviceType=1&beginTime=1568044800561&endTime=1568044800561 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:接口调用成功,响应体参考DeviceHealthListDto。 表3 DeviceHealthListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords integer [0-289] - 所有返回结果数。 12 data ARRAY_REFERENCE 0-289个列表项,详细请参见表4。 查询到的设备健康度。 - 表4 DeviceHealthDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [0-2147483647] - 时间戳。 1537407600 deviceHealthPoint int32 [0-100] - 设备健康点,表示设备健康度。 0 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:接口调用成功,响应体参考DeviceHealthListDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 12, "data" : [ { "timestamp" : 1537407600, "deviceHealthPoint" : 0 } ] } 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/v1/performanceservice/basicperformance/trend/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "5cd2d350-b530-4469-8df6-4e5b6c70ff6d" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceType 是 int32 - - 设备类型,该字段废弃,请填1。 1 beginTime 是 int64 - - 起始格林威治时间(时间精确到毫秒)。 1568044800561 endTime 是 int64 - - 结束格林威治时间(时间精确到毫秒)。 1568044800561
  • 响应示例 返回状态码为200:接口调用成功,响应体参考DeviceAlarmInfoResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "total" : 100, "data" : [ { "deviceMac" : "", "deviceName" : "", "siteName" : "", "alarmName" : "", "alarmLevel" : "", "alarmSuggestions" : "", "occurTime" : "0" } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:接口调用成功,响应体参考DeviceAlarmInfoResponse。 表2 DeviceAlarmInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码 "0" errmsg string 0~256个字符。 - 错误信息。 "" total int32 - - 数据总条数 100 data ARRAY_REFERENCE 详细请参见表3。 数据集合 - 表3 DeviceAlarmInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceMac string - - 设备mac地址 "" deviceName string - - 设备名 "" siteName string - - 站点 "" alarmName string - - 告警 "" alarmLevel string - - 告警级别 "" alarmSuggestions string - - 告警判断 "" occurTime string - - 告警产生时间 "0" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/performanceservice/basicperformance/queryDeviceAlarm 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,UUID格式。 - pageSize 是 integer - - 每页数据量 - pageNo 是 integer - - 当前页 -