Updated on 2023-06-29 GMT+08:00

Deleting a Dictionary

Function

This API is used to delete a dictionary. When a dictionary is deleted, all its child dictionaries are deleted.

URI

DELETE /v2/{project_id}/instances/{instance_id}/dictionaries/{dict_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

dict_id

Yes

String

Dictionary ID.

Minimum: 0

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 64

project_id

Yes

String

Project ID.

Minimum: 0

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 128

error_details

String

Error information.

Minimum: 1

Maximum: 128

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

None

Example Responses

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status Codes

Status Code

Description

204

OK

403

Forbidden

Error Codes

See Error Codes.