Updated on 2026-08-25 GMT+08:00

Granting Read or Write Permissions to a Database Account

Function

This API is used to grant read or write permissions to a database account in a specified DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:databasePrivilege:grant	-	-	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:databasePrivilege:grant

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

Constraints

This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, or abnormal.
By default, read-only users have the create and usage permissions on the public schema.

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/db_privilege

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
db_name	Yes	String	Definition Database name. Constraints N/A Range You can obtain the value of this parameter from name in Table 3 by calling the API for querying databases. The name cannot be the same as that of any RDS for PostgreSQL template database, including postgres, template0, and template1. Default Value N/A
users	Yes	Array of objects	Definition Database accounts. Each element is a database account. A single request supports a maximum of 50 elements. For details on the element structure, see Table 3. Constraints N/A

**Table 3** users field data structure description
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Specifies the username of the database account. Constraints N/A Range The database account name contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit and must be different from system user names. System users include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy, rdsDdm, and rdsDisaster. Default Value N/A
readonly	Yes	Boolean	Definition Specifies the database account permissions. Constraints N/A Range true: read-only false: read and write Default Value N/A
schema_name	Yes	String	Definition Specifies the schema name. Constraints N/A Range The value cannot be empty and contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit, and must be different from RDS for PostgreSQL template database names and existing schema names. This parameter is mandatory. RDS for PostgreSQL template databases include postgres, template0, and template1. Default Value N/A

Example Request

Grant read and write permissions to rds and rds002, and read-only permissions to rds001.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db_privilege

{"db_name": "rds_test",
    "users": [
        {
            "name": "rds",
            "readonly": false,
            "schema_name": "teste123"
        },
        {
            "name": "rds001",
            "readonly": true,
            "schema_name": "teste123"
        },
       {
            "name": "rds002",
            "readonly": false,
            "schema_name": "teste123"
        }
    ]
 }

Response

Normal response

Table 4 Parameters

Parameter

Type

Description

resp

String

Definition

Calling result.

Range

Returns successful if the calling is successful.

**Table 4** Parameters
Parameter	Type	Description
resp	String	Definition Calling result. Range Returns successful if the calling is successful.

Example normal response
```
{
    "resp": "successful"
}
```
Abnormal response
For details, see Abnormal Response Results.

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database and Account Management (PostgreSQL)