All Products
Search
Document Center

Bastionhost:DetachHostGroupAccountsFromUser

Last Updated:Jan 12, 2023

Revokes permissions on one or more host groups and host accounts from a user.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
yundun-bastionhost:DetachHostGroupAccountsFromUser Write
    All resources
    without
without

Request parameters

Parameter Type Required Description Example
InstanceId string Yes

The ID of the bastion host for which you want to revoke permissions on the specified host groups and host accounts from the user.

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 revoke permissions on the specified host groups and host accounts from the user.

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 from which you want to revoke permissions on the specified 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 on which you want to revoke permissions from the user. 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 permissions on the specified host groups and all host accounts in the host groups are revoked from the user. 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"]}]

Description of the HostGroups parameter

Field Type Example Description
HostGroupId string 1 The ID of the host group.
HostAccountIds 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"]},  
null 
]

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 Description Example
object
RequestId string

The ID of the request.

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

The result of the call.

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.

HostGroupId string

The ID of the host group.

1
UserId string

The ID of the user.

1
HostAccountNames array

The result of revoking permissions on the specified host accounts from the user.

object
Code string

The return code that indicates whether permissions on the specified host account were revoked from the user. 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.

HostAccountName string

The name of the host account.

root

Example

Normal return example

JSONFormat

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

Error codes

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

For a list of error codes, visit the API error center.