调用GetUserDevice接口查询用户终端设备详情-办公安全平台-阿里云-办公安全平台(SASE)-阿里云帮助中心

查询当前阿里云账号下用户终端设备详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

csas:GetUserDevice

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DeviceTag	string	是	终端设备 ID。取值： GetUserDevice ：查询用户终端设备详情。 ListUserDevices ：批量查询用户终端设备。	36efa42d-2c32-c4dc-e3fc-8541e33a****

返回参数

名称	类型	描述	示例值
	object	Schema of Response。
RequestId	string	本次请求的 ID。	EFE7EBB2-449D-5BBB-B381-CA7839BC1649
Device	object	终端设备。
DeviceTag	string	终端设备 ID。	36efa42d-2c32-c4dc-e3fc-8541e33a****
DeviceType	string	终端设备操作系统类型。取值： Windows：Windows 系统。 macOS：macOS 系统。 Linux：Linux 系统。 Android：Android 系统。 iOS：iOS 系统。 Windows_Wuying：无影云桌面系统。枚举值： Linux : Linux 系统 Windows_Wuying : 无影云桌面系统 Windows : Windows 系统 iOS : iOS 系统 macOS : macOS 系统 Android : Android 系统	Windows
DeviceModel	string	终端设备型号。	MacBookPro17,1
DeviceVersion	string	终端设备操作系统版本。	3.5.1
Hostname	string	终端设备名称。	win10-64bit
Username	string	用户名。	王先生
SaseUserId	string	用户 ID。	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department	string	用户所属部门。	测试部
InnerIP	string	终端设备内网 IP 地址。	172.16.XX.XX
SrcIP	string	终端设备登录 IP 地址。	106.14.XX.XX
Memory	string	终端设备内存容量。单位：GB。	16
CPU	string	终端设备 CPU 型号。	Apple M1
Disk	string	终端设备磁盘型号。	APPLE SSD AP0512Q Media
Mac	string	终端设备 MAC 地址。	48:9e:XX:XX:02:80
AppVersion	string	客户端版本。	2.2.0
DeviceBelong	string	终端设备归属。取值： Personal：个人设备。 Company：公司设备。枚举值： Company : 公司设备 Personal : 个人设备	Company
SharingStatus	boolean	设备是否开启共享。取值： true：开启共享。 false：关闭共享。枚举值： true : 开启共享 false : 关闭共享	true
DeviceStatus	string	终端设备状态。取值： Online：在线。 Offline：离线。 LongTermOffline：长期离线。 Locked：锁定。 Lost：挂失。 Unbound：解绑。枚举值： Lost : 挂失 Locked : 锁定 LongTermOffline : 长期离线 Offline : 离线 Unbound : 解绑 Online : 在线	Online
AppStatus	string	客户端状态。取值： Online：在线。 Offline：离线。枚举值： Offline : 离线 Online : 在线	Online
PaStatus	string	内网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。枚举值： Enabled : 在线 Disabled : 离线 Unprovisioned : 未配置	Enabled
IaStatus	string	互联网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。枚举值： Enabled : 开启 Disabled : 关闭 Unprovisioned : 未配置	Disabled
DlpStatus	string	办公数据保护状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。 Unauthorized：未授权。枚举值： Enabled : 开启 Unauthorized : 未授权 Disabled : 关闭 Unprovisioned : 未配置	Unauthorized
NacStatus	string	网络准入状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。枚举值： Enabled : 开启 Disabled : 关闭 Unprovisioned : 未配置	Unprovisioned
CreateTime	string	终端设备注册时间。	2023-05-16 17:18:46
UpdateTime	string	终端设备最后在线时间。	2023-08-24 19:04:42
HistoryUsers	array<object>	终端设备历史用户集合。
	object	终端设备历史用户。
Username	string	用户名。	张女士
SaseUserId	string	用户 ID。	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
EdrStatus	string	反入侵状态。取值： Enabled：开启。 Disabled：关闭。枚举值： Enabled : 开启 Disabled : 关闭	Disabled
AutoLoginStatus	string	设备免登状态。取值：生效中：Enabled。未生效：Disabled。未启用：Unprovisioned。	Enabled
NetInterfaceInfo	array<object>	终端网卡列表。
	object	终端网卡列表。
Name	string	网卡名称。	eth0
Mac	string	网卡 MAC 地址。	00:16:XX:XX:7c:46
Workshop	string	办公区名称。	测试办公区
MatchDeviceGroupIds	array	匹配设备组 ID 集合。
	string	设备组 ID。	device-group-5191cf830a5e****
SnSystem	string	系统 sn 码。	KVN9C9****
SnDiskDrive	string	硬盘 sn 码。	WD-WXR1A99A****
SnBaseBoard	string	主板 sn 码。	PJGGU00WBD****
SnProcessor	string	处理器 sn 码。	BFEBFBFF0008****
SnBios	string	bios 系统 sn 码。	5CG003****
BatteryHealthPercentage	integer
BatteryRemainingPercentage	integer
DiskAvailable	integer
DiskUsed	integer
Processes	array<object>
	object
Name	string
Description	string
Cpu	number
Memory	integer
TerminalInfoCollectTime	integer
JoinAdDomain	boolean
Continent	string
Country	string
Province	string
City	string

示例

正常返回示例

JSON格式

{
  "RequestId": "EFE7EBB2-449D-5BBB-B381-CA7839BC1649",
  "Device": {
    "DeviceTag": "36efa42d-2c32-c4dc-e3fc-8541e33a****",
    "DeviceType": "Windows",
    "DeviceModel": "MacBookPro17,1",
    "DeviceVersion": "3.5.1",
    "Hostname": "win10-64bit",
    "Username": "王先生",
    "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****",
    "Department": "测试部",
    "InnerIP": "172.16.XX.XX",
    "SrcIP": "106.14.XX.XX",
    "Memory": "16",
    "CPU": "Apple M1",
    "Disk": "APPLE SSD AP0512Q Media",
    "Mac": "48:9e:XX:XX:02:80",
    "AppVersion": "2.2.0",
    "DeviceBelong": "Company",
    "SharingStatus": true,
    "DeviceStatus": "Online",
    "AppStatus": "Online",
    "PaStatus": "Enabled",
    "IaStatus": "Disabled",
    "DlpStatus": "Unauthorized",
    "NacStatus": "Unprovisioned",
    "CreateTime": "2023-05-16 17:18:46",
    "UpdateTime": "2023-08-24 19:04:42",
    "HistoryUsers": [
      {
        "Username": "张女士",
        "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****"
      }
    ],
    "EdrStatus": "Disabled",
    "AutoLoginStatus": "Enabled",
    "NetInterfaceInfo": [
      {
        "Name": "eth0",
        "Mac": "00:16:XX:XX:7c:46"
      }
    ],
    "Workshop": "测试办公区",
    "MatchDeviceGroupIds": [
      "device-group-5191cf830a5e****"
    ],
    "SnSystem": "KVN9C9****",
    "SnDiskDrive": "WD-WXR1A99A****",
    "SnBaseBoard": "PJGGU00WBD****",
    "SnProcessor": "BFEBFBFF0008****",
    "SnBios": "5CG003****",
    "BatteryHealthPercentage": 0,
    "BatteryRemainingPercentage": 0,
    "DiskAvailable": 0,
    "DiskUsed": 0,
    "Processes": [
      {
        "Name": "",
        "Description": "",
        "Cpu": 0,
        "Memory": 0
      }
    ],
    "TerminalInfoCollectTime": 0,
    "JoinAdDomain": true,
    "Continent": "",
    "Country": "",
    "Province": "",
    "City": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。