Updated on 2026-04-30 GMT+08:00

Deleting a User

Function

This API is used to delete a user.

URI

DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

user_name

Yes

String

Definition

Username.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

message

String

Definition

Information.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Deleting a specified user

DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}

Example Responses

Status code: 200

The deletion is successful.

{
  "message" : "delete user success."
}

Status Codes

Status Code

Description

200

The deletion is successful.

Error Codes

See Error Codes.