日志报表

目录

错误码

Http Status Code ErrorCode desc
400 900 报表不存在
901 订阅不存在

1. 管理员日志-操作日志

描述

包括设备操作日志,用户日志和应用日志。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
Category 日志分类 Integer N 1:设备2:用户 3:应用 4:管理员登录 7:用户登录
operType 操作类型 String N
category operType desc
1 101 注册设备
102 删除未激活设备
104 淘汰设备
110 设备操作:锁定设备、擦除设备、发送消息(邮件)、标记丢失(找回)、播放铃声、设备定位等
2 201 用户操作:添加用户、更新用户、删除用户
202 用户组操作:添加用户组、更新用户组、删除用户组
3 301 应用/应用标签/黑白名单:添加应用、导入应用、更新应用基本信息、更新应用版本、卸载应用、 应用标签(增加、编辑、删除)、 黑白名单(创建、编辑、删除)
302 应用分配
paramName 查询参数 String N 操作者
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
loginid 登录名 String
ip 操作者IP地址 String
operType 操作类型 String
category operType desc
1 101 注册设备
102 删除未激活设备
104 淘汰设备
110 设备操作:锁定设备、擦除设备、发送消息(邮件)、标记丢失(找回)、播放铃声、设备定位等
2 201 用户操作:添加用户、更新用户、删除用户
202 用户组操作:添加用户组、更新用户组、删除用户组
3 301 应用/应用标签/黑白名单:添加应用、导入应用、更新应用基本信息、更新应用版本、卸载应用、 应用标签(增加、编辑、删除)、 黑白名单(创建、编辑、删除)
302 应用分配
operTime 操作时间 String 格式:yyyy-MM-dd hh:mm:ss
operDesc 操作描述 String
optAffected 影响谁/事 String
List

调用示例:

输入:

GET /logs/adminLog/device?category=1&operType=101&paramName=admin&access_token=e32b88126cbf4d0189a9ed0ef629da84

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"loginId": "admin",
"ip": "10.1.12.160",
"operType": "101",
"operTime": "2016-01-27 15:46:57",
"operDesc": "注册设备",
"optAffected": "deviceName"
}
]
}

2. 管理员日志-登录日志

描述

管理员的登录日志,包括登陆成功,登录失败和登出。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
operType 操作类型 String N
category operType desc
4 401 登陆成功
402 登出
403 登录失败
paramName 查询参数 String N 操作者
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
loginid 登录名 String
ip 操作者IP地址 String
operType 操作类型 String
category operType desc
4 401 登陆成功
402 登出
403 登录失败
operTime 操作时间 String 格式:yyyy-MM-dd hh:mm:ss
operDesc 操作描述 String
List

调用示例

GET /logs/adminLog/login?operType=403&paramName=10&access_token=38ddcf15e81b4b36b1245853a4612ed8

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"loginId": "admin",
"ip": "10.1.12.148",
"operType": "403",
"operTime": "2016-01-27 15:36:37",
"operDesc": "登录失败",
"optAffected": "admin"
}
]
}

3. 用户日志-操作日志

描述

查询普通用户在自服务平台上的设备操作。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
operType 操作类型 String N
category operType desc
8 801 设备注册
802 删除未激活设备
803 设备激活
804 设备淘汰
810 设备操作
paramName 查询参数 String N 操作者
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录 List 11

调用示例

GET /logs/userLog/device?access_token=dbafad4a1bae45

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"loginId": "liming01",
"ip": "10.1.12.160",
"operType": "801",
"operTime": "2016-03-07 09:49:58",
"operDesc": "注册设备",
"optAffected": "cxvbcxvb"
}
]
}

4. 用户日志-登录日志

描述

查询普通用户在自服务平台的登录登出日志。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
operType 操作类型 String N
category operType desc
7 701 登陆成功
702 登出
703 登录失败
paramName 查询参数 String N 操作者
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
loginid 登录名 String
ip 操作者IP地址 String
operType 操作类型 String
category operType desc
7 701 登陆成功
702 登出
703 登录失败
operTime 操作时间 String 格式:yyyy-MM-dd hh:mm:ss
operDesc 操作描述 String
List

调用示例

