查询设备组子分组

最近更新时间:2025-08-22 01:53:28

我的收藏

1. 接口描述

接口请求域名: ioa.tencentcloudapi.com 。

查询设备组子分组详情,私有化调用path为:capi/Assets/Device/DescribeDeviceChildGroups

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceChildGroups。
Version String 公共参数,本接口取值:2022-06-01。
Region String 公共参数,本接口不需要传递此参数。
DomainInstanceId String 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。
示例值:1
Condition Condition 过滤条件参数(字段含义请参考接口返回值)
- Name, 类型String,支持操作:【like,ilike】,支持排序




分页参数
- PageNum 从1开始,小于等于0时使用默认参数
- PageSize 最大值5000,最好不超过100
ParentId Integer 父分组id,默认0:表示获取全网终端分组
示例值:0
OsType Integer 操作系统类型(0:win,1:linux,2:mac,4:android,5:ios;默认0:系统win)
示例值:0

3. 输出参数

参数名称 类型 描述
Data DescribeDeviceChildGroupsRspData 查询设备组子分组详情响应结构
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 测试

测试

输入示例

POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceChildGroups
<公共请求参数>

{
    "ParentId": 92,
    "OsType": 0
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "BindAccount": 0,
                    "Count": 11,
                    "Description": "",
                    "FromAuto": 0,
                    "HasIp": false,
                    "Icon": "",
                    "Id": 93,
                    "IdPath": "92.93",
                    "IsLeaf": true,
                    "Locked": 0,
                    "Name": "未分组终端",
                    "NamePath": "全网终端.未分组终端",
                    "OsType": 0,
                    "ParentId": 92,
                    "ReadOnly": false,
                    "Sort": 0,
                    "WithIp": 0
                },
                {
                    "BindAccount": 0,
                    "Count": 0,
                    "Description": "",
                    "FromAuto": 0,
                    "HasIp": false,
                    "Icon": "",
                    "Id": 94,
                    "IdPath": "92.94",
                    "IsLeaf": true,
                    "Locked": 0,
                    "Name": "服务器",
                    "NamePath": "全网终端.服务器",
                    "OsType": 0,
                    "ParentId": 92,
                    "ReadOnly": false,
                    "Sort": 0,
                    "WithIp": 0
                },
                {
                    "BindAccount": 0,
                    "Count": 4,
                    "Description": "",
                    "FromAuto": 0,
                    "HasIp": false,
                    "Icon": "",
                    "Id": 74700,
                    "IdPath": "92.74700",
                    "IsLeaf": false,
                    "Locked": 2,
                    "Name": "TestBone",
                    "NamePath": "全网终端.TestBone",
                    "OsType": 0,
                    "ParentId": 92,
                    "ReadOnly": false,
                    "Sort": 0,
                    "WithIp": 0
                },
                {
                    "BindAccount": 1,
                    "Count": 11,
                    "Description": "",
                    "FromAuto": 0,
                    "HasIp": false,
                    "Icon": "",
                    "Id": 74699,
                    "IdPath": "92.74699",
                    "IsLeaf": false,
                    "Locked": 2,
                    "Name": "Test-New",
                    "NamePath": "全网终端.Test-New",
                    "OsType": 0,
                    "ParentId": 92,
                    "ReadOnly": false,
                    "Sort": 0,
                    "WithIp": 0
                }
            ]
        },
        "RequestId": "73d262a9-4c0f-4f68-bce2-3718f98c6494"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.QueryData 查询数据失败。
InternalError.DatabaseException 内部错误,数据库异常。
InternalError.Unknown 内部未知错误。
InvalidParameter.RequestParam 请求参数错误。
MissingParameter.CommonParam 缺少公共参数。
ResourceNotFound.NotFound 资源不存在。
UnauthorizedOperation.PermissionDenied 未授权的操作。