Create a user group with CreateUserGroup - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

Creates a user group for a bastion host. Bastion host administrators can use this operation to create a user group and then call the AddUsersToGroup operation to add users to the user group in batches. Adding users to the same user group enables unified authorization and management of bastion host users.

The China site Chinese edition single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:CreateUserGroup

create

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host instance for which you want to create a user group. Note You can call the DescribeInstances operation to query this parameter.	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 to create. The name can be up to 128 characters in length.	group
Comment	string	No	The description of the user group to create. The description can be up to 500 characters in length.	comment
ProjectId	integer	No	The project ID.	3

When you call this operation, you must include the common request parameters of Alibaba Cloud APIs in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters. For the request format, see the request examples in this topic.

Response elements

Element	Type	Description	Example
	object	The response data.
UserGroupId	string	The ID of the created user group.	1
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.