Call the DetachDatabaseAccountsFromUserGroup API to revoke permissions on databases and database accounts from a user group - Bastionhost - Alibaba Cloud - Bastionhost

Removes databases and database accounts that are authorized to a user group.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host instance. Note You can call DescribeInstances to obtain this parameter.	bastionhost-cn-7mz2v120f0y
RegionId	string	No	The region ID of the bastion host. 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 from which you want to remove authorized databases and database accounts. Note You can call ListUserGroups to obtain this parameter.	1
Databases	array<object>	No	The information about the databases from which you want to remove authorization.
	object	No	You can specify up to 10 database instance IDs, and each database instance supports up to 10 database account IDs. You do not need to specify database account IDs. If you do not specify database account IDs, the authorized database instance and all authorized database accounts of the database instance are removed from the user group.
DatabaseId	string	No	The instance ID of the database from which you want to remove authorization.	4
DatabaseAccountIds	array	No	The IDs of the database accounts from which you want to remove authorization.
	string	No	The ID of the database account from which you want to remove authorization.	["1","2","3"]
ProjectId	integer	No	The project ID.	3

Request parameter data structure.

Array of Database objects.

Field	Type	Description
DatabaseId	string	The database instance ID.
DatabaseAccountIds	array[string]	The array of database account IDs. This parameter is a JSON-formatted string. You can specify up to 10 database account IDs.

The following is an example of this parameter.

[
{"DatabaseId":"1"}                                          // Remove database authorization and delete account authorization
{"DatabaseId":"2","DatabaseAccountIds":["1","2","3",...]},      // Remove only account authorization
{"DatabaseId":"5","DatabaseAccountIds":[]}                      // Not supported
...
]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID generated by Alibaba Cloud for this request.	AC528ED1-C302-56E5-9CB5-ADA625D64FF9
Results	array<object>	The result information.
	array<object>
Code	string	The error code. A value of OK indicates that the removal was successful. Other error codes indicate that the removal failed.	OK
DatabaseAccounts	array<object>	The database account information.
	object
Code	string	The error code. A value of OK indicates that the removal was successful. Other error codes indicate that the removal failed.	OK
DatabaseAccountId	string	The ID of the database account from which authorization was removed.	5
Message	string	The error message.	None
DatabaseId	string	The ID of the database from which authorization was removed.	27
Message	string	The error message.	None
UserGroupId	string	The user group ID.	3

Examples

Success response

JSON format

{
  "RequestId": "AC528ED1-C302-56E5-9CB5-ADA625D64FF9",
  "Results": [
    {
      "Code": "OK",
      "DatabaseAccounts": [
        {
          "Code": "OK",
          "DatabaseAccountId": "5",
          "Message": "None"
        }
      ],
      "DatabaseId": "27",
      "Message": "None",
      "UserGroupId": "3"
    }
  ]
}

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.