首页 运维安全中心（堡垒机） API参考 API目录 主机授权（仅支持V3.2.17及以上版本使用） AttachHostAccountsToUserGroup - 为用户组授权主机及主机账户

AttachHostAccountsToUserGroup - 为用户组授权主机及主机账户

调用AttachHostAccountsToUserGroup接口为用户组授权主机及主机账户。

接口说明

为用户组授权主机和主机账户后，该用户组内的用户都可以访问已授权的主机。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
InstanceId string 是

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

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

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

说明 区域ID和区域名称的对应关系，请参见地域和可用区。
cn-hangzhou
UserGroupId string 是

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

说明 您可以调用ListUserGroups接口获取该参数。
1
Hosts string 是

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

说明 您可以调用ListHosts接口获取主机ID，调用ListHostAccounts接口获取主机账户ID。
[ {"HostId":"1"}, {"HostId":"2","HostAccountIds":["1","2","3",...]}, {"HostId":"3","HostAccountIds":["4","5","6",...]}, {"HostId":"4","HostAccountIds":["9","8","7",...]} ... ]

Hosts参数结构说明

字段 类型 示例值 描述
HostId string 1 主机ID。
HostAccountIds array[string] ["9","8","7"] 主机账户ID。该参数为JSON格式的字符串，最多可设置10个主机账户ID。

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

[
{"HostId":"1"},
{"HostId":"2","HostAccountIds":["1","2","3",...]},
{"HostId":"3","HostAccountIds":["4","5","6",...]},
{"HostId":"4","HostAccountIds":["9","8","7",...]}
]

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

返回参数

名称 类型 描述 示例值
object
RequestId string

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

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

接口的调用结果。
object
Code string

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

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

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

 无
HostId string

主机ID。

 1
UserGroupId string

用户组ID。

 1
HostAccounts array

为用户组授权主机账户操作返回的结果信息。
object
Code string

为用户组授权主机账户操作返回的结果。取值：

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

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

 无
HostAccountId string

主机账户ID。

 1

示例

正常返回示例

JSON格式

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "无",
      "HostId": "1",
      "UserGroupId": "1",
      "HostAccounts": [
        {
          "Code": "OK",
          "Message": "无",
          "HostAccountId": "1"
        }
      ]
    }
  ]
}

错误码

Http code 错误码 错误信息 描述
400 InvalidParameter The argument is invalid. 参数错误
500 InternalError An unknown error occurred. 未知错误

访问错误中心查看更多错误码。
阿里云首页 运维安全中心（堡垒机） 相关技术圈