Authorizes a specified user group to manage specified hosts and host accounts.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AttachHostAccountsToUserGroup

The operation that you want to perform.

Set the value to AttachHostAccountsToUserGroup.

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

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 leave the host account ID empty, which indicates that 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.
InstanceId String Yes bastionhost-cn-st220aw****

The ID of the Bastionhost instance where 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 Bastionhost instance.
UserGroupId String Yes 1

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.
RegionId String No cn-hangzhou

The region ID of the Bastionhost instance where 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.

Description of the Hosts parameter

Parameter

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 sample code provides an example of 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 Bastionhost 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 Example Description
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

The ID of the request.

Results Array of Item

The call result of the operation.

Code String OK

The return code that indicates whether the call was successful. Valid values:

  • OK: The call was successful.
  • UNEXPECTED: An unknown error has occurred.
  • INVALID_ARGUMENT: A request parameter is invalid.
  • OBJECT_NOT_FOUND: The specified user group is invalid.
  • OBJECT_AlREADY_EXISTS: The specified user group has been authorized to manage the specified host.
HostAccounts Array of Item

The result of authorizing the specified user group to manage the specified host accounts.

Code String OK

The return code that indicates whether the specified user group was authorized to manage the specified host account. Valid values:

  • OK: The specified user group was authorized to manage the specified host account.
  • UNEXPECTED: An unknown error has occurred.
  • INVALID_ARGUMENT: A request parameter is invalid.
  • OBJECT_NOT_FOUND: The specified host account is invalid.
  • OBJECT_AlREADY_EXISTS: The specified user group has been authorized to manage the specified host account.
HostAccountId String 1

The ID of the host account.

Message String N/A

This parameter is obsolete.

HostId String 1

The ID of the host.

Message String N/A

This parameter is obsolete.

UserGroupId String 1

The ID of the user group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AttachHostAccountsToUserGroup
&Hosts=[ {"HostId":"1"}, {"HostId":"2","HostAccountIds":["1","2","3",...]}, {"HostId":"3","HostAccountIds":["4","5","6",...]}, {"HostId":"4","HostAccountIds":["9","8","7",...]} ... ]
&InstanceId=bastionhost-cn-st220aw****
&UserGroupId=1
&<Common request parameters>

Sample success responses

XML format

<AttachHostAccountsToUserGroupResponse>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Results>
            <Message></Message>
            <HostId>1</HostId>
            <Code>OK</Code>
            <UserGroupId>1</UserGroupId>
      </Results>
      <Results>
            <HostAccounts>
                  <Message></Message>
                  <Code>OK</Code>
                  <HostAccountId>1</HostAccountId>
            </HostAccounts>
      </Results>
</AttachHostAccountsToUserGroupResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.