Updated on 2024-03-21 GMT+08:00

Deleting a Domain Name

Function

This API is used to delete a domain name.

URI

DELETE /v1.0/cdn/domains/{domain_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Domain name ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that the domain name to be modified belongs to. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API.

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

domain

DomainsWithPort object

Domain name details.

Table 5 DomainsWithPort

Parameter

Type

Description

id

String

Domain name ID.

domain_name

String

Domain name.

business_type

String

Service type of the domain name. Possible values: web (website acceleration), download (file download acceleration), video (on-demand service acceleration), and wholeSite (whole site acceleration).

user_domain_id

String

Domain ID of the domain name's owner.

domain_status

String

Domain name status. Possible values:

  • online: CDN has been enabled for this domain name.

  • offline: CDN has been disabled for this domain name.

  • configuring: The domain name configuration is in progress.

  • configure_failed: The configuration fails.

  • checking: The domain is being reviewed.

  • check_failed: The domain name fails the review.

  • deleting: The domain name is being deleted.

cname

String

CNAME record of the domain name.

sources

Array of SourceWithPort objects

Origin server settings.

domain_origin_host

DomainOriginHost object

Host details.

https_status

Integer

Whether HTTPS is enabled for acceleration. 0: HTTPS is disabled. 1: HTTPS is enabled and the origin protocol is same as the user request. 2: HTTPS is enabled and the origin protocol is HTTP. 3: HTTPS is enabled and the origin protocol is HTTPS.

create_time

Long

Time when the domain name was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

modify_time

Long

Time when the domain name was modified. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

disabled

Integer

Whether the domain name is banned. Possible values: 0 (not banned) and 1 (banned).

locked

Integer

Whether the domain name is locked. Possible values: 0 (not locked) and 1 (locked).

auto_refresh_preheat

Integer

Whether automatic cache purge and prefetch are enabled. Possible values: 0 (disabled) and 1 (enabled).

service_area

String

Service area of the CDN service. Possible values: mainland_china (Chinese mainland), outside_mainland_china (outside the Chinese mainland), and global (global).

range_status

String

Whether range requests are supported. Possible values: off (not supported) and on (supported).

follow_status

String

Status of redirect from origin. Possible values: off (disabled) and on (enabled).

origin_status

String

Origin pull status. Possible values: off (disabled) and on (enabled).

banned_reason

String

Reason for banning the domain name. 1: This domain name contains inappropriate content. 2: The MIIT license of this domain name has expired. 3: This domain name is attacked. 150: This domain name contains pornographic content. 151: This domain name contains sensitive political content. 152: This domain name contains violent content. 153: This domain name contains gambling content.

locked_reason

String

Reason for locking the domain name.

enterprise_project_id

String

ID of the enterprise project to which the domain name resource belongs. This parameter is valid only when the enterprise project function is enabled. If this parameter is not specified, the default project is used. This parameter is mandatory when you use an IAM user to call this API.

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Table 6 SourceWithPort

Parameter

Type

Description

domain_id

String

Domain name ID.

ip_or_domain

String

Non-intranet IP address or domain name of the origin server.

origin_type

String

Origin server type. Possible values: ipaddr (IP address), domain (domain name), and obs_bucket (OBS bucket).

active_standby

Integer

Whether the origin server is primary or standby. Possible values: 1 (primary) and 0 (standby).

enable_obs_web_hosting

Integer

Whether static website hosting is enabled for an OBS bucket. Possible values: 0 (disabled) and 1 (enabled). This parameter is passed only when origin_type is set to obs_bucket.

http_port

Integer

HTTP port. Default value: 80.

https_port

Integer

HTTPS port. Default value: 443.

Table 7 DomainOriginHost

Parameter

Type

Description

domain_id

String

Domain name ID.

origin_host_type

String

Host type. Possible values: accelerate (acceleration domain name) and customize (custom domain name).

customize_domain

String

Domain name of the host. Host for pull from the primary origin server. If the acceleration domain name has multiple primary origin servers and each origin server has a host, CDN pulls content from the host of the first primary origin server in the origin server lists.

Example Requests

DELETE https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff80808***********************07d?enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "domain" : {
    "sources" : [ {
      "domain_id" : "ff80808***********************07d",
      "origin_type" : "ipaddr",
      "ip_or_domain" : "0.0.0.0",
      "active_standby" : 1,
      "http_port" : 80,
      "https_port" : 443
    } ],
    "cname" : "example1.example2.com.c.example3.com",
    "id" : "ff80808***********************07d",
    "user_domain_id" : "6e3********************************441",
    "domain_name" : "example1.example2.com",
    "business_type" : "web",
    "service_area" : "mainland_china",
    "domain_status" : "deleting",
    "https_status" : 2,
    "create_time" : 1532405584521,
    "modify_time" : 1532406543021,
    "domain_origin_host" : {
      "domain_id" : "ff80808***********************07d",
      "origin_host_type" : "accelerate",
      "customize_domain" : "example1.example2.com"
    },
    "disabled" : 0,
    "locked" : 0,
    "range_status" : "off",
    "follow_status" : "off",
    "origin_status" : "on",
    "auto_refresh_preheat" : 0
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.