AttachHostGroupAccountsToUser - Bastionhost - Alibaba Cloud Documentation Center

Authorizes a user to manage one or more host groups and host accounts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:AttachHostGroupAccountsToUser

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host for which you want to authorize the user to manage the host groups and host accounts. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host for which you want to authorize the user to manage the host groups and host accounts. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserId	string	Yes	The ID of the user that you want to authorize to manage the host groups and host accounts. Note You can call the ListUsers operation to query the ID of the user.	1
HostGroups	string	Yes	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.	[ {"HostGroupId":"1"}, {"HostGroupId":"2","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"3","HostAccountNames":["root","111","abc"]}, {"HostGroupId":"4","HostAccountNames":["root","111","abc"]} ]

Description of HostGroups

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"]},  
{"HostGroupId":"4","HostAccountNames":["root","111","abc"]} 
]

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The result of the call.
	array<object>
Code	string	The return code that indicates whether the call was successful. Valid values: OK: The call was successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: A request parameter is invalid. OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist. OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.	OK
Message	string	This parameter is deprecated.	None
HostGroupId	string	The ID of the host group.	1
UserId	string	The ID of the user.	1
HostAccountNames	array<object>	The result of authorizing the user to manage the host accounts.
	object
Code	string	The return code that indicates whether the user was authorized to manage the host account. Valid values: OK: The call was successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: A request parameter is invalid. OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist. OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.	OK
Message	string	This parameter is deprecated.	None
HostAccountName	string	The name of the host account.	root

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.