Removes one or more hosts from a host group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RemoveHostsFromGroup

The operation that you want to perform.

Set the value to RemoveHostsFromGroup.

HostGroupId String Yes 1

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.
HostIds String Yes ["1","2","3"]

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.
InstanceId String Yes bastionhost-cn-st220aw****

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.
RegionId String No cn-hangzhou

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.

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 Example Description
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

The ID of the request.

Results Array of Item

The result of the call.

Code String OK

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.
HostGroupId String 1

The ID of the host group.

HostId String 1

The ID of the host.

Message String None

This parameter is deprecated.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RemoveHostsFromGroup
&HostGroupId=1
&HostIds=["1","2","3"]
&InstanceId=bastionhost-cn-st220aw****
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.