GET /logs/userLog/login?paramName=lim&startDate=2016-03-07&endDate=2016-03-07&access_token=dbafad4a1bae4592b5210cc5996c14b5

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [{
"loginId": "liming01",
"ip": "10.1.12.160",
"operType": "702",
"operTime": "2016-03-07 10:24:09",
"operDesc": "登出",
"optAffected": "liming01"
}]
}

5. 应用日志-黑白名单日志

描述

查询黑白名单应用的违规日志。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
platformType 平台 Integer N 1:Android 2:iOS
relationship 设备归属 Integer N 1:公司设备 2:员工设备 3:其它
paramName 应用名/操作者 String N
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
username 用户 String
mail 邮箱 String
groupname 用户组 String
deviceName 设备名称 String
relationship 设备归属 String 1:公司设备 2:员工设备 3:其它
createTime 违规时间 String 格式:yyyy-MM-dd hh:mm:ss
blackname 违规策略 String
appName 违规策略应用 String
platformType 平台 String 1:Android 2:iOS
List

调用示例

GET /logs/appLog?platformType=2&relationship=1&paramName=百家&startDate=2015-12-16&endDate=2015-12-16&access_token=b0204bd27ef44f18b6cb05a8f5bf39d2

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"username": "cl",
"mail": "cl@qq.com",
"groupname": "cl_group",
"deviceName": "cl_“nqtest”的 iPad",
"relationship": 1,
"createTime": "2015-12-16 17:00:06",
"blackname": "iOS白名单策略,应用名称、包名不正确",
"appName": "百家讲坛大全",
"platformType": 2
}
]
}

6. 应用日志-杀毒日志

描述

查询设备的杀毒日志。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
status 扫描状态 Integer N 0:含有危险 1:无危险
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
id 杀毒日志id Long
deviceName 设备名称 String
totalCount 扫描应用总数 Integer
scanTime 扫描时间 String 格式:yyyy-MM-dd hh:mm:ss
malwareCount 危险应用数 Integer
deviceId 设备id Long
List

调用示例

GET /logs/antivirusLog?paramName=zang&startDate=2015-05-11&endDate=2015-05-13&access_token=9d4b2012059046ecbf4ba8d2dfdc60aa

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 0,
"rows": []
}

7.  调试日志

描述

查询客户端上传日志的操作记录。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
status 状态 Integer N 0:等待上传 1:上传成功 2:上传失败 3:WIFI限制
startDate 起始日期 String N 格式:yyyy-MM-dd
endDate 截止日期 String N 格式:yyyy-MM-dd
paramName 查询参数 String N 文件名/设备名/登录名

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
id 日志id Long
fileName 文件名称 String
deviceName 设备名称 String
loginId 账户 String
model 设备型号 String 例如:MC319LL
platformType 平台 Integer 0:其它,1:android, 2:ios
os 操作系统平台 String
versionNum 版本号 String
uploadDateTime 上传时间 String 格式:yyyy-MM-dd hh:mm:ss
operator 操作者 String
status 日志上传状态 Integer 0:等待上传, 1:上传成功, 2:上传失败 3:WIFI限制
List

调用示例

GET /logs/debugLog?status=0&paramName=tai&startDate=2016-01-15&endDate=2016-01-16&access_token=a143eb88cfc042c79cfec34eb7db5614

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"fileName": "tainy-20160115174757-phyq.zip",
"deviceName": "genymotion",
"loginId": "tainy",
"model": "XT1570",
"platformType": 1,
"os": "Android",
"versionNum": "5.1.1",
"uploadDateTime": "2016-01-15 17:47:57",
"operator": "admin",
"status": 0
}
]
}

8. 删除调试日志

描述

删除指定的调试日志记录

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
ids 日志ids List Y 多个id用”,”间隔

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

DELETE /logs/debugLog/{ids} -------------------------------------{ids}日志ids
DELETE /logs/debugLog/1,2,3?access_token=a143eb88cfc042c79cfec34eb7db5614

输出:

HTTP/1.1 200 OK 

9. 下载客户端上传的文件

描述

下载客户端上传的调试日志文件

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
id 日志id Long Y

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

GET /logs/debugLog/{id} --------------------------------{id}日志id

GET /logs/debugLog/1?access_token=a143eb88cfc042c79cfec34eb7db5614

输出:

HTTP/1.1 200 OK 

10. 查询报表列表

描述

获得可操作的报表列表。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
id 报表id String
reportName 名称 String
reportType 类型 String
description 描述 String
status 订阅状态 Integer 0:无订阅;1:已订阅
List

