Use AddHostsToGroup to add hosts to a host group - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

Adds multiple hosts to a specified host group in a batch. By adding multiple hosts to a host group, you can centrally manage these hosts and grant permissions in a batch.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, 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:AddHostsToGroup

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the bastion host where the asset group to which you want to add hosts resides. Note You can invoke the DescribeInstances operation to query this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host instance where the asset group to which you want to add hosts resides. Note For the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostGroupId	string	Yes	The ID of the asset group to which you want to add hosts. Note You can call the ListHostGroups operation to query this parameter.	1
HostIds	string	Yes	The IDs of the hosts that you want to add to the asset group. This parameter is a JSON-formatted string. You can add up to 100 host IDs. Note You can call the ListHosts operation to query host IDs.	["1","2","3"]
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique identifier that Alibaba Cloud generated for the request.	81500666-d7f5-4143-8329-0223cc738105
Results	array<object>	The call results of the operation.
	object	The call results of the operation.
Code	string	The result of the operation call. 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 after you confirm that the parameters are correct. 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. 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
HostGroupId	string	The asset group ID.	1
HostId	string	The host ID.	1

Examples

Success response

JSON format

{
  "RequestId": "81500666-d7f5-4143-8329-0223cc738105",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "HostGroupId": "1",
      "HostId": "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.