创建堡垒机用户组。
接口说明
本接口用于为堡垒机创建用户组。堡垒机管理员可使用本接口创建用户组,然后使用 AddUsersToGroup 接口为该用户组批量添加用户。将用户添加到同一个用户组,可实现对堡垒机用户的统一授权和管理。
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-bastionhost:CreateUserGroup |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
要新建用户组的堡垒机实例的 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。 |
bastionhost-cn-st220aw**** |
| RegionId |
string |
否 |
要新建用户组的堡垒机的地域 ID。 说明
地域 ID 和地域名称的对应关系,请参见地域和可用区。 |
cn-hangzhou |
| UserGroupName |
string |
是 |
要新建的用户组的名称。最多支持 128 字符。 |
group |
| Comment |
string |
否 |
新建的用户组的备注信息。最多支持 500 字符。 |
comment |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。 调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应数据。 |
||
| UserGroupId |
string |
新建的用户组的 ID。 |
1 |
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
示例
正常返回示例
JSON格式
{
"UserGroupId": "1",
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | 参数错误 |
| 400 | UserGroupAlreadyExists | The user group already exists. | 用户组已存在 |
| 500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。