Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Managing Databases and Users/ Deleting a Database Role
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Deleting a Database Role

Description

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

Restrictions

  • This API applies only to DDS Community Edition.
  • Default system roles 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-role

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

Type

Mandatory

Description

role_name

String

Yes

The role name. The default database user of 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 name of the database to which the role 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
{ 
    "role_name": "testRole", 
    "db_name":"testDb"  
}

Response Parameters

Example response

{}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.