调用AttachHostGroupAccountsToUser接口为用户授权主机组和主机账号。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AttachHostGroupAccountsToUser

需要执行的操作。

取值：AttachHostGroupAccountsToUser。

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

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

说明 您可以调用ListHostGroups接口获取主机组ID，调用ListHostAccounts接口获取主机账户名称。
InstanceId String 是 bastionhost-cn-st220aw****

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

说明 您可以调用DescribeInstances接口获取该参数。
UserId String 是 1

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

说明 您可以调用ListUsers接口获取该参数。
RegionId String 否 cn-hangzhou

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

说明 区域ID和区域名称的对应关系，请参见地域和可用区。

HostGroups参数结构说明

字段

类型

示例值

描述

HostGroupId

string

1

主机组ID。

HostAccountNames

array[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的请求格式，请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

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

接口的调用结果。
Code String OK

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

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

为用户授权主机账户名称操作的返回结果信息。
Code String OK

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

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

主机账户名称。
Message String 无

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

主机组ID。
Message String 无

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

用户ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AttachHostGroupAccountsToUser
&HostGroups=[ {"HostGroupId":"1"}, {"HostGroupId":"2","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"3","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"4","HostAccountNames":["root","111","abc"]} ]
&InstanceId=bastionhost-cn-st220aw****
&UserId=1
&<公共请求参数>

正常返回示例

XML格式 

<AttachHostGroupAccountsToUserResponse>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Results>
            <HostGroupId>1</HostGroupId>
            <Message></Message>
            <Code>OK</Code>
            <UserId>1</UserId>
      </Results>
      <Results>
            <HostAccountNames>
                  <HostAccountName>root</HostAccountName>
                  <Message></Message>
                  <Code>OK</Code>
            </HostAccountNames>
      </Results>
</AttachHostGroupAccountsToUserResponse>

JSON格式 

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

错误码

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