查询当前阿里云账号下用户终端设备列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| csas:ListUserDevices | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CurrentPage | long | 是 | 分页查询时显示的当前页的页码。取值：1~10000。 | 1 |
| PageSize | long | 是 | 分页查询时设置的每页数量。取值范围：1~500。 | 10 |
| Username | string | 否 | 用户名。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。 | 王先生 |
| SaseUserId | string | 否 | 用户 ID。取值来源：
| su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d**** |
| Department | string | 否 | 用户所属部门。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。 | 测试部 |
| Hostname | string | 否 | 终端设备名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。单独输入下划线（_）将额外查询所有名称中带 4 字节 utf-8 字符的终端设备。 | win10-64bit |
| DeviceBelong | string | 否 | 终端设备归属。取值：
| Company |
| Mac | string | 否 | 终端设备 MAC 地址。 | 00:16:XX:XX:7c:46 |
| SharingStatus | boolean | 否 | 设备是否开启共享。取值：
| true |
| DeviceStatuses | array | 否 | 终端设备状态集合。 | |
| string | 否 | 终端设备状态。取值：
枚举值：
| Online | |
| AppStatuses | array | 否 | 客户端状态集合。 | |
| string | 否 | 客户端状态。取值：
| Online | |
| PaStatuses | array | 否 | 内网访问状态集合。 | |
| string | 否 | 内网访问状态。取值：
| Enabled | |
| IaStatuses | array | 否 | 互联网访问状态集合。 | |
| string | 否 | 互联网访问状态。取值：
| Disabled | |
| DlpStatuses | array | 否 | 办公数据保护状态集合。 | |
| string | 否 | 办公数据保护状态。取值：
| Enabled | |
| NacStatuses | array | 否 | 网络准入状态集合。 | |
| string | 否 | 网络准入状态。取值：
| Unprovisioned | |
| DeviceTypes | array | 否 | 终端设备操作系统类型集合。 | |
| string | 否 | 终端设备操作系统类型。取值：
| Windows | |
| DeviceTags | array | 否 | 终端设备 ID 集合。 | |
| string | 否 | 终端设备 ID。取值：
| 36efa42d-2c32-c4dc-e3fc-8541e33a**** | |
| SortBy | string | 否 | 排序参数。取值：
| UpdateTime |
| InnerIp | string | 否 | 终端设备内网 IP 地址。 | 192.168.XX.XX |
返回参数
示例
正常返回示例
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",
"NetInterfaceInfo": [
{
"Name": "eth0",
"Mac": "00:16:XX:XX:7c:46"
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-17 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-11-15 | OpenAPI 入参发生变更 | 查看变更详情 |