1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
查询满足条件的终端数据详情，私有化调用path为：/capi/Assets/Device/DescribeDevices
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDevices。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Condition | 否 | Condition | 过滤条件参数（字段含义请参考接口返回值） - Mid, 类型String，支持操作：【eq，like，ilike】，支持排序 - Name, 类型String，支持操作：【eq，like，ilike】，支持排序 - Itime, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserName, 类型String，支持操作：【eq，like，ilike】，支持排序 - MacAddr, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserId, 类型String，支持操作：【eq，like，ilike】，支持排序 - Ip, 类型String，支持操作：【eq，like，ilike】，支持排序 - Tags，类型String，支持操作：【eq，like，ilike】，支持排序 - LocalIpList，类型String，支持操作：【eq，like，ilike】，支持排序 - SerialNum，类型String，支持操作：【eq，like，ilike】，支持排序 - Version，类型String，支持操作：【eq，like，ilike】，支持排序 - StrVersion，类型String，支持操作：【eq，like，ilike】，支持排序 - RtpStatus，类型String，支持操作：【eq，like，ilike】，不支持排序 - HostName，类型String，支持操作：【eq，like，ilike】，支持排序 - IoaUserName，类型String，支持操作：【eq，like，ilike】，支持排序 - GroupName，类型String，支持操作：【eq，like，ilike】，支持排序 - CriticalVulListCount，类型Int，支持操作：【eq】，不支持排序 - RiskCount，类型Int，支持操作：【eq】，不支持排序 - VulVersion，类型String，支持操作：【eq，like，ilike】，不支持排序 - Virusver，类型String，支持操作：【eq，like，ilike】，不支持排序 - SysRepver，类型String，支持操作：【eq，like，ilike】，不支持排序 - BaseBoardSn，类型String，支持操作：【eq，like，ilike】，支持排序 - Os，类型String，支持操作：【eq，like，ilike】，支持排序 - ConnActiveTime，类型String，支持操作：【eq，like，ilike】，不支持排序 - FirewallStatus，类型Int，支持操作：【eq】，不支持排序 - ProfileName，类型String，支持操作：【eq，like，ilike】，支持排序 - DomainName，类型String，支持操作：【eq，like，ilike】，支持排序 - SysRepVersion，类型String，支持操作：【eq，like，ilike】，支持排序 - VirusVer，类型String，支持操作：【eq，like，ilike】，支持排序 - Cpu，类型String，支持操作：【eq，like，ilike】，支持排序 - Memory，类型String，支持操作：【eq，like，ilike】，支持排序 - HardDiskSize，类型String，支持操作：【eq，like，ilike】，支持排序 - HardwareChangeCount，类型Int，支持操作：【eq】，支持排序 - AccountName，类型String，支持操作：【like.ilike】，支持排序 - AccountGroupName，类型String，支持操作：【like.ilike】，支持排序 - ScreenRecordingPermission，类型Int，支持操作：【eq】，支持排序 - DiskAccessPermission，类型Int，支持操作：【eq】，支持排序 分页参数 - PageNum 从1开始，小于等于0时使用默认参数 - PageSize 最大值5000，最好不超过100 示例值： { "Condition": { "FilterGroups": [ { "Filters": [ { "Field": "Name", "Operator": "ilike", "Values": [ " sarielliu-PCa" ] } ] } ], "PageSize": 10, "PageNum": 1 } } |
| GroupId | 否 | Integer | 【和GroupIds必须有一个填写】设备分组id（需要和OsType匹配），下面是私有化场景下默认id： id-名称-操作系统 1 全网终端 Win 2 未分组终端 Win 30000000 服务器 Win 40000101 全网终端 Linux 40000102 未分组终端 Linux 40000103 服务器 Linux 40000201 全网终端 macOS 40000202 未分组终端 macOS 40000203 服务器 macOS 40000401 全网终端 Android 40000402 未分组终端 Android 40000501 全网终端 iOS 40000502 未分组终端 iOS SaaS需要调用分组接口DescribeDeviceChildGroups获取对应分组id 示例值：93 |
| OsType | 否 | Integer | 【必填】操作系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0），需要和GroupId或者GroupIds匹配 示例值：0 |
| OnlineStatus | 否 | Integer | 在线状态 （2表示在线，0或者1表示离线） 示例值：2 |
| Filters.N | 否 | Array of Filter | 过滤条件--兼容旧接口,参数同Condition 示例值：参考Condition |
| Sort | 否 | Sort | 排序字段--兼容旧接口,参数同Condition 示例值：参考Sort |
| PageNum | 否 | Integer | 获取第几页--兼容旧接口,参数同Condition 示例值：1 |
| PageSize | 否 | Integer | 每页获取数--兼容旧接口,参数同Condition 示例值：20 |
| Status | 否 | Integer | 授权状态： 4基础授权 5高级授权 示例值：4 |
| GroupIds.N | 否 | Array of Integer | 【和GroupId必须有一个填写】设备分组id列表（需要和OsType匹配） 示例值：93 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeDevicesPageRsp | 分页的data数据 示例值： { "Data": { "Items": [ { "CriticalVulListCount": 0, "Camera": 1, "Desktop": 1, "UDisk": 1, "Download": 1, "SysFile": 1, "Reg": 1, "Proc": 1, "Mid": "348F553431765C49EAA34F373001D8106572EA05", "Guid": "348F553431765C49EAA34F373001D810", "Computer": "VMware, Inc. None", "Cpu": "Intel(R) Core(TM) i7-10700 CPU @ 2.90GHz", "MainBoard": "Intel Corporation 440BX Desktop Reference Platform", "GroupNamePath": "全网终端.未分组终端", "OsType": 0, "GroupName": "未分组终端", "HardDiskSize": "VMware Virtual NVMe Disk 59 GB", "AccountName": "canaan", "VideoCard": "VMware SVGA 3D", "AccountGroupIdPath": "", "NetworkCard": "Intel(R) 82574L Gigabit Network Connection", "Monitor": "", "AudioCard": "High Definition Audio Device", "OsBits": 64, "OsVersion": "10.0.18363", "OsLanguage": "简体中文", "OsInstallDate": "20230417175437.000000+480", "ComputerName": "DESKTOP-QRDNJ1O", "DomainName": "", "MacAddr": "00:0C:29:C1:28:2E", "VulCount": 0, "RiskCount": 0, "VirusVer": "2.0.13712.315", "VulVersion": "2023.12.01.15.05.16", "Itime": "2023-12-08T18:03:49.688332+08:00", "SysRepVersion": "2023.01.04.16.34.51", "Utime": "2023-12-08T23:33:25.320371+08:00", "RiskScanTime": "", "VulScanTime": "", "VulCriticalList": [], "VulIgnoreCount": 0, "Tags": "", "UserName": "canaanzhu", "CloudQueryState": 3, "FirewallStatus": 0, "SerialNum": "VMware-56 4d fc 76 58 77 77 69-b9 6c 6e 35 58 c1 28 2e", "IsRoot": 0, "DeviceStrategyVer": "2023-12-08 18:11:00", "NGNStrategyVer": "2023-12-08 18:15:00", "IOAUserName": "canaan", "DeviceNewStrategyVer": "2024-11-06 10:51:00", "NGNNewStrategyVer": "2024-10-15 20:00:00", "DeviceMark": "canaan", "HostName": "", "Profiles": [], "ProfileFileTotal": 0, "ProfileFileInstalled": 0, "Sort": 0, "BaseBoardSn": "", "AccountUsers": "", "IdentityStrategyVer": "", "IdentityNewStrategyVer": "", "AccountList": [], "NoPermission": 0, "BaseBoardManufacturer": "", "MemoryDetail": "", "SystemArchitecture": "", "HardwareChangeCount": 0, "RealTimeProtectionStatus": 0, "GroupId": 67, "ScreenRecordingPermission": 0, "DiskAccessPermission": 0, "Id": 36488, "Ip": "59.37.125.62", "Description": "", "AccountGroupSource": 0, "AccountGroupId": 7, "AccountGroupName": "sarielliutest", "ProfileFileNotInstall": [], "Memory": "2 GB", "Status": 5, "OnlineStatus": 1, "Locked": 0, "StrVersion": "208.12.18778.62001", "Version": "58546847926121009", "Os": "Microsoft Windows 10 教育版", "Driver": 1, "ConnActiveTime": "2023-12-08T23:49:21.642365+08:00", "Hacker": 1, "LocalIpList": "192.168.54.128", "Name": "DESKTOP-QRDNJ1O", "HostId": 0, "GroupFromAuto": 0 }, { "CriticalVulListCount": 0, "Camera": 1, "Desktop": 1, "UDisk": 1, "Download": 1, "SysFile": 1, "Reg": 1, "Proc": 1, "Mid": "AAA23147EA9AFBDB64DBB51BF703B4B96527F461", "Guid": "AAA23147EA9AFBDB64DBB51BF703B4B9", "Computer": "LENOVO ThinkPad X1 Extreme Gen 4i", "Cpu": "11th Gen Intel(R) Core(TM) i7-11800H @ 2.30GHz", "MainBoard": "LENOVO 20Y6S12Q00 SDK0J40675 WIN", "GroupNamePath": "全网终端.未分组终端", "OsType": 0, "GroupName": "未分组终端", "HardDiskSize": "WDC PC SN730 SDBQNTY-1T00-1001 953 GB", "AccountName": "sarielliu@tencent.com", "VideoCard": "Intel(R) UHD Graphics | NVIDIA GeForce RTX 3050 Ti Laptop GPU", "AccountGroupIdPath": "", "NetworkCard": "Intel(R) Wi-Fi 6E AX210 160MHz", "Monitor": "", "AudioCard": "NVIDIA High Definition Audio | Realtek High Definition Audio(SST) | 适用于 USB 音频的英特尔® 智音技术 | 适用于数字麦克风的英特尔® 智音技术", "OsBits": 64, "OsVersion": "10.0.19045", "OsLanguage": "简体中文", "OsInstallDate": "20240116154100.000000+480", "ComputerName": "SARIELLIU-NB4", "DomainName": "", "MacAddr": "F0:B6:1E:57:21:19", "VulCount": 0, "RiskCount": 0, "VirusVer": "2.0.13712.288", "VulVersion": "2024.08.19.11.28.16", "Itime": "2023-10-12T21:28:01.794806+08:00", "SysRepVersion": "2024.09.05.09.00.49", "Utime": "2024-09-12T21:27:52.468659+08:00", "RiskScanTime": "2024-03-28T17:26:59.199403+08:00", "VulScanTime": "2023-11-02T20:38:19.422357+08:00", "VulCriticalList": [], "VulIgnoreCount": 0, "Tags": "", "UserName": "sarielliu", "CloudQueryState": 3, "FirewallStatus": 1, "SerialNum": "PW021WJP", "IsRoot": 0, "DeviceStrategyVer": "2024-09-02 16:22:00", "NGNStrategyVer": "2023-12-25 09:53:00", "IOAUserName": "sarielliu", "DeviceNewStrategyVer": "2024-11-06 10:51:00", "NGNNewStrategyVer": "2024-10-15 20:00:00", "DeviceMark": "sarielliu", "HostName": "", "Profiles": [], "ProfileFileTotal": 0, "ProfileFileInstalled": 0, "Sort": 0, "BaseBoardSn": "W2CG24S00F2", "AccountUsers": "", "IdentityStrategyVer": "", "IdentityNewStrategyVer": "", "AccountList": [], "NoPermission": 0, "BaseBoardManufacturer": "", "MemoryDetail": "", "SystemArchitecture": "", "HardwareChangeCount": 8, "RealTimeProtectionStatus": 0, "GroupId": 67, "ScreenRecordingPermission": 0, "DiskAccessPermission": 0, "Id": 32599, "Ip": "113.108.77.57", "Description": "", "AccountGroupSource": 0, "AccountGroupId": 7, "AccountGroupName": "sarielliutest", "ProfileFileNotInstall": [], "Memory": "32 GB", "Status": 5, "OnlineStatus": 1, "Locked": 0, "StrVersion": "209.4.20987.62001", "Version": "58828288687862321", "Os": "Microsoft Windows 10 专业版", "Driver": 1, "ConnActiveTime": "2024-09-12T21:58:33.210869+08:00", "Hacker": 1, "LocalIpList": "10.64.87.90", "Name": "SARIELLIU-NB4", "HostId": 0, "GroupFromAuto": 0 }, { "CriticalVulListCount": 0, "Camera": 1, "Desktop": 1, "UDisk": 1, "Download": 1, "SysFile": 1, "Reg": 1, "Proc": 1, "Mid": "6A925DB4A3223F6CC38488D0E241AE0B5D14B363", "Guid": "6A925DB4A3223F6CC38488D0E241AE0B", "Computer": "LENOVO ThinkCentre M910t-N000", "Cpu": "Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz", "MainBoard": "LENOVO 3107 SDK0J40675 WIN 3305553586072", "GroupNamePath": "全网终端.未分组终端", "OsType": 0, "GroupName": "未分组终端", "HardDiskSize": "SAMSUNG MZVLB256HAHQ-000L7 238 GB", "AccountName": "", "VideoCard": "Intel(R) HD Graphics 630", "AccountGroupIdPath": "", "NetworkCard": "Intel(R) Ethernet Connection (2) I219-LM", "Monitor": "P24i-10", "AudioCard": "Realtek High Definition Audio", "OsBits": 64, "OsVersion": "10.0.17134", "OsLanguage": "简体中文", "OsInstallDate": "20190531115405.000000+480", "ComputerName": "sarielliu-PCa", "DomainName": "tencent.com", "MacAddr": "00:D8:61:48:50:11", "VulCount": 0, "RiskCount": 0, "VirusVer": "2.0.13645.8348", "VulVersion": "2019.08.19.09.50.30", "Itime": "2022-10-26T17:52:40.783424+08:00", "SysRepVersion": "2023.01.04.16.34.51", "Utime": "2023-03-13T06:30:35.428937+08:00", "RiskScanTime": "2023-03-15T17:12:30.388189+08:00", "VulScanTime": "2023-01-10T11:46:47.884224+08:00", "VulCriticalList": [], "VulIgnoreCount": 0, "Tags": "", "UserName": "sarielliu", "CloudQueryState": 3, "FirewallStatus": 0, "SerialNum": "M70AG2FV", "IsRoot": 0, "DeviceStrategyVer": "2023-02-14 16:59:00", "NGNStrategyVer": "2023-01-05 15:29:00", "IOAUserName": "", "DeviceNewStrategyVer": "2024-11-06 10:51:00", "NGNNewStrategyVer": "2024-10-15 20:00:00", "DeviceMark": "", "HostName": "", "Profiles": [], "ProfileFileTotal": 0, "ProfileFileInstalled": 0, "Sort": 0, "BaseBoardSn": "", "AccountUsers": "", "IdentityStrategyVer": "", "IdentityNewStrategyVer": "", "AccountList": [], "NoPermission": 0, "BaseBoardManufacturer": "", "MemoryDetail": "", "SystemArchitecture": "", "HardwareChangeCount": 0, "RealTimeProtectionStatus": 0, "GroupId": 67, "ScreenRecordingPermission": 0, "DiskAccessPermission": 0, "Id": 1, "Ip": "119.147.10.202", "Description": "", "AccountGroupSource": 0, "AccountGroupId": 0, "AccountGroupName": "", "ProfileFileNotInstall": [], "Memory": "16 GB", "Status": 5, "OnlineStatus": 1, "Locked": 0, "StrVersion": "208.0.14144.62000", "Version": "58546796082819632", "Os": "Microsoft Windows 10 专业版", "Driver": 1, "ConnActiveTime": "2023-03-16T10:49:53.116277+08:00", "Hacker": 1, "LocalIpList": "10.6.59.48,192.168.245.1,192.168.127.1", "Name": "sarielliu-PCa", "HostId": 0, "GroupFromAuto": 0 } ] } } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设备列表详情
获取租户满足条件：最近登录账号包含'cc'（不区分大小写）的设备列表详情
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDevices
<公共请求参数>
{
"Condition": {
"FilterGroups": [
{
"Filters": [
{
"Field": "IOAUserName",
"Operator": "ilike",
"Values": [
"cc"
]
}
]
}
],
"PageSize": 10,
"PageNum": 1
},
"GroupId": 93,
"OsType": 0
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"AccountGroupId": 298,
"AccountGroupName": "cc",
"AccountName": "cc",
"AccountUsers": "cc",
"BaseBoardSn": "N0CV1740MB0020008",
"ComputerName": "DESKTOP-AL8RU6H",
"ConnActiveTime": "2023-12-01T12:11:47.076416+08:00",
"CriticalVulListCount": 0,
"DeviceNewStrategyVer": "2023-12-01 12:11:00",
"DeviceStrategyVer": "2023-12-01 11:10:00",
"DomainName": "obsolete",
"FirewallStatus": 1,
"GroupId": 93,
"GroupName": "未分组终端",
"GroupNamePath": "全网终端.未分组终端",
"HostId": 0,
"HostName": "obsolete",
"IOAUserName": "cc",
"Id": 54,
"IdentityNewStrategyVer": "2024-11-06 02:44:00",
"IdentityStrategyVer": "2024-10-24 22:33:00",
"Ip": "113.108.77.51",
"Itime": "2023-12-01T09:37:38.505458+08:00",
"LocalIpList": "192.168.0.128",
"Locked": 0,
"MacAddr": "00:0C:29:10:00:5C",
"Mid": "75129D715480905B6A9C4569893C7634656938E2",
"NGNNewStrategyVer": "2023-11-20 15:54:00",
"NGNStrategyVer": "2023-11-20 15:54:00",
"Name": "DESKTOP-AL8RU6H",
"OnlineStatus": 1,
"OsType": 0,
"RiskCount": 0,
"SerialNum": "VMware-56 4d 76 2d d7 24 e1 ab-43 f3 af 25 e3 10 00 5c",
"StrVersion": "209.12.18590.201",
"SysRepVersion": "2023.11.30.19.52.38",
"Tags": "commpany assert",
"UserName": "cc",
"Version": "58828322890449097",
"VirusVer": "2.0.13712.288",
"VulCount": 0,
"VulCriticalList": [
"5043051",
"4132216"
],
"VulVersion": "2023.11.21.16.28.52"
}
],
"Paging": {
"PageCount": 1,
"PageNum": 1,
"PageSize": 10,
"Total": 1
}
},
"RequestId": "807938c5-9308-4c87-918d-e84a05f226a1"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.QueryData | 查询数据失败。 |
| InternalError.DatabaseException | 内部错误，数据库异常。 |
| InternalError.Unknown | 内部未知错误。 |
| InvalidParameter.RequestParam | 请求参数错误。 |
| MissingParameter.CommonParam | 缺少公共参数。 |
| ResourceNotFound.NotFound | 资源不存在。 |
| UnauthorizedOperation.PermissionDenied | 未授权的操作。 |
