Call RemoveHostsFromGroup to remove multiple hosts from a host group - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

This operation removes multiple hosts from a host group. If some hosts no longer require unified management through a host group, you can use this operation to remove them.

QPS limits

The QPS limit per user is 10 calls per second. If this limit is exceeded, API calls are throttled, which may affect your services. Call this operation at a reasonable 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:RemoveHostsFromGroup

delete

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance to which the host group from which you want to remove hosts belongs. Note You can call the DescribeInstances operation to query the instance ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance to which the host group from which you want to remove hosts belongs. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostGroupId	string	Yes	The ID of the host group from which you want to remove hosts. Note You can call the ListHostGroups operation to query the host group ID.	1
HostIds	string	Yes	The IDs of the hosts that you want to remove. The value is a JSON string. You can specify up to 100 host IDs. Note You can call the ListHosts operation to query the host IDs.	["1","2","3"]
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. The ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The results of the operation.
	object
Code	string	The result code of the operation. Valid values: OK: The operation is successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: A request parameter is invalid. Note Check the request parameters and call the operation again after you ensure that the parameters are valid. OBJECT_NOT_FOUND: The object on which the operation is performed does not exist. Note Check whether the Bastionhost instance ID and the host exist, and whether the host ID is correct. Then, call the operation again. OBJECT_AlREADY_EXISTS: The object on which the operation is performed already exists.	OK
Message	string	[Deprecated] This parameter is deprecated. You can ignore it.	None
HostGroupId	string	The ID of the host group.	1
HostId	string	The ID of the host.	1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "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.