调用DeleteHostAccount接口删除单个主机账户。
使用说明
本接口用于删除单个主机账户。如果某个主机的账号不再使用,您可以调用本接口删除已在堡垒机上配置的该主机的主机账户。
说明 删除主机账户后,通过堡垒机登录该主机时需要自行输入该主机的主机账户和密码。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteHostAccount |
需要执行的操作。 取值:DeleteHostAccount。 |
HostAccountId | String | 是 | 1 |
要删除的主机账户的ID。 说明 您可以调用ListHostAccounts接口获取该参数。
|
InstanceId | String | 是 | bastionhost-cn-st220aw**** |
要删除的主机账户所在堡垒机实例的ID。 说明 您可以调用DescribeInstances接口获取该参数。
|
RegionId | String | 否 | cn-hangzhou |
要查询的主机账户所在堡垒机的地域ID。 说明 地域ID和地域名称的对应关系,请参见地域和可用区。
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DeleteHostAccount
&HostAccountId=1
&InstanceId=bastionhost-cn-st220aw****
&<公共请求参数>
正常返回示例
XML
格式
<DeleteHostAccountResponse>
<RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
</DeleteHostAccountResponse>
JSON
格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An unknown error occurred. | 未知错误 |
400 | InvalidParameter | The argument is invalid. | 参数错误 |
404 | HostAccountNotFound | The host account is not found. | 主机账号不存在 |
访问错误中心查看更多错误码。