1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
展示自定义分组终端列表,私有化调用path为:/capi/Assets/DescribeVirtualDevices
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVirtualDevices。 |
Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainInstanceId | 否 | String | 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 示例值:1 |
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 |
DeviceVirtualGroupId | 否 | Integer | 终端自定义分组ID(0:获取租户全部自定义分组下的终端数据;其他值:获取具体ID分组下的终端数据) 示例值:14990 |
OsType | 否 | Integer | 系统类型(0: win,1:linux,2: mac,4:android,5:ios 默认值0) 示例值:0 |
OnlineStatus | 否 | Integer | 选填,在线状态 (2表示在线,0或者1表示离线) 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeVirtualDevicesPageRsp | 返回的具体Data数据 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirtualDevices
<公共请求参数>
{
"DeviceVirtualGroupId": 356,
"OsType": 0,
"Condition": {
"Filters": [],
"Sort": {},
"PageSize": 10,
"PageNum": 1
}
}
输出示例
{
"Response": {
"RequestId": "ce9f337a-55c4-4a44-8c0c-c32462e03da8",
"Data": {
"Items": [
{
"FirewallStatus": 0,
"Locked": 0,
"DeviceStrategyVer": "",
"NGNStrategyVer": "",
"IOAUserName": "",
"DeviceNewStrategyVer": "",
"NGNNewStrategyVer": "2022-07-28 15:21:00",
"HostName": "",
"UserName": "niozhang",
"Version": "28429406901371100",
"Itime": "2022-10-21T15:21:37.460778+08:00",
"Os": "",
"Mid": "13fabc68a4834ba08d14afa179b7193863524881",
"GroupId": 42632,
"GroupName": "未分组终端",
"Ip": "106.55.201.137",
"OnlineStatus": 0,
"SerialNum": "",
"StrVersion": "101.101.7048.220",
"Tags": "",
"GroupNamePath": "全网终端.未分组终端",
"Id": 25902,
"ConnActiveTime": "",
"LocalIpList": "",
"HostId": 0,
"Name": "BindDeviceTest1666336897217",
"OsType": 0,
"CriticalVulListCount": 0,
"OsBits": 0,
"OsVersion": "",
"OsLanguage": "",
"OsInstallDate": "",
"ComputerName": "BindDeviceTest1666336897217",
"DomainName": "",
"MacAddr": "",
"VulCount": 0,
"RiskCount": 0,
"VirusVer": "",
"VulVersion": "",
"SysRepVersion": "",
"VulCriticalList": []
}
],
"Paging": {
"PageNum": 1,
"Total": 1,
"PageCount": 1,
"PageSize": 10
}
}
}
}
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.NoResourcePermissions | 没有业务资源权限。 |
UnauthorizedOperation.PermissionDenied | 未授权的操作。 |