All Products
Search

This Product

    Bastionhost:AttachHostAccountsToUserGroup

    Document Center

    Bastionhost:AttachHostAccountsToUserGroup

    Last Updated:Aug 11, 2026

    Grants a user group permissions on hosts and host accounts.

    Operation description

    After you grant a user group permissions on hosts and host accounts, all users in the user group can access the authorized hosts.

    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:AttachHostAccountsToUserGroup

    update

    *Instance

    acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID of the bastion host where the user group to be granted authorization resides.

    Note

    You can call the DescribeInstances operation to query this parameter.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the bastion host instance where the user group to be authorized resides.

    Note

    For the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    UserGroupId

    string

    Yes

    The ID of the user group to be authorized with hosts and host accounts.

    Note

    You can call the ListUserGroups operation to query this parameter.

    1
    Hosts

    string

    Yes

    The host IDs and host account IDs to be authorized for the user group. You can specify up to 10 host IDs, and each host supports up to 10 host account IDs. You do not need to specify host account IDs. If you do not specify host account IDs, only the hosts are authorized for the user group. For the specific structure of this parameter, see the Hosts parameter structure description below the request parameters list.

    Note

    You can call the ListHosts operation to query host IDs and call the ListHostAccounts operation to query host account IDs.

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

    No

    The project ID.

    Hosts parameter structure description

    FieldTypeExampleDescription
    HostIdstring1The host ID.
    HostAccountIdsarray[string]["9","8","7"]The host account IDs. This parameter is a JSON-formatted string. You can specify up to 10 host account IDs.

    The following is an example of this parameter.

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

    When calling this API operation, in addition to the request parameters described in this topic, you must also include Alibaba Cloud common request parameters. For more information about common request parameters, see Common parameters. For the request format of this API operation, see the request example in this topic.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID generated by Alibaba Cloud for this request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    Results

    array<object>

    The call results of the operation.

    array<object>

    Code

    string

    The result code of the operation. Valid values:

    • OK: The operation was successful.

    • UNEXPECTED: An unknown error occurred.

    • INVALID_ARGUMENT: The request parameters are invalid.

    • OBJECT_NOT_FOUND: The specified object does not exist.

    • OBJECT_AlREADY_EXISTS: The specified object already exists.

    OK
    Message

    string

    This parameter is deprecated and can be ignored.

    None
    HostId

    string

    The host ID.

    1
    UserGroupId

    string

    The user group ID.

    1
    HostAccounts

    array<object>

    The results of authorizing host accounts for the user group.

    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.

    None
    HostAccountId

    string

    The ID of the host account.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "HostId": "1",
      "UserGroupId": "1",
      "HostAccounts": [
        {
          "Code": "OK",
          "Message": "None",
          "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.