Updated on 2024-09-27 GMT+08:00

Deleting a Domain Name

Function

This API is used to delete a domain name. Only domain names in the off state can be deleted.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/domain

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Deletes a domain name.

DELETE https://{endpoint}/v1/{project_id}/domain?domain=play.example.com

Example Responses

Status code: 400

Failed to delete the domain name.

{
  "error_code" : "LIVE.103011022",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

204

Domain name deleted.

400

Failed to delete the domain name.

Error Codes

See Error Codes.