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

文档中心

立即注册

导航

CreateUserGroup

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

创建用户组，可通过用户组批量管理用户。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateUserGroup	接口名称。当前 API 的名称为 `CreateUserGroup`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
UserGroupName	String	是	"职能组"	用户组名称。用户组可以包含中文字符、大小写英文字符、数字以及连字符组成，长度不可以超过 60 字符。
InstanceId	String	是	vbh-21****2257-6vcphcm8	云堡垒机 ID。
Description	String	否	"职能部门组"	用户组描述信息。描述信息长度不能大于 128 字符。
UserIds	Array of String	否	["cf3b-a0e2-11ec-ba2c-d2**543"]	用户 ID 列表。

请求示例

POST https://open.volcengineapi.com/?Action=CreateUserGroup&Version=2021-06-01
Content-Type: application/json
{
    "UserGroupName": "职能组",
    "InstanceId": "vbh-21****2257-6vcphcm8",
    "Description": "职能部门组",
    "UserIds": ["cf3****b-a0e2-11ec-ba2c-d2******543"]
}

返回参数

参数	类型	示例值	描述
UserGroupId	String	"cf3b-a0e2-11ec-ba2c-d2**543	用户组 ID。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "CreateUserGroup",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "UserGroupId": "cf3****b-a0e2-11ec-ba2c-d2******543"
    }
}

错误码

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