CreateUserGroup - Bastionhost - Alibaba Cloud Documentation Center

Creates a user group for the specified bastion host.

Operation description

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.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:CreateUserGroup	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	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.	bastionhost-cn-st220aw****
RegionId	string	No	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.	cn-hangzhou
UserGroupName	string	Yes	The name of the user group that you want to create. This name can be a up to 128 characters in length.	group
Comment	string	No	The description of the user group. The description can be up to 500 characters in length.	comment

All Alibaba Cloud API requests 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	Description	Example
	object	The data returned.
UserGroupId	string	The ID of the user group.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	UserGroupAlreadyExists	The user group already exists.	The user group already exists.
500	InternalError	An unknown error occurred.	An unknown error occurred.

For a list of error codes, visit the Service error codes.