GET -数据请求

介绍终端监控接口的数据请求调用方式。

接口介绍

查询指定策略名的策略步骤。

请求方式（HTTP/1.1）

GET

接口地址

https://UCSS_URL/qkact/v0/dlp/endpoint/states?fqdn=xxx&ip=xxx&user=xxx
  • <fqdn>是终端FQDN。
  • <ip>是终端IP。
  • <user>支持域名\用户名、用户名两种格式。
注： <fqdn>、<ip>和<user>不能同时为空，否则会返回参数错误响应。

请求参数

参数名称 参数位置 值 是否必须 描述
Content-Type header application/json 是 定义网络文件的类型和网页的编码。
Authorization header Basic base64("client-id:access-token") 是 base64加密的Http Basic认证。
即Basic 加密串，如Basic dXNlcjp1c2Vy。
注： client-id是客户端ID，access-token是在获取认证时返回的值。参考章节获取认证，获取access-token。
User-Agent header QKAct-External-Client 是 检查浏览页面的访问者在用什么操作系统（包括版本号）浏览器（包括版本号）和用户个人偏好的代码。

返回结果

{
 "message": "成功",
 "data": [
 {
     "uuid": "73876C6783796D7688697B6B66748386",
     "shortId": "000D3684",
     "hostname": "vm-2a43e4d632f0",
     "systemTime": 1514536137000,
     "hostStartTime": 1514505538000,
     "ucscStartTime": 1514534621000,
     "osName": "Microsoft Windows XP",
     "osType": "",
     "osVersion": null,
     "cpuName": "Intel(R) Core(TM) i5-4590 CPU @ 3.30GHz",
     "cpuCount": 1,
     "memorySize": 0,
     "terminalType": 2,
     "terminalStatus": 2,
     "location": 1,
     "epDomain": "",
     "userCommonName": "",
     "loginUser": "vm-2a43e4d632f0\\Administrator",
     "userOu": "CN=Users,DC=adserver,DC=skyguard,DC=com",
     "userGroup": "Domain Admins,Enterprise Admins,Group Policy Creator Owners,Administrators,Remote Desktop Users,Schema Admins",
     "userDepartment": "",
     "activeMac": "00-0c-29-62-90-1c",
     "activeIp": "192.168.25.131",
     "protectionStatus": 2,
     "epVersion": "1.0.0",
     "workMode": 2,
     "displayMode": 2,
     "activeDmServer": "73876C6783796D7688697B6B66748386",
     "activeDmVersion": "",
     "forbiddenDevices": "",
     "syncResult": 0,
     "syncTime": null,
     "epPolicyVersion": null,
     "epFpVersion": null,
     "epProgramVersion": null,
     "epProfileName": null,
     "epProfileVersion": null,
     "discoveryStatus": 6,
     "lastScanBeginTime": 1514534638000,
     "lastScanEndTime": 1514534663000,
     "nextScanBeginTime": null,
     "scannedFileCount": 135,
     "scannedHitCount": 4,
     "lastScanResult": 1,
     "dmServerId": "172.20.36.66",
     "batchId": 17,
     "spsSyncTime": 1514564939000,
     "withSpecialConfig": false,
     "sipEnabled": false,
     "specialConfig": {
         "version": 1,
         "name": null,
         "uuid": null,
         "id": null,
         "creator": null,
         "lastUpdateTime": null,
         "preset": false,
         "forbiddenAgent": null,
         "allowDiagnose": null,
         "scene": null,
         "forbiddenDevices": null,
         "forbiddenEnabled": true,
         "uninstallPassword": null,
         "unipwdMaxage": 0,
         "updatePart": null,
         "devices": "null",
         "tableName": null
             },
     "ucscLogState": 0,
     "ucscLogFileName": null,
     "integrationId": 0,
     "integrationName": null,
     "allowDiagnose": false,
     "rmsDecryptResult": 1,
     "rmsDecryptFailedMessage": null
 }
 ]
}
返回值参数定义如下表所示：
参数名 说明
message 请求成功和失败的对应消息
uuid UUID的值
shortId 简短型UUID的值
hostname 终端主机名
systemTime 终端系统时间
hostStartTime 终端系统启动时间
ucscStartTime 终端agent启动时间
osName 终端操作系统
osType 操作系统类型。如WorkStation/Server
osVersion 操作系统版本
cpuName CPU名称，如：Xeon 2650 2.8GH
cpuCount CPU数量
memorySize 内存大小，单位byte
terminalType 终端设备类型。
  • EPTT_NONE = 0
  • EPTT_LAPTOP = 1
  • EPTT_WORKSTATION = 2
