1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
查询满足条件的终端数据详情,私有化调用path为:/capi/Assets/Device/DescribeDevices
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDevices。 |
| Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| DomainInstanceId | 否 | String | 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 示例值:1 |
| Condition | 否 | Condition | 过滤条件参数(字段含义请参考接口返回值)
分页参数
|
| GroupId | 否 | Integer | 【和GroupIds必须有一个填写】设备分组id(需要和OsType匹配),下面是私有化场景下默认id: SaaS需要调用分组接口DescribeDeviceChildGroups获取对应分组id 示例值:93 |
| OsType | 否 | Integer | 系统类型(0: win,1:linux,2: mac,4:android,5:ios,-1:全系统(SaaS一体化版本) ; 不传默认为0)(只支持32位),需要和GroupId或者GroupIds匹配 示例值:0 |
| OnlineStatus | 否 | Integer | 在线状态 (2表示在线,0或者1表示离线) 示例值:2 |
| Filters.N | 否 | Array of Filter | 过滤条件--兼容旧接口,参数同Condition |
| Sort | 否 | Sort | 排序字段--兼容旧接口,参数同Condition |
| 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数据 |
| 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,
"Os": "Microsoft Windows 10 专业版",
"OsBits": 64,
"OsInstallDate": "20220812112555.000000+480",
"OsLanguage": "简体中文",
"OsType": 0,
"OsVersion": "10.0.19045",
"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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.QueryData | 查询数据失败。 |
| InternalError.DatabaseException | 内部错误,数据库异常。 |
| InternalError.Unknown | 内部未知错误。 |
| InvalidParameter.RequestParam | 请求参数错误。 |
| MissingParameter.CommonParam | 缺少公共参数。 |
| RequestLimitExceeded.Gateway | 网关限流 |
| ResourceNotFound.NotFound | 资源不存在。 |
| ResourceUnavailable.LicenseInvalid | license无效 |
| UnauthorizedOperation.PermissionDenied | 未授权的操作。 |