Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database User Management/ Deleting a Database User
Updated on 2023-10-18 GMT+08:00
View PDF

Deleting a Database User

Function

This API is used to delete a database user. 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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
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 parameters

Parameter

Type

Description

job_id

String

ID of the task for deleting database users.

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