调用示例

GET /reports?language=zh_CN&access_token=f4b22b0ac9774782b0382b15fc0b0cb8

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 6,
"rows": [
{
"id": "activeDeviceList",
"reportName": "激活设备报表",
"reportType": "设备",
"description": "已激活设备列表",
"status": 1
},
{
"id": "assetList",
"reportName": "资产报表",
"reportType": "设备",
"description": "已激活、已擦除、已淘汰设备列表",
"status": 0
},
{
"id": "deviceList",
"reportName": "设备报表",
"reportType": "设备",
"description": "已激活、已擦除设备列表",
"status": 0
},
{
"id": "erasedDeviceList",
"reportName": "淘汰设备报表",
"reportType": "设备",
"description": "已擦除、已淘汰设备列表",
"status": 0
},
{
"id": "scanVirusDeviceList",
"reportName": "设备杀毒报表",
"reportType": "设备",
"description": "设备最新一次杀毒信息报表",
"status": 0
},
{
"id": "violationDeviceList",
"reportName": "设备违规报表",
"reportType": "设备",
"description": "已违规的设备",
"status": 1
}
]
}

11. 查询订阅列表

描述

查询指定报表的订阅信息列表。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
reportId 报表id String Y

输出参数

输出参数 参数说明 参数类型 备注
id id String
subScribeName 名称 String
creator 创建者 String
description 描述 String
email 邮箱 String
lastExecStatus 上次执行状态 Integer 上次执行状态,0–成功;-1–失败
lastExecTime 上次执行时间 String 格式:yyyy-MM-dd hh:mm:ss

调用示例:

GET /reports/{reportId}/subscriptions ----------------------------------{reportId} 报表id

GET /reports/activeDeviceList/subscriptions?access_token=90c24ce7c7a145c0896e750b86477366

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [
{
"id": "9db20e73-ad79-4c67-b918-33dccc6c4f35",
"subScribeName": "测试",
"creator": "admin",
"description": "",
"email": "565003920@qq.com",
"lastExecStatus": -1,
"lastExecTime": "2016-02-18 17:43:00"
}
]
}

12. 查询设备报表

描述

统计已激活、已擦除设备。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
Sequence 序号 Integer
deviceName 设备名称 String
Ownership 所属关系 String
loginId 账户 String
username 用户名 String
groupName 组名 String
Mail 邮件 String
Model 设备型号 String
Os 操作系统平台 String
versioNum 系统版本 String
serialNum 设备序列号 String
Imei imei String
deviceStatus 设备状态 String
isRootOrJailbreak 设备是否越狱 String
activateTime 激活时间 TimeStamp
updateTime 更新时间 TimeStamp
List

调用示例

GET /reports/devices?access_token=b77851ec44914346a71b05cd75e3772b

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 60,
"rows": [
{
"sequence": "1",
"deviceName": "hhhhhhhhu",
"deviceOwnership": 2,
"loginId": "uuuuyy",
"userName": "yy",
"groupName": "",
"mail": "yyy@ww",
"model": "",
"os": "iOS",
"versioNum": "",
"serialNum": "",
"imei": "",
"status": 2,
"type": 2,
"activateTime": null,
"updateTime": 1453099774000,
"lostFlag": 0,
"rootFlag": null,
"jailbreakFlag": null,
"phoneCode": "",
"remark": "",
"ownership": "员工",
"deviceStatus": "正常",
"isRootOrJailbreak": "否",
"washoutTime": null
}
]
}

13. 导出设备报表

描述

导出已激活、已擦除设备报表。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

GET /reports/devices/file?access_token=ebe5fc72c4e0432c8811a55d95939f0d

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=deviceList.pdf

14. 查询资产统计报表

描述

统计已激活,已擦除或已淘汰的设备

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
sequence 序号 Integer
deviceName 设备名称 String
ownership 所属关系 String
loginId 账户 String
userName 用户名 String
groupName 组名 String
mail 邮件 String
model 设备型号 String
os 操作系统平台 String
versioNum 系统版本 String
serialNum 设备序列号 String
imei imei String
deviceStatus 设备状态 String
activateTime 激活时间 TimeStamp
updateTime 更新时间 TimeStamp
List

调用示例

