Updated on 2025-08-20 GMT+08:00

Authorizing a Database Account

Function

This API is used to set permissions of a database account in a specified DB instance.

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}/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.

    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

N/A

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.

Table 3 users field data structure description

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Username of the database account.

Constraints

Currently, SQL users without login names cannot be authorized.

Range

It can contain up to 128 characters and must be different from system usernames.

System users include rdsadmin, rdsuser, rdsbackup, and rdsmirror.

Default Value

N/A

readonly

No

Boolean

Definition

Whether the permission is read-only.

Constraints

N/A

Range

  • true: read-only
  • false: read/write

Default Value

false

Example Request

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

{
    "db_name": "rds-test",
    "users": [
        {
            "name": "rds",
            "readonly": true
        },
        {
            "name": "rds001",
            "readonly": false
        }
    ]
}

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    resp

    String

    Definition

    Calling result.

    Range

    Returns successful if the calling is successful.

Status Code

Error Code

For details, see Error Codes.