AddUsersToGroup--云堡垒机-火山引擎

文档中心

立即注册

导航

AddUsersToGroup

最近更新时间：2024.04.16 19:47:32首次发布时间：2023.12.15 10:45:22

批量将用户加入到指定用户组。不支持重复导入已经导入过的用户。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=AddUsersToGroup&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	AddUsersToGroup	接口名称。当前 API 的名称为 `AddUsersToGroup`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
UserIds	Array of String	是	["14**cd-beca-11ec-ae91-fee***e96"]	用户 ID 列表。
UserGroupId	String	是	["1**e5-c481-11ec-866a-9e***4df2"]	用户组 ID 列表。
InstanceId	String	是	vbh-14****0042-qt8gr7ht	云堡垒机 ID。

请求示例

POST https://open.volcengineapi.com/?Action=AddUsersToGroup&Version=2021-06-01
Content-Type: application/json
{
    "UserIds": ["14****cd-beca-11ec-ae91-fee*****e96"],
    "UserGroupId": "["1****e5-c481-11ec-866a-9e*****4df2"]",
    "InstanceId": "vbh-14****0042-qt8gr7ht"
}

返回参数

无

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "AddUsersToGroup",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。