Updated on 2024-10-10 GMT+08:00

Enabling CDN for a Domain Name

Function

This API is used to enable CDN for a domain name.

URI

PUT /v1.0/cdn/domains/{domain_id}/enable

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 to which the resource belongs. 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 API for listing enterprise projects 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 corresponding IAM API (value of X-Subject-Token in the response header).

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. Possible values: web (website acceleration), download (download acceleration), and video (on-demand service acceleration).

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.

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

service_area

String

Area of the acceleration service provided by CDN, including europe (Europe) and outside_mainland_china (outside the Chinese mainland).

range_status

String

Status of range-based retrieval. Possible values: off (disabled) and on (enabled).

follow_status

String

Redirect retrieval status. Possible values: off (disabled) and on (enabled).

origin_status

String

Origin pull status. off: disabled. on: enabled.

banned_reason

String

Reason for disabling the domain name. 1: This domain name is banned because it contains inappropriate content. 2: This domain name is banned because its MIIT license has expired. 3: This domain name is banned after being attacked. 150: This domain name is banned because it contains pornographic content. 151: This domain name is banned because it contains sensitive political content. 152: This domain name is banned because it contains violent content. 153: This domain name is banned because it contains gambling content.

locked_reason

String

Reason for locking the domain name.

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) and domain (domain name).

active_standby

Integer

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

http_port

Integer

HTTP port. Default value: 80.

https_port

Integer

HTTPS port. Default value: 443.

Example Requests

PUT https://cdn.myhuaweicloud.eu/v1.0/cdn/domains/ff80***********************c82722/enable?enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "domain" : {
    "sources" : {
      "origin_type" : "domain",
      "ip_or_domain" : "example.origin.com",
      "active_standby" : 1,
      "http_port" : 80,
      "https_port" : 443
    },
    "cname" : "www.example1.example2.0002.example3.com.c.example4.com",
    "id" : "ff80808264c7*******fc82722",
    "domain_name" : "www.example1.example2.0002.example3.com",
    "business_type" : "web",
    "service_area" : "europe",
    "domain_status" : "configuring",
    "https_status" : 0,
    "create_time" : 1532403213673,
    "modify_time" : 1532403782746,
    "disabled" : 0,
    "locked" : 0,
    "range_status" : "off",
    "follow_status" : "off",
    "origin_status" : "on"
  }
}

Status Codes

Status Code

Description

200

OK