GET /reports/assets?access_token=234f2166b96f47d989b8f5e3f9fd4e72

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 127,
"rows": [
{
"sequence": "1",
"deviceName": "aaa_iPad",
"deviceOwnership": 1,
"loginId": "aaa",
"userName": "test_ad_test",
"groupName": "test group",
"mail": "gaohongtao@nationksy.com",
"model": "MC705CH",
"os": "iOS",
"versioNum": "9.0.2",
"serialNum": "DMPJ2CZ7DJ8T",
"imei": "",
"status": 0,
"type": 2,
"activateTime": 1449036589000,
"updateTime": 1449196176000,
"lostFlag": 0,
"rootFlag": 0,
"jailbreakFlag": 0,
"phoneCode": "",
"remark": "",
"ownership": "企业",
"deviceStatus": "已淘汰",
"isRootOrJailbreak": "否",
"washoutTime": 1449196176000
}
]
}

15. 导出资产统计报表

描述

导出已激活,已擦除或已淘汰的设备报表

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

GET /reports/assets/file?access_token=234f2166b96f47d989b8f5e3f9fd4e72

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=assetList.pdf

16. 查询激活设备统计报表

描述

统计已激活设备

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
sequence 序号 Integer
deviceName 设备名称 String
ownership 所属关系 String
loginId 账户 String
userName 用户名 String
model 设备型号 String
os 操作系统平台 String
versioNum 系统版本 String
serialNum 设备序列号 String
imei imei String
isRootOrJailbreak 设备是否越狱 String
activateTime 激活时间 TimeStamp
List

调用示例

GET /reports/activeDevices?access_token=234f2166b96f47d989b8f5e3f9fd4e72

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 51,
"rows": [
{
"sequence": "1",
"deviceName": "TestAppName1451986133338_AndroidDevice",
"deviceOwnership": 1,
"loginId": "TestAppLoginId1451986133338",
"userName": "TestAppName1451986133338",
"groupName": "TestAppGroup1451986133326",
"mail": "TestAppMail@126.com",
"model": "",
"os": "Android",
"versioNum": "",
"serialNum": "",
"imei": "",
"status": 2,
"type": 1,
"activateTime": null,
"updateTime": -28800000,
"lostFlag": 0,
"rootFlag": 0,
"jailbreakFlag": 0,
"phoneCode": "",
"remark": "",
"ownership": "企业",
"deviceStatus": "正常",
"isRootOrJailbreak": "否",
"washoutTime": null
}
]
}

17. 导出激活设备统计报表

描述

导出已激活设备报表

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

GET /reports/activeDevices/file?access_token=234f2166b96f47d989b8f5e3f9fd4e72

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=activeDeviceList.pdf

18. 查询已淘汰设备报表

描述

统计已擦除、已淘汰的设备

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
sequence 序号 Integer
deviceName 设备名称 String
ownership 所属关系 String
loginId 账户 String
userName 用户名 String
model 设备型号 String
os 操作系统平台 String
versioNum 系统版本 String
serialNum 设备序列号 String
imei imei String
isRootOrJailbreak 设备是否越狱 String
deviceStatus 设备状态 String
remark 备注 String
washoutTime 擦除时间 TimeStamp
Integer

调用示例

GET /reports/erasedDevices?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 77,
"rows": [{
"sequence": "1",
"deviceName": "aaa_iPad",
"deviceOwnership": 1,
"loginId": "aaa",
"userName": "test_ad_test",
"groupName": "test group",
"mail": "gaohongtao@nationksy.com",
"model": "MC705CH",
"os": "iOS",
"versioNum": "9.0.2",
"serialNum": "DMPJ2CZ7DJ8T",
"imei": "",
"status": 0,
"type": 2,
"activateTime": 1449036589000,
"updateTime": 1449196176000,
"lostFlag": 0,
"rootFlag": 0,
"jailbreakFlag": 0,
"phoneCode": "",
"remark": "",
"ownership": "企业",
"deviceStatus": "已淘汰",
"isRootOrJailbreak": "否",
"washoutTime": 1449196176000
}]
}

19. 导出已淘汰设备报表

描述

导出已擦除、已淘汰的设备报表

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误

调用示例

GET /reports/erasedDevices/file?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=erasedDeviceList.pdf

20. 查询违规设备报表

描述

