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

Deleting a Database User

Description

This API is used to delete a database user of a specified instance.

Restrictions

  • This API applies only to DDS Community Edition.
  • The default user and the rwuser user cannot be deleted.
  • This operation is not allowed if the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, restarting, or abnormal.

URI

  • URI format

    DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user

  • URI example

    https://ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f032c0db12d147ef87317efdfacbbe15in02/db-user

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

User token obtained from IAM. For details, see Authentication.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

string

path

Yes

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    user_name

    String

    Yes

    The name of the database user. The database user provided by the system cannot be deleted.

    The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.).

    db_name

    String

    Yes

    The database to which the user belongs.

    The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), and underscores (_).

  • Request example
{  
    "user_name":"test" , 
    "db_name":"test_db" 
}

Response Parameters

Response example

{}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.