Updated on 2022-08-16 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

Databases cannot be created when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db_privilege

  • Example

    https://rds.my-kualalumpur-1.alphaedge.tmone.com.my/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_privilege

  • 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

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    db_name

    Yes

    String

    Specifies the database name.

    users

    Yes

    Array of objects

    Specifies the account that associated with the database. 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

    Specifies the username of the database account.

    The username consists of 1 to 32 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
    • If the database version is MySQL 5.6, the username consists of 1 to 16 characters.
    • If the database version is MySQL 5.7 or 8.0, the username consists of 1 to 32 characters.

    readonly

    Yes

    Boolean

    Specifies the read-only permission.

    • true: indicates the read-only permission.
    • false: indicates the read and write permission.
  • Request example
    {
        "db_name": "rds-test",
        "users": [
            {
                "name": "rds",
                "readonly": false
            },
            {
                "name": "rds001",
                "readonly": true
            }
        ]
    }

Response

  • Normal response
    Table 4 Parameter description

    Name

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.