Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Database and Account Management (PostgreSQL)/ Configuring Account Permissions
Updated on 2024-06-07 GMT+08:00
View PDF
Share

Configuring Account Permissions

Function

This API is used to set account permissions to read-only or read/write.

  • 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, frozen, or abnormal.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/user-privilege

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    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

    Instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

all_users

Yes

Boolean

Whether to configure permissions for all database accounts.

  • true: Configure permissions for all database accounts. The user_name parameter is ignored.
  • false: Configure permissions only for the account specified by user_name.

user_name

No

String

Username of the database account.

The username contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit and must be different from system usernames. System usernames include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy, and rdsDdm.

readonly

Yes

Boolean

Whether to set the permissions to read-only.

  • true: Set the permissions to read-only.
  • false: Set the permissions to read/write.

Example Request

  • Set all database accounts to read-only. 
    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/user-privilege

{
    "all_users": true,
    "readonly": true
}
  • Set all database accounts to readable and writable. 
    {
    "all_users": true,
    "readonly": false
}
  • Set a single database account to read-only. 
    {
    "all_users": false,
    "user_name": "test1234",
    "readonly": true
}
  • Set a single database account to readable and writable. 
    {
    "all_users": false,
    "user_name": "test1234",
    "readonly": false
}

Response

  • Normal response

    None

Status Code

Error Code

For details, see Error Codes.