1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
创建终端自定义分组，私有化调用path为：/capi/Assets/Device/CreateDeviceVirtualGroup
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDeviceVirtualGroup。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DeviceVirtualGroupName | 否 | String | 必填，终端自定义分组名 示例值：内网分组 |
| Description | 否 | String | 详情 示例值：内网分组 |
| OsType | 否 | Integer | 必填，系统类型（0: win，1：linux，2: mac，3: win_srv，4：android，5：ios ）(只支持32位) 示例值：0 |
| TimeType | 否 | Integer | 必填，分组类型（0:手动分组；非0为自动划分分组；具体枚举值为：1:自动每小时划分分组、2:自动每天划分分组、3:自定义时间划分分组）(只支持32位) 示例值：0 |
| AutoMinute | 否 | Integer | 选填，TimeType=3时的自动划分时间，其他情况为0（单位min）(只支持32位) 示例值：10 |
| AutoRules | 否 | ComplexRule | 选填，手动分组不填，自动划分分组的划分规则数据 示例值： {"AutoRules": { "Relation": "并且", "SimpleRules": [ { "Relation": "", "Expressions": [ { "Relation": "", "Items": [ { "Operate": "等于", "Values": [ "Company assets" ], "Key": "profile_166", "error": "" } ] } ] } ] } } |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CreateDeviceVirtualGroupRspData | 响应返回的data 示例值：{"id":12121} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
创建自定义分组接口
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeviceVirtualGroup
<公共请求参数>
{
"OsType": 0,
"Description": "obsolete",
"DeviceVirtualGroupName": "auottest1666336897100"
}输出示例
{
"Response": {
"RequestId": "abc372a3-885d-4c26-815b-799afb0ada55",
"Data": {
"Id": 356
}
}
}示例2 示例2
创建终端自定义分组
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeviceVirtualGroup
<公共请求参数>
{
"DeviceVirtualGroupName": "auto7",
"Description": "自动分组测试",
"OsType": 0,
"TimeType": 3,
"AutoMinute": 10,
"AutoRules": {
"SimpleRules": [
{
"Expressions": [
{
"Items": [
{
"Key": "mid",
"Operate": "等于",
"Value": "111111111"
}
]
}
]
}
]
}
}输出示例
{
"Response": {
"Data": {
"Id": 9
},
"RequestId": "088bd8af-4ff1-448c-8e48-6d4e860df5cc"
}
}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.AutoRuleParameterError | 参数错误：规则相关字段传参或者字段内容错误 |
| InvalidParameter.DuplicateDeviceVirtualGroupName | 重复的终端自定义分组名称。 |
| InvalidParameter.DuplicateIdInBlackWhiteList | 黑白名单选中有相同的终端设备 |
| InvalidParameter.RequestParam | 请求参数错误。 |
| MissingParameter.CommonParam | 缺少公共参数。 |
| ResourceNotFound.NotFound | 资源不存在。 |
| UnauthorizedOperation.NoResourcePermissions | 没有业务资源权限。 |
