1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
查询终端自定义分组列表，私有化调用path为：/capi/Assets/Device/DescribeDeviceVirtualGroups
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDeviceVirtualGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DomainInstanceId | 否 | String | 管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域"1"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。 示例值：1 |
| Condition | 否 | Condition | 滤条件、分页参数 |
| OsType | 否 | Integer | 系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0） 示例值：0 |
| VirtualGroupIds.N | 否 | Array of Integer | 非必填，自定义分组ids 示例值：[10307] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeDeviceVirtualGroupsPageRsp | 查询终端自定义分组的Data数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
查询终端自定义分组列表
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceVirtualGroups
<公共请求参数>
{
"OsType": 0,
"Condition": {
"PageNum": 0,
"PageSize": 10,
"Filters": [
{
"Field": "Name",
"Operator": "like",
"Values": [
"auottest1666336897100"
]
}
],
"Sort": {
"Field": "Itime",
"Order": "desc"
}
}
}输出示例
{
"Response": {
"RequestId": "0bd4d6b9-be26-4435-9f3e-79dbdb0c57c9",
"Data": {
"Page": {
"PageNum": 1,
"Total": 0,
"PageCount": 0,
"PageSize": 1000
},
"Items": [
{
"Utime": "2022-10-21 15:21:37",
"DeviceVirtualGroupName": "auottest1666336897100",
"DeviceCount": 0,
"Itime": "2022-10-21 15:21:37",
"OsType": 0,
"Id": 356
}
]
}
}
}示例2 示例2
展示自定义分组列表
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceVirtualGroups
<公共请求参数>
{
"Condition": {
"FilterGroups": [
{
"Filters": [
{
"Field": "DeviceVirtualGroupName",
"Operator": "eq",
"Values": [
"auto00"
]
}
]
}
]
},
"OsType": 0
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"DeviceCount": 0,
"DeviceVirtualGroupName": "auto00",
"Id": 7,
"Itime": "2023-03-28T15:07:52.581053+08:00",
"OsType": 0,
"Utime": "2023-03-28T15:24:46.281814+08:00"
}
],
"Page": {
"PageCount": 1,
"PageNum": 1,
"PageSize": 1000,
"Total": 1
}
},
"RequestId": "5d27c416-73d6-4081-809b-c5ac5943f33c"
}
}示例3 查询设备自定义分组列表
查询设备自定义分组列表
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceVirtualGroups
<公共请求参数>
{
"DomainInstanceId": "1",
"Condition": {
"PageSize": 10,
"PageNum": 1
},
"OsType": 0
}输出示例
{
"Response": {
"Data": {
"Items": [],
"Page": {
"PageCount": 0,
"PageNum": 1,
"PageSize": 10,
"Total": 0
}
},
"RequestId": "a4408eff-66b2-4705-ac4e-80c9a1371088"
}
}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 | 内部错误。 |
| InternalError.DatabaseException | 内部错误，数据库异常。 |
| InternalError.Unknown | 内部未知错误。 |
| InvalidParameter.RequestParam | 请求参数错误。 |
| MissingParameter.CommonParam | 缺少公共参数。 |
| ResourceNotFound.NotFound | 资源不存在。 |
| UnauthorizedOperation.NoResourcePermissions | 没有业务资源权限。 |
