Use AddUsersToGroup to add users to a user group - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

This operation adds users to a user group in a batch. After you create a user group by calling the CreateUserGroup operation, you can call this operation to add multiple users to the user group for batch authorization and management.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Call this operation as appropriate.

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:AddUsersToGroup

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 to which the user group belongs. Note You can call the DescribeInstances operation to query this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host instance to which the user group belongs. Note For the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserGroupId	string	Yes	The ID of the user group to which you want to add users. Note You can call the ListUserGroups operation to query this parameter.	１
UserIds	string	Yes	The IDs of the users to add to the user group. This parameter is a JSON-formatted string that supports up to 100 user IDs. Separate multiple IDs with commas (,). Note You can call the ListUsers operation to query user IDs.	["1","2","3"]
		No	The project ID.

When you call this operation, you must include common Alibaba Cloud API request parameters in addition to the operation-specific 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.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The result information of the operation.
	object
Code	string	The result of the operation. Valid values: OK: The operation was successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: The request parameters are invalid. Note Check the request parameters and call the operation again. OBJECT_NOT_FOUND: The specified object does not exist. Note Check whether the bastion host instance ID exists, whether the host exists, and whether the host ID is correct, and then call the operation again. OBJECT_AlREADY_EXISTS: The specified object already exists.	OK
Message	string	This parameter is deprecated and can be ignored.	None
UserGroupId	string	The user group ID.	1
UserId	string	The user ID.	1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "UserGroupId": "1",
      "UserId": "1"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
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.