Help Center> Distributed Database Middleware> API Reference> APIs (Recommended)> DDM Accounts> Deleting a DDM Account
Updated on 2022-06-30 GMT+08:00
View PDF

Deleting a DDM Account

Function

This API is used to delete a DDM account. This operation will also disassociate the account from associated schemas if any.

Constraints

None

URI

DELETE /v1/{project_id}/instances/{instance_id}/users/{username}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

DDM instance ID

username

Yes

String

Username of the DDM account to be deleted

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Username of the DDM account

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/users/{username}

Example Response

Status code: 200

OK

{
  "name" : "ddmtest"
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Accounts