使用ListUserDevices批量查询用户终端设备-办公安全平台-阿里云-办公安全平台(SASE)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CurrentPage	long	是	分页查询时显示的当前页的页码。取值：1~10000。	1
PageSize	long	是	分页查询时设置的每页数量。取值范围：1~500。	10
Username	string	否	用户名。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。	王先生
SaseUserId	string	否	用户 ID。取值来源： GetUserDevice ：查询用户终端设备详情。 ListUserDevices ：批量查询用户终端设备。	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department	string	否	用户所属部门。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。	测试部
Hostname	string	否	终端设备名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。单独输入下划线（_）将额外查询所有名称中带 4 字节 utf-8 字符的终端设备。	win10-64bit
DeviceBelong	string	否	终端设备归属。取值： Personal：个人设备。 Company：公司设备。	Company
Mac	string	否	终端设备 MAC 地址。	00:16:XX:XX:7c:46
SharingStatus	boolean	否	设备是否开启共享。取值： true：开启共享。 false：关闭共享。	true
DeviceStatuses	array	否	终端设备状态集合。
	string	否	终端设备状态。取值： Online：在线。 Offline：离线。包括长期离线状态。 LongTermOffline：长期离线。 Locked：锁定。 Lost：挂失。 Unbound：解绑。枚举值： Lost：挂失。 Locked：锁定。 LongTermOffline：长期离线。 Offline：离线(包括长期离线)。 Unbound：解绑。 Online：在线。	Online
AppStatuses	array	否	客户端状态集合。
	string	否	客户端状态。取值： Online：在线。 Offline：离线。	Online
PaStatuses	array	否	内网访问状态集合。
	string	否	内网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Enabled
IaStatuses	array	否	互联网访问状态集合。
	string	否	互联网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Disabled
DlpStatuses	array	否	办公数据保护状态集合。
	string	否	办公数据保护状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。 Unauthorized：未授权。	Enabled
NacStatuses	array	否	网络准入状态集合。
	string	否	网络准入状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Unprovisioned
DeviceTypes	array	否	终端设备操作系统类型集合。
	string	否	终端设备操作系统类型。取值： Windows：Windows 系统。 macOS：macOS 系统。 Linux：Linux 系统。 Android：Android 系统。 iOS：iOS 系统。 Windows_Wuying：无影云桌面系统。	Windows
DeviceTags	array	否	终端设备 ID 集合。
	string	否	终端设备 ID。取值： GetUserDevice ：查询用户终端设备详情。 ListUserDevices ：批量查询用户终端设备。	36efa42d-2c32-c4dc-e3fc-8541e33a****
SortBy	string	否	排序参数。取值： Username：按 Username 升序排列。 AppVersion：按 AppVersion 降序排列。 UpdateTime：按 UpdateTime 降序排列。 CreateTime：按 CreateTime 降序排列。	UpdateTime
InnerIp	string	否	终端设备内网 IP 地址。	192.168.XX.XX
AppVersions	array	否	客户端版本集合。
	string	否	客户端版本。	4.5.0
Workshop	string	否	办公区名称。	测试办公区
DeviceGroupId	string	否	设备组 ID。	device-group-5191cf830a5e****
SnSystem	string	否	系统 sn 码。	KVN9C9****

返回参数

名称	类型	描述	示例值
	object	Schema of Response。