统计已违规的设备。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
violationIds 合规ids String N
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
sequence 序号 Integer
deviceName 设备名称 String
ownership 所属关系 String
loginId 账户 String
userName 用户名 String
model 设备型号 String
os 操作系统平台 String
versioNum 系统版本 String
serialNum 设备序列号 String
imei imei String
isRootOrJailbreak 设备是否越狱 String
activateTime 激活时间 TimeStamp
policyName 违反策略 String
isProcess 是否已处理 String
processMethod 违规处理方式 String
violateTime 违规时间 TimeStamp
List

调用示例

GET /reports/violationDevices?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 152,
"rows": [
{
"sequence": "1",
"violateTime": 1449467252000,
"deviceName": "leiwuluan_Android",
"deviceOwnership": 1,
"ownership": "企业",
"loginId": "leiwuluan",
"userName": "雷武銮",
"model": "MediaPad 10 LINK",
"os": "Android",
"versioNum": "4.0.4",
"serialNum": "H4F6RA9330502663",
"imei": "H4F6RA9330502663",
"rootFlag": 1,
"jailbreakFlag": 0,
"isRootOrJailbreak": "是",
"activateTime": 1449466018000,
"policyName": "asf",
"processStatus": 1,
"isProcess": "处理成功",
"processMethod": "禁用摄像头",
"type": 1
}
]
}

21. 导出违规设备统计报表

描述

导出已违规的设备报表

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
violationIds 合规ids String N
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误

调用示例:

GET /reports/violationDevices/file?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=violationDeviceList.pdf

22. 查询设备杀毒报表

描述

统计设备杀毒的信息

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误
total 记录数 Integer
rows 记录

输出参数 参数说明 参数类型 备注
sequence 序号 Integer
deviceName 设备名称 String
totalCount 扫描应用数 Integer
malwareCount 危险应用数 Integer
scanTime 扫描时间 TimeStamp
List

调用示例

GET /reports/scanVirusDevices?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 4,
"rows": [
{
"sequence": "1",
"deviceName": "dd",
"totalCount": 10,
"malwareCount": 5,
"scanTime": 1452584689000
}
]
}

23. 导出设备杀毒报表

描述

导出设备杀毒报表

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
format 导出文件格式 String N pdf,xls
groupId 用户组 String N
ownership 设备所属关系 String N 1:公司设备 2:员工设备 3:其它
platform 设备平台 String N 1:Android 2:iOS
startTime 起始日期 String N 格式:yyyy-MM-dd
endTime 截止日期 String N 格式:yyyy-MM-dd,会在输入日期后增加23:59:59
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误

调用示例

GET /reports/scanVirusDevices/file?access_token=65381a286c2048f5b44a0b5a5c056e73

输出:

HTTP/1.1 200 OK 
application/pdf;charset=UTF-8
Content-Disposition:attachment; filename=scanVirusDeviceList.pdf

24. 新增订阅

描述

创建报表订阅,根据订阅信息,按时向订阅者发送邮件,内含报表文件。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
groupIds 用户组ids List Y json数组
relationShips 设备所属关系 List Y json数组
platformTypes 平台 List N json数组,排除杀毒报表,都需要传入平台
violationIds 合规id List N json数组,仅合规设备报表需要传入
format 附件格式 Integer Y 0–Excel;1–PDF
subScribeName 订阅名称 String Y
email 邮件 String Y
cycleType 订阅周期类型 Integer Y 0–日报;1–周报;2–月报
subsTime 订阅的时间 String Y 日报时间如HH:mm;周报为本周周几;月报为本月第几天
description 描述 String N
reportId Biao String Y
备注
activeDeviceList 激活设备报表
assetList 资产设备报表
deviceList 设备报表
erasedDeviceList 已淘汰设备报表
scanVirusDeviceList 设备杀毒报表
violationDeviceList 违规设备报表
reportCycle 报表周期类型 Integer Y 0–关注所有;1–关注本期
language 语言 String N 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误
id 订阅id String

调用示例

POST /subscribes?access_token=49558506c5ef40bdac6418b00cf4b66c

输入:

Content-Type: application/json;charset=UTF-8
{
"groupIds":[-2],
"relationShips":[1],
"platformTypes":[1],
"format":0,
"subScribeName":"aaa",
"email":"565003920@qq.com",
"cycleType":0,
"subsTime":"16:10",
"description":"description",
"reportId":"activeDeviceList",
"reportCycle":0,
"language":"zh_CN"
}

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"id": "c3dff8dd-a56e-45b6-87a4-f7935f6fc226"
}

