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 an API, you need to understand the API in Authentication.
Constraints
- This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.
- By default, read-only users have the create and usage permissions on the public schema.
URI
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
Request
Name |
Mandatory |
Type |
Description |
---|---|---|---|
db_name |
Yes |
String |
Database name. The database name 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 library names. RDS for PostgreSQL template libraries include postgres, template0, and template1. |
users |
Yes |
Array of objects |
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. |
Name |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Specifies the username of the database account. 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, and rdsDdm. |
readonly |
Yes |
Boolean |
Specifies the database account permissions.
|
schema_name |
Yes |
String |
Specifies the schema name. 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 library names and existing schema names. This parameter is mandatory. RDS for PostgreSQL template libraries include postgres, template0, and template1. |
Example Request
{"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 Parameter description Name
Type
Description
resp
String
Returns successful if the invoking is successful.
- Example normal response
{ "resp": "successful" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.