Updated on 2024-06-07 GMT+08:00

Authorizing a Database Account

Function

This API is used to set permissions of 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, frozen, or abnormal.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    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

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

db_name

Yes

String

Database name.

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.

Table 3 users field data structure description

Name

Mandatory

Type

Description

name

Yes

String

Username of the database account. Currently, SQL users without login names cannot be authorized.

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

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

readonly

No

Boolean

Whether the permission is read-only. The default value is false.

  • true: indicates the read-only permission.
  • false: indicates the read and write permission.

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 Parameter description

    Name

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

Error Code

For details, see Error Codes.