AttachHostAccountsToUserGroup - Bastionhost - Alibaba Cloud Documentation Center

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

Operation description

After you authorize a user group to manage specific hosts and host accounts, all the users in the user group have access to the authorized hosts and host accounts.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:AttachHostAccountsToUserGroup	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host in which you want to authorize the user group to manage the specified hosts 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 in which you want to authorize the user group to manage the specified hosts and host accounts. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserGroupId	string	Yes	The ID of the user group that you want to authorize to manage the specified hosts and host accounts. Note You can call the ListUserGroups operation to query the ID of the user group.	1
Hosts	string	Yes	The IDs of the host and host account that you want to authorize the user group to manage. You can specify up to 10 host IDs and up to 10 host account IDs for each host. You can specify only host IDs. In this case, the user group is authorized to manage only the specified hosts. For more information about this parameter, see the "Description of the Hosts parameter" section of this topic. Note You can call the ListHosts operation to query the ID of the host and the ListHostAccounts operation to query the ID of the host account.	[ {"HostId":"1"}, {"HostId":"2","HostAccountIds":["1","2","3",...]}, {"HostId":"3","HostAccountIds":["4","5","6",...]}, {"HostId":"4","HostAccountIds":["9","8","7",...]} ... ]

Description of the Hosts parameter

Field	Type	Example	Description
HostId	string	1	The ID of the host.
HostAccountIds	array[string]	["9","8","7"]	The ID of the host account. The value is a JSON string. You can specify up to 10 host account IDs for each host.

The following code provides an example on the settings of the Hosts parameter:

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

All Alibaba Cloud API requests 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	Description	Example
	object
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The result of the call.
Item	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.	N/A
HostId	string	The ID of the host.	1
UserGroupId	string	The ID of the user group.	1
HostAccounts	array<object>	The result of authorizing the specified user group to manage the specified host accounts.
Item	object
Code	string	The return code that indicates whether the user group was authorized to manage the specified 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.	N/A
HostAccountId	string	The ID of the host account.	1

Examples

Sample success responses

JSONformat

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

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.

For a list of error codes, visit the Service error codes.