GetUserDevice-阿里云帮助中心

Queries the details of a user endpoint device under the current Alibaba Cloud account.

Operation description

You can delete up to 100 devices at a time. Each device must be in the Offline or LongTermOffline state. If some device IDs in the request do not meet the status requirement, only the devices that meet the requirement are deleted, and the operation still returns a success response.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

csas:GetUserDevice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DeviceTag	string	Yes	The endpoint device ID. You can call the following operations to obtain the device ID: GetUserDevice: Queries the details of a user endpoint device. ListUserDevices: Queries multiple user endpoint devices.	36efa42d-2c32-c4dc-e3fc-8541e33a****

Response elements

Element	Type	Description	Example
	object	Schema of Response。
RequestId	string	The request ID.	EFE7EBB2-449D-5BBB-B381-CA7839BC1649
Device	object	The endpoint device.
DeviceTag	string	The endpoint device ID.	36efa42d-2c32-c4dc-e3fc-8541e33a****
DeviceType	string	The operating system type of the endpoint device. Valid values: Windows: Windows. macOS: macOS. Linux: Linux. Android: Android. iOS: iOS. Windows_Wuying: WUYING Workspace. Valid values: Linux : Linux. Windows_Wuying : WUYING Workspace. Windows : Windows. iOS : iOS. macOS : macOS. Android : Android.	Windows
DeviceModel	string	The model of the endpoint device.	MacBookPro17,1
DeviceVersion	string	The operating system version of the endpoint device.	3.5.1
Hostname	string	The hostname of the endpoint device.	win10-64bit
Username	string	The username.	王先生
SaseUserId	string	The user ID.	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department	string	The department to which the user belongs.	测试部
InnerIP	string	The internal IP address of the endpoint device.	172.16.XX.XX
SrcIP	string	The logon IP address of the endpoint device.	106.14.XX.XX
Memory	string	The memory capacity of the endpoint device. Unit: GB.	16
CPU	string	The CPU model of the endpoint device.	Apple M1
Disk	string	The disk model of the endpoint device.	APPLE SSD AP0512Q Media
Mac	string	The MAC address of the endpoint device.	48:9e:XX:XX:02:80
AppVersion	string	The client version.	2.2.0
DeviceBelong	string	The ownership of the endpoint device. Valid values: Personal: Personal device. Company: Company device. Valid values: Company : Company device. Personal : Personal device.	Company
SharingStatus	boolean	Indicates whether device sharing is enabled. Valid values: true: Enabled. false: Disabled. Valid values: true : Sharing enabled. false : Sharing disabled.	true
DeviceStatus	string	The status of the endpoint device. Valid values: Online: Online. Offline: Offline. LongTermOffline: Long-term offline. Locked: Locked. Lost: Reported as lost. Unbound: Unbound. Valid values: Lost : Reported as lost. Locked : Locked. LongTermOffline : Long-term offline. Offline : Offline. Unbound : Unbound. Online : Online.	Online
AppStatus	string	The client status. Valid values: Online: Online. Offline: Offline. Valid values: Offline : Offline. Online : Online.	Online
PaStatus	string	The private access status. Valid values: Enabled: Enabled. Disabled: Disabled. Unprovisioned: Not configured. Valid values: Enabled : Enabled. Disabled : Disabled. Unprovisioned : Not configured.	Enabled
IaStatus	string	The Internet access status. Valid values: Enabled: Enabled. Disabled: Disabled. Unprovisioned: Not configured. Valid values: Enabled : Enabled. Disabled : Disabled. Unprovisioned : Not configured.	Disabled
DlpStatus	string	The office data protection status. Valid values: Enabled: Enabled. Disabled: Disabled. Unprovisioned: Not configured. Unauthorized: Unauthorized. Valid values: Enabled : Enabled. Unauthorized : Unauthorized. Disabled : Disabled. Unprovisioned : Not configured.	Unauthorized
NacStatus	string	The network access control status. Valid values: Enabled: Enabled. Disabled: Disabled. Unprovisioned: Not configured. Valid values: Enabled : Enabled. Disabled : Disabled. Unprovisioned : Not configured.	Unprovisioned
CreateTime	string	The registration time of the endpoint device.	2023-05-16 17:18:46
UpdateTime	string	The last online time of the endpoint device.	2023-08-24 19:04:42
HistoryUsers	array<object>	The historical users of the endpoint device.
	object	The historical user of the endpoint device.
Username	string	The username.	张女士
SaseUserId	string	The user ID.	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
EdrStatus	string	The anti-intrusion status. Valid values: Enabled: Enabled. Disabled: Disabled. Valid values: Enabled : Enabled. Disabled : Disabled.	Disabled
AutoLoginStatus	string	The auto-logon status of the device. Valid values: Enabled: Active. Disabled: Inactive. Unprovisioned: Not enabled.	Enabled
NetInterfaceInfo	array<object>	The list of network interface controllers (NICs) on the endpoint device.
	object	The list of network interface controllers (NICs) on the endpoint device.
Name	string	The name of the network interface.	eth0
Mac	string	The MAC address of the network interface.	00:16:XX:XX:7c:46
Workshop	string	The workspace name.	测试办公区
MatchDeviceGroupIds	array	The IDs of matched device groups.
	string	The device group ID.	device-group-5191cf830a5e****
SnSystem	string	The system serial number.	KVN9C9****
SnDiskDrive	string	The hard disk serial number.	WD-WXR1A99A****
SnBaseBoard	string	The motherboard serial number.	PJGGU00WBD****
SnProcessor	string	The processor serial number.	BFEBFBFF0008****
SnBios	string	The BIOS serial number.	5CG003****
BatteryHealthPercentage	integer	The battery health percentage.
BatteryRemainingPercentage	integer	The remaining battery percentage.
DiskAvailable	integer	The available disk space. Unit: GB.
DiskUsed	integer	The used disk space. Unit: GB.
Processes	array<object>	The list of processes running on the endpoint device.
	object	The details of a process running on the endpoint device.
Name	string	The name of the process.
Description	string	The description of the process.
Cpu	number	The CPU usage of the process.
Memory	integer	The memory usage of the process, in MB.
TerminalInfoCollectTime	integer	The timestamp when the endpoint process information was collected.
JoinAdDomain	boolean	Indicates whether the endpoint device has joined an Active Directory (AD) domain.
Continent	string	The continent of the public IP address.
Country	string	The country of the public IP address.
Province	string	The province of the public IP address.
City	string	The city of the public IP address.
ContinentEn	string	The continent name in English.	Asia
CountryEn	string	The country name in English.	China
ProvinceEn	string	The province name in English.	Beijing
CityEn	string	The city name in English.	Beijing City
ContinentZh	string	The continent name in Chinese.	亚洲
CountryZh	string	The country name in Chinese.	中国
ProvinceZh	string	The province name in Chinese.	北京市
CityZh	string	The city name in Chinese.	北京市

Examples

Success response

JSON format

{
  "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": false,
    "Continent": "",
    "Country": "",
    "Province": "",
    "City": "",
    "ContinentEn": "Asia",
    "CountryEn": "China",
    "ProvinceEn": "Beijing",
    "CityEn": "Beijing City",
    "ContinentZh": "亚洲",
    "CountryZh": "中国",
    "ProvinceZh": "北京市",
    "CityZh": "北京市"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.