文档

DetachHostGroupAccountsFromUser - 移除用户已授权的主机组及主机账户

更新时间:

移除用户已授权的主机组及主机账户。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:DetachHostGroupAccountsFromUserWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

指定要移除主机组和主机账户授权的用户所在堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

指定要移除主机组和主机账户授权的用户所在堡垒机的区域 ID。

说明 区域 ID 和区域名称的对应关系,请参见地域和可用区
cn-hangzhou
UserIdstring

指定要移除主机组和主机账户授权的用户 ID。

说明 您可以调用 ListUsers 接口获取该参数。
1
HostGroupsstring

指定要为用户移除授权的主机组 ID 和主机账户名称。最多支持设置 10 个主机组 ID,每个主机组最多支持设置 10 个主机账户名称。您可以不设置主机账户名称,不设置主机账户名称表示为用户移除主机组和该主机组下所有主机账户的授权。该参数的具体结构请参考请求参数列表下的 HostGroups 参数结构说明。

说明 您可以调用 ListHostGroups 接口获取主机组 ID,调用 ListHostAccounts 接口获取主机账户名称。
[ {"HostGroupId":"1"}, {"HostGroupId":"2","HostAccountNames":["root","111","abc"]}]

HostGroups 参数结构说明

字段类型示例值描述
HostGroupIdstring1主机组 ID。
HostAccountIdsarray[string]["root","111","abc"]主机账户名称。该参数为 JSON 格式的字符串,最多可设置 10 个主机账户名称。

以下是该参数的取值示例。

[
{"HostGroupId":"1"}, 
{"HostGroupId":"2","HostAccountNames":["root","111","abc"]}, 
{"HostGroupId":"3","HostAccountNames":["root","111","abc"]},  
{"HostGroupId":"4","HostAccountNames":["root","111","abc"]} 
]

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

返回参数

名称类型描述示例值
object
RequestIdstring

阿里云为该请求生成的唯一标识符。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Resultsobject []

接口的调用结果。

Codestring

接口的调用结果信息。取值:

  • OK:操作成功。
  • UNEXPECTED:未知错误。
  • INVALID_ARGUMENT:请求参数设置错误。
  • OBJECT_NOT_FOUND:操作的对象不存在。
  • OBJECT_AlREADY_EXISTS :操作的对象已存在。
OK
Messagestring

该参数已废弃,无需关注。

HostGroupIdstring

主机组 ID。

1
UserIdstring

用户 ID。

1
HostAccountNamesobject []

为用户移除主机账户授权操作返回的结果信息。

Codestring

为用户移除主机账户授权操作返回的结果。取值:

  • OK:操作成功。
  • UNEXPECTED:未知错误。
  • INVALID_ARGUMENT:请求参数设置错误。
  • OBJECT_NOT_FOUND:操作的对象不存在。
  • OBJECT_AlREADY_EXISTS :操作的对象已存在。
OK
Messagestring

该参数已废弃,无需关注。

HostAccountNamestring

主机账户名称。

root

示例

正常返回示例

JSON格式

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "无",
      "HostGroupId": "1",
      "UserId": "1",
      "HostAccountNames": [
        {
          "Code": "OK",
          "Message": "无",
          "HostAccountName": "root"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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

  • 本页导读 (1)
文档反馈