terminalStatus 终端设备状态。
  • NONE = 0
  • ONLINE = 1
  • OFFLINE = 2
location 终端位置。
  • EPL_NONE = 0
  • EPL_INTERNAL = 1
  • EPL_EXTERNAL = 2
epDomain 终端所性域
loginUser 登录终端设备帐号
userCommonName 登录终端设备帐号名称
userOu 登录终端设备帐号所属OU
userGroup 登录终端设备帐号所属组
userDepartment 登录终端设备帐号所属部门
networkCard 网卡信息，数据结构如下：
{
"name":"",
"type":"",
"description":"",
"mac":"",
"ipv4s":[],
"ipv6s":[]
}
activeMac 终端当前在用Mac
activeIp 终端在用IP
protectionStatus 终端禁用状态
  • EPS_NONE = 0
  • EPS_DISABLED = 1
  • EPS_ENABLED = 2
  • EPS_DISABLED_BYPASS = 3
epVersion 终端版本
displayMode 运行模式
  • EPDM_NONE = 0
  • EPDM_TRANSPARENT = 1
  • EPDM_EXPLICIT = 2
workMode 工作模式
  • EPWM_NONE = 0
  • EPWM_BLOCK = 1
  • EPWM_MONITOR = 2
activeDmServer 当前连接的dm服务器名称
activeDmVersion 当前连接的终端服务器系统版本
forbiddenDevices 终端禁用设备
  • DT_NONE = 0
  • DT_USB_STORAGE = 1
  • DT_INFRARED = 2
  • DT_BLUETOOTH = 3
  • DT_IEEE_1394 = 4
  • DT_PCMCIA = 5
  • DT_CD_WRITER = 6
  • DT_FLOPPY_DISK = 7
  • DT_LPT = 8
  • DT_COM = 9
  • DT_PRINTSCREEN = 10
  • EPDT_AIRDROP = 11
  • EPDT_USB_WIFI = 12
  • EPDT_USB_BLUETOOTH = 13
  • EPDT_MTP_PTP = 14
  • EPDT_CD_WRITER_RO = 20
  • EPDT_USB_STORAGE_RO = 21
  • EPDT_MTP_PTP_RO = 22
syncResult 终端配置同步状态
  • EPSS_SUCCESS = 0
  • EPSS_FAILED = 1
syncTime 终端配置同步时间
epPolicyVersion 终端策略版本
epFpVersion 终端指纹库版本
epProgramVersion 终端软件库版本
epProfileName 终端组配置名称
epProfileVersion 终端组配置版本
discoveryStatus 数据发现扫描状态
  • EPDSS_NONE = 0
  • EPDSS_DISABLED = 1
  • EPDSS_INPROGRESS = 2
  • EPDSS_IDLE = 3
lastScanBeginTime 数据发现上次扫描开始时间
lastScanEndTime 数据发现上次扫描结束时间
nextScanBeginTime 数据发现下次扫描开始时间
scannedFileCount 数据发现扫描的文件数量
scannedHitCount 数据发现扫描命中的事件数量
lastScanResult 数据发现扫描结果
  • EPDS_NONE = 0
  • EPDS_SUCCESS = 1
  • EPDS_ERROR = 2
dmServerId 提取数据的dmserver标识
batchId 数据同步的批次或版本
spsSyncTime SPS从终端服务器中获取数据的时间
sipEnabled mac sip功能是否开启
ucscLogState ucsc日志状态
integrationId 集成厂商ID
integrationName 集成厂商名称
allowDiagnose 终端健康诊断配置状态
rmsDecryptResult 终端RMS解密结果
  • NONE:0
  • OK:1
  • NG:2
  • NA:100
rmsDecryptFailedMessage 终端RMS解密失败信息

响应码

调用接口时，将返回以下代码
响应码 描述
200 请求成功
500 服务内部出错