All Products
Search
Document Center

Bastionhost:RemoveHostsFromGroup

Last Updated:Jan 13, 2023

Removes one or more hosts from a host group.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
yundun-bastionhost:RemoveHostsFromGroup Write
    All resources
    without
without

Request parameters

Parameter Type Required Description Example
InstanceId string Yes

The ID of the bastion host for which you want to remove hosts from the host 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 remove hosts from the host group.

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 ID of the host group.
1
HostIds string Yes

The ID of the host that you want to remove from the host group. The value is a JSON string. You can add up to 100 host IDs.

Note You can call the ListHosts operation to query the IDs of hosts.
["1","2","3"]

All Alibaba Cloud API operations 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
RequestId string

The ID of the request.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results array

The result of the call.

object
Code string

The return code that indicates whether the call was successful. Valid values:

  • OK: The call was successful.
  • UNEXPECTED: An unknown error occurred.
  • INVALID_ARGUMENT: A request parameter is invalid.
  • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.
  • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.
OK
Message string

This parameter is deprecated.

HostGroupId string

The ID of the host group.

1
HostId string

The ID of the host.

1

Example

Normal return example

JSONFormat

{
    "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
    "Results": {
        "HostGroupId": 1,
        "Message": "",
        "HostId": 1,
        "Code": "OK"
    }
}

XMLFormat

<RemoveHostsFromGroupResponse>
    <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
    <Results>
        <HostGroupId>1</HostGroupId>
        <Message/>
        <HostId>1</HostId>
        <Code>OK</Code>
    </Results>
</RemoveHostsFromGroupResponse>

Error codes

Http code Error code Error message
400 InvalidParameter The argument is invalid.
500 InternalError An unknown error occurred.

For a list of error codes, visit the API error center.