Creates a user group for a specified bastion host.

Usage notes

You can call this operation to create a user group for a bastion host as an administrator. Then, you can call the AddUsersToGroup operation to add users to the user group at a time. After you add the users to the user group, you can authorize and manage the users in a centralized manner.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateUserGroup

The operation that you want to perform.

Set the value to CreateUserGroup.

InstanceId String Yes bastionhost-cn-st220aw****

The ID of the bastion host for which you want to create a user group.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
UserGroupName String Yes group

The name of the user group that you want to create. This name can be a up to 128 characters in length.

RegionId String No cn-hangzhou

The region ID of the bastion host for which you want to create a user group.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
Comment String No comment

The remarks of the user group. The remarks can be up to 500 characters in length.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

The ID of the request, which is used to locate and troubleshoot issues.

UserGroupId String 1

The ID of the user group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateUserGroup
&InstanceId=bastionhost-cn-st220aw****
&UserGroupName=group
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HTTP status code Error code Error message Description
500 InternalError An unknown error occurred. The error message returned because an unknown error occurred.
400 InvalidParameter The argument is invalid. The error message returned because one or more parameters are invalid.
400 UserGroupAlreadyExists The user group already exists. The error message returned because the user group that you want to create already exists.

For a list of error codes, visit the API Error Center.