Assign Database Privileges via GrantAccountPrivilege to Control Access - PolarDB - Alibaba Cloud - PolarDB

Operation description

Note

An account can be authorized to access one or more databases.
If the specified account already has the access permissions on the specified databases, the operation returns a successful response.
Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
This operation is supported only for PolarDB for MySQL clusters.
By default, a privileged account for a cluster has all the permissions on the databases in the cluster.

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

polardb:GrantAccountPrivilege

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-****************
AccountName	string	Yes	The username of the account.	testacc
DBName	string	Yes	The names of the databases that the account can access. You can grant the access permissions on one or more databases to the specified standard account. If you need to specify multiple database names, separate the database names with commas (,).	testdb_1,testdb_2
AccountPrivilege	string	Yes	The permissions that are granted to the account. Valid values: ReadWrite: read and write permissions ReadOnly: read-only permissions DMLOnly: The account is granted the permissions to execute only DML statements on the database. DDLOnly: The account is granted the permissions to execute only DDL statements on the database. ReadIndex: The account has the read and index permissions on the database. Note The number of AccountPrivilege values must be the consistent with the number of DBName values. Each account permission must correspond to a database name in sequence. For example, you can set DBName to `testdb_1,testdb_2` and set AccountPrivilege to `ReadWrite,ReadOnly`. In this case, the specified standard account is granted the read and write permissions on the testdb_1 database and the read permission on the testdb_2 database.	ReadWrite,ReadOnly

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2FED790E-FB61-4721-8C1C-07C627*****

Examples

Success response

JSON format

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627*****"
}

Error response

JSON format

{
   "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EngineMigration.ActionDisabled	Specified action is disabled while custins is in engine migration.	The specified operation is disabled when custins is being migrated across engines.
400	LockTimeout	The request processing has failed due to lock timeout.	Failed to process the request due to a lock timeout.
400	Account.UpdateError	Instance %s update Account %s error	Failed to update account %s for cluster %s.
400	InvalidDBName.Malformed	The specified parameter DBName is not valid.	The format of the specified database name is invalid.
400	InvalidAccountName.Malformed	The specified parameter AccountName is not valid.	The specified AccountName parameter is invalid.
400	InvalidAccountPrivilege.Malformed	The specified parameter AccountPrivilege is not valid.	The specified AccountPrivilege parameter is invalid.
403	IncorrectAccountPrivilegeType	Current account privilege type does not support this operation.	The permission type of the current account does not support this operation.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.