Help Center/ Content Delivery Network/ API Reference/ API/ Domain Name Operations/ Querying Basic Information About a Domain Name
Updated on 2025-11-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Basic Information About a Domain Name

Function

This API is used to query basic information about a domain name, including the CNAME resolution status and whether the domain supports configuration replication.

  • A single tenant can call this API five times per second.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/configuration/domains

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

domain_names

No

String

Definition

Domain name.

NOTE:

  • Use commas (,) to separate multiple domain names.

  • This parameter is mandatory when the CNAME resolution status is queried.

Constraints

You can query only domain names that have been added to CDN.

Range

N/A

Default Value

N/A

item

Yes

String

Definition

Data type to be queried.

Constraints

N/A

Range

  • cname_status: CNAME resolution status of the domain name.

  • copy: domain names that support configuration replication under an account.

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID. Obtain the enterprise project ID by calling the ListEnterpriseProject API of EPS.

Constraints

This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects.

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

cname_status

Array of CnameStatus objects

CNAME resolution status of the domain name.
Table 4 CnameStatus

Parameter

Type

Description

status

Integer

CNAME resolution status of the domain name.

domain_name

String

Domain name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

ErrMsg object

Error code and error message.
Table 6 ErrMsg

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains?domain_names=www.example.com&item=cname_status

Example Responses

Status code: 200

Successful response.

{
  "CnameStatus" : [ {
    "status" : 0,
    "domain_name" : "www.example.com"
  } ]
}

Status Codes

Status Code

Description

200

Successful response.

400

Error response.

Error Codes

See Error Codes.

Parent Topic: Domain Name Operations