DocsICP FilingConsole
Documentation

ExportUserDevices

Updated at:
Copy as MD
Product
My Favorites

Export a list of user terminal devices to an Excel file.

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:ExportUserDevices

list

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Username

string

No

Username. Must be 1 to 128 characters long. Supports Chinese, uppercase and lowercase letters, digits, periods (.), underscores (_), hyphens (-), asterisks (*), at signs (@), and spaces.

王先生
SaseUserId

string

No

User ID.

su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department

string

No

Department name. Must be 1 to 128 characters long. Supports Chinese, uppercase and lowercase letters, digits, periods (.), commas (,), semicolons (;), hyphens (-), underscores (_), forward slashes (/), at signs (@), and spaces.

测试部
Hostname

string

No

Terminal device name. Must be 1 to 128 characters long. Supports Chinese, uppercase and lowercase letters, digits, periods (.), commas (,), semicolons (;), hyphens (-), underscores (_), forward slashes (/), at signs (@), and spaces. If you enter only an underscore (_), the system returns all terminal devices whose names contain four-byte UTF-8 characters.

win10-64bit
DeviceBelong

string

No

Terminal device ownership. Valid values:

  • Personal: Personal device.

  • Company: Company device.

Valid values:

  • Company :

    Company device

  • Personal :

    Personal device

Company
Mac

string

No

MAC address of the terminal device.

00:16:7c:46:**:**
SharingStatus

boolean

No

Whether device sharing is enabled. Valid values:

  • true: Sharing is enabled.

  • false: Sharing is disabled.

Valid values:

  • true :

    Sharing is enabled

  • false :

    Sharing is disabled

true
DeviceStatuses

array

No

Collection of terminal device statuses.

string

No

Terminal device status. Valid values:

  • Online: Online.

  • Offline: Offline, including long-term offline.

  • LongTermOffline: Long-term offline.

  • Locked: Locked.

  • Lost: Reported lost.

  • Unbound: Detached.

Valid values:

  • Lost :

    Reported lost

  • Locked :

    Locked

  • LongTermOffline :

    Long-term offline

  • Offline :

    Offline

  • Unbound :

    Detached

  • Online :

    Online

Online
AppStatuses

array

No

Collection of client statuses.

string

No

Client status. Valid values:

  • Online: Online.

  • Offline: Offline.

Valid values:

  • Offline :

    Offline

  • Online :

    Online

Online
PaStatuses

array

No

Collection of private network access statuses.

string

No

Private network access status. Valid values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Not configured.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Not configured

Enabled
IaStatuses

array

No

Collection of Internet access statuses.

string

No

Internet access status. Valid values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Not configured.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Not configured

Disabled
DlpStatuses

array

No

Collection of office data protection statuses.

string

No

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

Enabled
NacStatuses

array

No

Collection of network admission statuses.

string

No

Network admission status. Valid values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Not configured.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Not configured

Unprovisioned
DeviceTypes

array

No

Collection of terminal device operating system types.

string

No

Terminal device operating system type. Valid values:

  • Windows: Windows OS.

  • macOS: macOS.

  • Linux: Linux OS.

  • Android: Android OS.

  • iOS: iOS.

  • Windows_Wuying: Alibaba Cloud Cloud Desktop.

Valid values:

  • Linux :

    Linux OS

  • Windows_Wuying :

    Alibaba Cloud Cloud Desktop

  • Windows :

    Windows OS

  • iOS :

    iOS

  • macOS :

    macOS

  • Android :

    Android OS

Windows
DeviceTags

array

No

Collection of terminal device IDs.

string

No

Terminal device ID. Valid values:

36efa42d-2c32-c4dc-e3fc-8541e33a****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

ID of this request.

748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D
SignedUrl

string

URL to download the file. The URL expires in one minute.

https://sase-export.oss-cn-hangzhou.aliyuncs.com/export%2Fapp-device%2F20240607154831.xlsx?Expires=1717746571&OSSAccessKeyId=********************

Examples

Success response

JSON format

{
  "RequestId": "748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D",
  "SignedUrl": "https://sase-export.oss-cn-hangzhou.aliyuncs.com/export%2Fapp-device%2F20240607154831.xlsx?Expires=1717746571&OSSAccessKeyId=********************"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.