25. 编辑订阅

描述

对于已存在的报表订阅进行编辑,修改相应信息。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
subscribeId 报表订阅id String Y
reportId 报表id String Y
备注
activeDeviceList 激活设备报表
assetList 资产设备报表
deviceList 设备报表
erasedDeviceList 已淘汰设备报表
scanVirusDeviceList 设备杀毒报表
violationDeviceList 违规设备报表
groupIds 用户组ids List N json数组
relationShips 设备所属关系 List N json数组
platformTypes 平台 List N json数组,排除杀毒报表,都需要传入平台
violationIds 合规id List N json数组,仅合规设备报表需要传入
format 附件格式 Integer N 0–Excel;1–PDF
subScribeName 订阅名称 String N
email 邮件 String N
cycleType 订阅周期类型 Integer N 0–日报;1–周报;2–月报
subsTime 订阅的时间 String N 日报时间如HH:mm;周报为本周周几;月报为本月第几天
description 描述 String N
reportCycle 报表周期类型 Integer N 0–关注所有;1–关注本期

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误

调用示例

PUT  /subscribes/{subscribeId} -----------------------------------------------{subscribeId}报表订阅id

PUT /subscribes/a4dd7faf-778b-463d-865d-28b5223d5a7c?access_token=1e1aa35909b14f9eb7f20bfac03419f2

输入:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"platformTypes": [1,2],
"format": 1,
"subScribeName": "test",
"email": "565003920@qq.com",
"cycleType": 0,
"subsTime": "17:09",
"description": "test",
"reportId":"activeDeviceList",
"reportCycle": 1
}

输出:

HTTP/1.1 200 OK

26. 订阅详情

描述

查询订阅的详细信息。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
subscribeId 报表订阅id String Y

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误
subscribe 订阅信息

输出参数 参数说明 参数类型 备注
id 报表订阅id String
reportId 报表id String
备注
activeDeviceList 激活设备报表
assetList 资产设备报表
deviceList 设备报表
erasedDeviceList 已淘汰设备报表
scanVirusDeviceList 设备杀毒报表
violationDeviceList 违规设备报表
groupIds 用户组ids List json数组
relationShips 设备所属关系 List json数组
platformTypes 平台 List json数组,排除杀毒报表,都需要传入平台
violationIds 合规id List json数组,仅合规设备报表需要传入
format 附件格式 Integer 0–Excel;1–PDF
subScribeName 订阅名称 String
email 邮件 String
cycleType 订阅周期类型 Integer 0–日报;1–周报;2–月报
subsTime 订阅的时间 String 日报时间如HH:mm;周报为本周周几;月报为本月第几天
description 描述 String
reportCycle 报表周期类型 Integer 0–关注所有;1–关注本期
creator 创建者 String
language 语言 String 中文:zh_CN,英文:en 日语:ja_JP 默认:zh_CN
lastExecTime 上次执行时间 String
lastExecStatus 上次执行状态 Integer 1:待执行 0:成功 -1:失败
Object

调用示例

GET /subscribes/{subscribeId} -----------------------------------------------{subscribeId}报表订阅id

GET /subscribes/aa7c3381-8f2d-435b-9245-85b51c8b0942?access_token=c3cfa65b568140c689c81cfed133f675

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"subscribe": {
"groupIds": [-2],
"relationShips": [1],
"platformTypes": [1],
"violationIds": [],
"format": 0,
"subScribeName": "aaa",
"email": "565003920@qq.com",
"cycleType": 0,
"subsTime": "16:10",
"description": "description",
"reportId": "activeDeviceList",
"reportCycle": 0,
"language": "zh_CN",
"id": "3135f501-8ce9-4b76-af18-e43352cf87dc",
"creator": "admin",
"lastExecTime": null,
"lastExecStatus": null
}
}

 27. 删除订阅

描述

删除报表的订阅信息,同时删除定时任务。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
subscribeId 报表订阅id String Y

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误

调用示例

DELETE subscribes/{subscribeId} -----------------------------------------------{subscribeId}报表订阅id

DELETE /subscribes/aa7c3381-8f2d-435b-9245-85b51c8b0942?access_token=c3cfa65b568140c689c81cfed133f675

输出:

HTTP/1.1 200 OK