Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database User Management/ Deleting Database Users
Updated on 2025-07-11 GMT+08:00
View PDF

Deleting Database Users

Function

This API is used to delete database users. Before calling this API:

URI

DELETE /v3/{project_id}/instances/{instance_id}/db-users

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Definition:

Instance ID, which uniquely identifies an instance.

Constraints:

N/A

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

users

Yes

Array of ListDeleteDatabaseUserRequest objects

List of database users to be deleted. The list contains up to 50 database users.
Table 4 ListDeleteDatabaseUserRequest

Parameter

Mandatory

Type

Description

name

Yes

String

Database username.

host

Yes

String

Host IP address.

Response Parameters

Status code: 202

Table 5 Response body parameter

Parameter

Type

Description

job_id

String

Definition:

ID of the task for deleting database users.

Range:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting the database user whose host IP address is 127.0.0.1

{
  "users" : [ {
    "name" : "gaussdb_mysql_user1",
    "host" : "127.0.0.1"
  } ]
}

Example Response

Status code: 202

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database User Management