iOA 零信任安全管理系统终端手动自定义分组增减终端

1. 接口描述

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

终端自定义分组增减终端，私有化调用path为：/capi/Assets/Device/ModifyVirtualDeviceGroups

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyVirtualDeviceGroups。
Version	是	String	公共参数，本接口取值：2022-06-01。
Region	否	String	公共参数，本接口不需要传递此参数。
DeviceList.N	是	Array of ModifyVirtualDeviceGroupsReqItem	必填，操作的设备列表数据
DomainInstanceId	否	String	管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域"1"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。示例值：1
DeviceVirtualGroupId	否	Integer	添加到的终端自定义分组id。和DeviceVirtualGroupIds互斥，必填其一，优先使用本参数示例值：0
DeviceVirtualGroupIds.N	否	Array of Integer	要添加的终端自定义分组id列表示例值：[14989]
OsType	否	Integer	系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0）示例值：0

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 将设备移动到普通的自定义分组

将设备移动到普通的自定义分组

输入示例

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

{
    "DomainInstanceId": "3",
    "DeviceVirtualGroupId": 10,
    "DeviceList": [
        {
            "DeviceMid": "C007D8BFA830C84A61965ABEC6FEDFD466A9E861",
            "Operation": 1
        }
    ],
    "OsType": 0
}

输出示例

{
    "Response": {
        "RequestId": "17b01981-dff8-4267-b446-eefc4973acf4"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.QueryData	查询数据失败。
InternalError	内部错误。
InternalError.DatabaseException	内部错误，数据库异常。
InternalError.DatabaseQueryFailed	数据库查询失败。
InternalError.Unknown	内部未知错误。
InvalidParameter.RequestParam	请求参数错误。
InvalidParameterValue.VirtualDeviceGroupNotFound	没有找到对应的终端自定义分组
MissingParameter.CommonParam	缺少公共参数。
RequestLimitExceeded.WaitForTheLastOperationToComplete	上次操作还未完成，请稍后重试。
ResourceNotFound.NotFound	资源不存在。
UnauthorizedOperation.NoResourcePermissions	没有业务资源权限。

终端手动自定义分组增减终端

本页目录：