调用CreateUserGroup接口创建堡垒机用户组。

使用说明

本接口用于为堡垒机创建用户组。堡垒机管理员可使用本接口创建用户组,然后使用AddUsersToGroup接口为该用户组批量添加用户。将用户添加到同一个用户组,可实现对堡垒机用户的统一授权和管理。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateUserGroup

需要执行的操作。

取值:CreateUserGroup

InstanceId String bastionhost-cn-st220aw****

要新建用户组的堡垒机实例的ID。

说明 您可以调用DescribeInstances接口获取该参数。
UserGroupName String group

要新建的用户组的名称。最多支持128字符。

RegionId String cn-hangzhou

要新建用户组的堡垒机的地域ID。

说明 地域ID和地域名称的对应关系,请参见地域和可用区
Comment String comment

新建的用户组的备注信息。最多支持500字符。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

UserGroupId String 1

新建的用户组的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateUserGroup
&InstanceId=bastionhost-cn-st220aw****
&UserGroupName=group
&<公共请求参数>

正常返回示例

XML格式

<CreateUserGroupResponse>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <UserGroupId>1</UserGroupId>
</CreateUserGroupResponse>

JSON格式

{
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
	"UserGroupId": "1"
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An unknown error occurred. 未知错误
400 InvalidParameter The argument is invalid. 参数错误
400 UserGroupAlreadyExists The user group already exists. 用户组已存在

访问错误中心查看更多错误码。