DeleteHostGroup - API参考| 阿里云

使用说明

本接口用于删除单个主机组。当堡垒机上某个主机组内的所有主机不在需要通过堡垒机运维时，您可以使用本接口删除该主机组。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DeleteHostGroup	要执行的操作。取值：DeleteHostGroup。
InstanceId	String	是	bastionhost-cn-st220aw****	要删除的主机组所在堡垒机的实例ID。说明您可以调用DescribeInstances接口获取该参数。
RegionId	String	否	cn-hangzhou	要删除的主机组所在堡垒机的地域ID。说明地域ID和地域名称的对应关系，请参见地域和可用区。
HostGroupId	String	是	1	要删除的主机组ID。说明您可以调用ListHostGroups接口获取该参数。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据


名称	类型	示例值	描述
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteHostGroup
&SourceIp=42.120.XX.XX
&InstanceId=bastionhost-cn-st220aw****
&RegionId=cn-hangzhou
&HostGroupId=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteHostGroupResponse>
    <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
</DeleteHostGroupResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误
404	HostGroupNotFound	The host group is not found.	主机组不存在

访问错误中心查看更多错误码。