RequestId	string	本次请求的 ID。	5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D
TotalNum	long	终端设备总数。	1
Devices	array<object>	终端设备列表。
dataList	object	终端设备。
DeviceTag	string	终端设备 ID。	36efa42d-2c32-c4dc-e3fc-8541e33a****
DeviceType	string	终端设备操作系统类型。取值： Windows：Windows 系统。 macOS：macOS 系统。 Linux：Linux 系统。 Android：Android 系统。 iOS：iOS 系统。 Windows_Wuying：无影云桌面系统。	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 地址。	192.168.XX.XX
SrcIP	string	终端设备登录 IP 地址。	11.49.XX.XX
Memory	string	终端设备内存容量。单位：GB。	16
CPU	string	终端设备 CPU 型号。	Apple M1
Disk	string	终端设备磁盘型号。	APPLE SSD AP0512Q Media
Mac	string	终端设备 MAC 地址。	00:16:XX:XX:7c:46
AppVersion	string	客户端版本。	2.2.0
DeviceBelong	string	终端设备归属。取值： Personal：个人设备。 Company：公司设备。	Company
SharingStatus	boolean	设备是否开启共享。取值： true：开启共享。 false：关闭共享。	true
DeviceStatus	string	终端设备状态。取值： Online：在线。 Offline：离线。 LongTermOffline：长期离线。 Locked：锁定。 Lost：挂失。 Unbound：解绑。	Online
AppStatus	string	客户端状态。取值： Online：在线。 Offline：离线。	Online
PaStatus	string	内网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Enabled
IaStatus	string	互联网访问状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Enabled
DlpStatus	string	办公数据保护状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。 Unauthorized：未授权。	Enabled
NacStatus	string	网络准入状态。取值： Enabled：开启。 Disabled：关闭。 Unprovisioned：未配置。	Enabled
CreateTime	string	终端设备注册时间。	2023-07-17 18:46:55
UpdateTime	string	终端设备最后在线时间。	2023-08-24 19:04:42
EdrStatus	string	反入侵状态。取值： Enabled：开启。 Disabled：关闭。	Enabled
NetInterfaceInfo	array<object>	终端网卡列表。
netInterfaceInfo	object	终端网卡列表。
Name	string	网卡名称。	eth0
Mac	string	网卡 MAC 地址。	00:16:XX:XX:7c:46
Workshop	string	办公区名称。	测试办公区
SnSystem	string	系统 sn 码。	KVN9C9****
SnDiskDrive	string	硬盘 sn 码。	WD-WXR1A99A****
SnBaseBoard	string	主板 sn 码。	PJGGU00WBD****
SnProcessor	string	处理器 sn 码。	BFEBFBFF0008****
SnBios	string	bios 系统 sn 码。	5CG003****
MatchDeviceGroupIds	array	匹配设备组 ID 集合。
matchDeviceGroupIds	string	设备组 ID。	device-group-5191cf830a5e****

示例

正常返回示例

JSON格式

{
  "RequestId": "5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D",
  "TotalNum": 1,
  "Devices": [
    {
      "DeviceTag": "36efa42d-2c32-c4dc-e3fc-8541e33a****",
      "DeviceType": "Windows",
      "DeviceModel": "MacBookPro17,1",
      "DeviceVersion": "3.5.1",
      "Hostname": "win10-64bit",
      "Username": "王先生",
      "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****",
      "Department": "测试部",
      "InnerIP": "192.168.XX.XX",
      "SrcIP": "11.49.XX.XX",
      "Memory": 16,
      "CPU": "Apple M1",
      "Disk": "APPLE SSD AP0512Q Media",
      "Mac": "00:16:XX:XX:7c:46",
      "AppVersion": "2.2.0",
      "DeviceBelong": "Company",
      "SharingStatus": true,
      "DeviceStatus": "Online",
      "AppStatus": "Online",
      "PaStatus": "Enabled",
      "IaStatus": "Enabled",
      "DlpStatus": "Enabled",
      "NacStatus": "Enabled",
      "CreateTime": "2023-07-17 18:46:55",
      "UpdateTime": "2023-08-24 19:04:42",
      "EdrStatus": "Enabled",
      "NetInterfaceInfo": [
        {
          "Name": "eth0",
          "Mac": "00:16:XX:XX:7c:46"
        }
      ],
      "Workshop": "测试办公区",
      "SnSystem": "KVN9C9****",
      "SnDiskDrive": "WD-WXR1A99A****",
      "SnBaseBoard": "PJGGU00WBD****",
      "SnProcessor": "BFEBFBFF0008****",
      "SnBios": "5CG003****",
      "AutoLoginStatus": "",
      "MatchDeviceGroupIds": [
        "device-group-5191cf830a5e****"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-01-16	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-18	OpenAPI 返回结构发生变更	查看变更详情
2024-05-17	OpenAPI 入参发生变更	查看变更详情
2023-11-15	OpenAPI 入参发生变更	查看变更详情