GrantAccountPrivilege - PolarDB - Alibaba Cloud Documentation Center

Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.

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.

You can call this operation only on a PolarDB for MySQL cluster.

By default, a privileged account for a cluster has all the permissions on the databases in the cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:GrantAccountPrivilege	update	*dbcluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	none	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 parameters

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

Examples

Sample success responses

JSONformat

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

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-12	The Error code has changed	View Change Details
2023-09-12	The Error code has changed	View Change Details