AttachDatabaseAccountsToUserGroup - Bastionhost - Alibaba Cloud Documentation Center

Grants permissions on databases and database accounts 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:AttachDatabaseAccountsToUserGroup

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance. Note Call the DescribeInstances operation to obtain the instance ID.	bastionhost-cn-zvp282aly06
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserGroupId	string	Yes	The ID of the user group to which to grant the permissions.	2
Databases	array<object>	No	An array of database objects. Note You can specify up to 10 databases and 10 database accounts. If you do not specify any database accounts, permissions are granted on the entire database.
	object	No
DatabaseId	string	No	The ID of the database instance on which you want to grant permissions.	58
DatabaseAccountIds	array	No	An array of database account IDs.
	string	No	The ID of a database account.	["1","2","3"]

Request parameter data structure

An array of Database objects.

Field	Type	Description
DatabaseId	string	The ID of the database.
DatabaseAccountIds	array[string]	An array of account IDs. You can specify up to 10 account IDs.

The following code shows an example of this parameter.

[
{"DatabaseId":"1"}                                           // Grant permissions only on the database.
{"DatabaseId":"2","DatabaseAccountIds":["1","2","3",...]},       // Grant permissions on the database and its accounts.
{"DatabaseId":"5","DatabaseAccountIds":[]}                       // Not supported.
]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5D0EB759-CB0A-537D-A2CC-13A9854FA08D
Results	array<object>	The results of the call.
	array<object>
Code	string	The error code. If the value is `OK`, the authorization was successful. Other values indicate that the authorization failed.	OK
DatabaseAccounts	array<object>	A list of database account information.
	object
Code	string	The error code. If the value is `OK`, the authorization was successful. Other values indicate that the authorization failed.	OK
DatabaseAccountId	string	The ID of the database account.	8
Message	string	The error message.	NULL
DatabaseId	string	The ID of the database instance.	2
Message	string	The error message.	NULL
UserGroupId	string	The ID of the user group.	1

Examples

Success response

JSON format

{
  "RequestId": "5D0EB759-CB0A-537D-A2CC-13A9854FA08D",
  "Results": [
    {
      "Code": "OK",
      "DatabaseAccounts": [
        {
          "Code": "OK",
          "DatabaseAccountId": "8",
          "Message": "NULL"
        }
      ],
      "DatabaseId": "2",
      "Message": "NULL",
      "UserGroupId": "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.