You need to enable JavaScript to run this app.
导航
云堡垒机
  • 文档首页
    • /
  • 云堡垒机

CreateUserGroup

最近更新时间：2024.04.16 19:47:32

首次发布时间：2023.12.15 10:45:22

我的收藏

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

请求说明

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

请求参数

参数类型是否必选示例值描述
ActionString是CreateUserGroup接口名称。当前 API 的名称为 CreateUserGroup。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
UserGroupNameString是"职能组"用户组名称。用户组可以包含中文字符、大小写英文字符、数字以及连字符组成，长度不可以超过 60 字符。
InstanceIdString是vbh-21****2257-6vcphcm8云堡垒机 ID。
DescriptionString否"职能部门组"用户组描述信息。描述信息长度不能大于 128 字符。
UserIdsArray of String否["cf3**b-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"]
}

返回参数

参数类型示例值描述
UserGroupIdString"cf3**b-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"
    }
}

错误码

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