Authorizes a user to manage one or more 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 AttachHostAccountsToUser

The operation that you want to perform.

Set the value to AttachHostAccountsToUser.

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 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 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 bastion host for which you want to authorize the user to manage the specified hosts 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 hosts 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 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

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 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
Results Array of Item

The result of the call.

Code String OK

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.
    Note Make sure that the request parameters are valid and call the operation again.
  • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.
    Note Check whether the specified ID of the bastion host exists, whether the specified hosts exist, and whether the specified host IDs are valid. Then, call the operation again.
  • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.
HostAccounts Array of Item

The result of authorizing the specified 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:

  • 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.
HostAccountId String 1

The ID of the host account.

Message String None

This parameter is deprecated.

HostId String 1

The ID of the host.

Message String None

This parameter is deprecated.

UserId String 1

The ID of the user.

RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AttachHostAccountsToUser
&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****
&UserId=1
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HTTP status code Error code Error message Description
500 InternalError An unknown error occurred. The error message returned because an unknown error occurred.
400 InvalidParameter The argument is invalid. The error message returned because one or more parameters are invalid.

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