Authorizes a user to manage one or more host groups and host accounts.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | AttachHostGroupAccountsToUser |
The operation that you want to perform. Set the value to AttachHostGroupAccountsToUser. |
HostGroups | String | Yes | [ {"HostGroupId":"1"}, {"HostGroupId":"2","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"3","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"4","HostAccountNames":["root","111","abc"]} ] |
The ID of the host group and the name of the host account that you want to authorize the user to manage. You can specify up to 10 host group IDs and up to 10 host account names for each host group. You can specify only host group IDs. In this case, the user is authorized to manage only the specified host groups. For more information about this parameter, see the "Description of the HostGroups parameter" section of this topic. Note You can call the ListHostGroups operation to query the ID of the host group and the ListHostAccounts operation to query the name of the host account.
|
InstanceId | String | Yes | bastionhost-cn-st220aw**** |
The ID of the bastion host for which you want to authorize the user to manage the specified host groups and host accounts. Note You can call the DescribeInstances operation to query the ID of the bastion host.
|
UserId | String | Yes | 1 |
The ID of the user that you want to authorize to manage the specified host groups and host accounts. Note You can call the ListUsers operation to query the ID of the user.
|
RegionId | String | No | cn-hangzhou |
The region ID of the bastion host for which you want to authorize the user to manage the specified host groups and host accounts. Note For more information about the mapping between region IDs and region names, see Regions and zones.
|
Description of the HostGroups parameter
Field |
Type |
Example |
Description |
---|---|---|---|
HostGroupId |
string |
1 |
The ID of the host group. |
HostAccountNames |
array[string] |
["root","111","abc"] |
The name of the host account. The value is a JSON string. You can specify up to 10 host account names for each host group. |
The following code provides an example on the settings of the HostGroups parameter:
[
{"HostGroupId":"1"},
{"HostGroupId":"2","HostAccountNames":["root","111","abc"]},
{"HostGroupId":"3","HostAccountNames":["root","111","abc"]},
null
]
All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.
For more information about sample requests, see the "Examples" section of this topic.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
The ID of the request. |
Results | Array of Item |
The result of the call. |
|
Code | String | OK |
The return code that indicates whether the call was successful. Valid values:
|
HostAccountNames | Array of Item |
The result of authorizing the user to manage the specified host accounts. |
|
Code | String | OK |
The return code that indicates whether the user was authorized to manage the specified host account. Valid values:
|
HostAccountName | String | root |
The name of the host account. |
Message | String | None |
This parameter is deprecated. |
HostGroupId | String | 1 |
The ID of the host group. |
Message | String | None |
This parameter is deprecated. |
UserId | String | 1 |
The ID of the user. |
Examples
Sample requests
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
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Results": [{
"HostGroupId": "1",
"Message": "",
"Code": "OK",
"UserId": "1"
}, {
"HostAccountNames": [{
"HostAccountName": "root",
"Message": "",
"Code": "OK"
}]
}]
}
Error codes
For a list of error codes, visit the API Error Center.