1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
查询满足条件的查询终端硬件信息列表，私有化调用path为：/capi/Assets/Device/DescribeDeviceHardwareInfoList
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDeviceHardwareInfoList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| GroupId | 是 | Integer | 【必填】设备分组id（需要和OsType匹配），下面是私有化场景下默认id：id-名称-操作系统1 全网终端 Win2 未分组终端 Win30000000 服务器 Win40000101 全网终端 Linux40000102 未分组终端 Linux40000103 服务器 Linux40000201 全网终端 macOS40000202 未分组终端 macOS40000203 服务器 macOS40000401 全网终端 Android40000402 未分组终端 Android40000501 全网终端 iOS40000502 未分组终端 iOSSaaS需要调用分组接口DescribeDeviceChildGroups获取对应分组id 示例值：93 |
| OsType | 是 | Integer | 【必填】操作系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0），需要和GroupId或者GroupIds匹配 示例值：0 |
| DomainInstanceId | 否 | String | 管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域"1"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。 示例值：1 |
| Condition | 否 | Condition | 过滤条件参数（字段含义请参考接口返回值） - Name, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserName, 类型String，支持操作：【eq，like，ilike】，支持排序 - IoaUserName，类型String，支持操作：【eq，like，ilike】，支持排序 - MacAddr, 类型String，支持操作：【eq，like，ilike】，支持排序 - Ip, 类型String，支持操作：【eq，like，ilike】，支持排序 - Mid, 类型String，支持操作：【eq，like，ilike】，支持排序 ，支持排序分页参数 - PageNum 从1开始，小于等于0时使用默认参数 - PageSize 最大值5000，最好不超过100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeDeviceHardwareInfoListRspData | 分页的data数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询终端硬件信息列表
查询终端硬件信息列表
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceHardwareInfoList
<公共请求参数>
{
"GroupId": 11668614,
"OsType": 0,
"DomainInstanceId": "1"
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"AccountName": "",
"Cpu": "12th Gen Intel(R) Core(TM) i7-12700H",
"GroupId": 11668615,
"GroupName": "未分组终端",
"GroupNamePath": "全网终端.未分组终端",
"HardDiskSize": "VMware Virtual NVMe Disk 44 GB",
"Id": 288665,
"Ip": "113.108.77.52",
"MacAddr": "00:0C:29:96:E6:DE",
"Memory": "4 GB",
"Mid": "0A811A6ECD8D6F4CA516AB56B1C2ECFC68104148",
"Monitor": "",
"Name": "PC-20240705KXXE",
"OsType": 0,
"Status": 5,
"UserName": "Administrator"
},
{
"AccountName": "",
"Cpu": "Intel Pentium III Xeon 处理器",
"GroupId": 11668634,
"GroupName": "dddd",
"GroupNamePath": "全网终端.dddd",
"HardDiskSize": "VMware, VMware Virtual S SCSI Disk Device 14 GB",
"Id": 288664,
"Ip": "113.108.77.52",
"MacAddr": "B0:DC:EF:E7:37:EE",
"Memory": "1024 MB",
"Mid": "489C698CAECC13B1B7C44E59443F5CBB676B7F33",
"Monitor": "",
"Name": "cs-207addad83ae",
"OsType": 0,
"Status": 5,
"UserName": "Administrator"
},
{
"AccountName": "",
"Cpu": "12th Gen Intel(R) Core(TM) i7-12700H",
"GroupId": 11668637,
"GroupName": "本地ip",
"GroupNamePath": "全网终端.本地ip",
"HardDiskSize": "SAMSUNG MZVL41T0HBLB-00BL7 953 GB",
"Id": 288663,
"Ip": "119.147.10.192",
"MacAddr": "B0:DC:EF:E7:37:EA",
"Memory": "32 GB",
"Mid": "8314BF3FD3FD738410C4FBB0DDDA48786800AB00",
"Monitor": "",
"Name": "STEVENSSHE-NBIR",
"OsType": 0,
"Status": 5,
"UserName": "Administrator"
},
{
"AccountName": "",
"Cpu": "",
"GroupId": 11668634,
"GroupName": "dddd",
"GroupNamePath": "全网终端.dddd",
"HardDiskSize": "",
"Id": 288662,
"Ip": "119.147.10.202",
"MacAddr": "",
"Memory": "",
"Mid": "7EBWA5184BEC838B96B29CE8105EC66167F8D1B2",
"Monitor": "",
"Name": "lucal_win-PC7",
"OsType": 0,
"Status": 5,
"UserName": "lucal_win"
},
{
"AccountName": "",
"Cpu": "",
"GroupId": 11668634,
"GroupName": "dddd",
"GroupNamePath": "全网终端.dddd",
"HardDiskSize": "",
"Id": 288661,
"Ip": "119.147.10.202",
"MacAddr": "",
"Memory": "",
"Mid": "1EBWA5184BEC838B96B29CE8105EC66167F8CFBD",
"Monitor": "",
"Name": "lucal_win-PC",
"OsType": 0,
"Status": 5,
"UserName": "lucal_win"
}
],
"Page": {
"PageCount": 1,
"PageNum": 1,
"PageSize": 20,
"Total": 5
}
},
"RequestId": "e00b7ba5-f534-4067-9fda-83012521919d"
}
}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 | 未授权的操作。 |
