帮你快速理解、总结文档立即下载

绑定账户虚拟组

最近更新时间:2026-09-25 02:18:42
我的收藏

1. 接口描述

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

关联账户到虚拟组上,支持批量,私有化调用path为:capi/Assets/BindVirtualAccount,从7.x版本开始支持

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:BindVirtualAccounts。
Version 是 String 公共参数,本接口取值:2022-06-01。
Region 否 String 公共参数,本接口不需要传递此参数。
VirtualGroupId 是 Integer

Comment: 虚拟组id;Required:true


示例值:12
AccountIdList.N 否 Array of Integer

Comment: 要绑定的账户Id集合,这里的Id指的是DescribeLocalAccountsData结构体里返回的Id;Required:true


示例值:[12]
AccountUserList.N 否 Array of AccountUserIdItem

Comment: 要绑定的账户(目录MenuId+登录账号UserId)集合,与AccountIdList二选一或并用,查不到的账号会被跳过;Required:false

DomainInstanceId 否 String Comment: 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。
示例值:1

3. 输出参数

参数名称 类型 描述
Data BindVirtualAccountData

业务响应数据

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 向自定义用户组添加用户

向自定义用户组添加用户

输入示例

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

{
    "VirtualGroupId": 12,
    "AccountIdList": [
        12
    ]
}

输出示例

{
    "Response": {
        "RequestId": "adc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DatabaseException 内部错误,数据库异常。
InvalidParameter.RequestParam 请求参数错误。