Help Center > > API Reference> APIs (New Version)> Domain Name Operations> Querying Acceleration Domain Names

Querying Acceleration Domain Names

Updated at: Dec 02, 2019 GMT+08:00

Function

This API is used to query information about acceleration domain names.

URI

GET /v1.0/cdn/domains

Request

Request parameters

Table 1 describes the request parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

domain_name

No

String

Specifies the acceleration domain name, which is matched in a fuzzy manner. The value contains 1 to 255 characters.

business_type

No

String

Specifies the service type of the acceleration domain name. Valid values:

  • web (image and small file distribution)
  • download (larger file download acceleration)
  • video (AOD and VOD acceleration)

domain_status

No

String

Specifies the status of the acceleration domain name. Valid values:

  • online: indicates that CDN acceleration has been enabled for this domain name.
  • offline: indicates that CDN acceleration has been disabled for this domain name.
  • configuring: indicates that the domain name configuration is in progress.
  • configure_failed: indicates that the configuration fails.
  • checking: indicates that the task is being reviewed.
  • check_failed: indicates that the task failed in the review.
  • deleting: indicates that the domain name is being deleted.

service_area

No

String

Specifies the area covered by the acceleration service. Valid values are as follows:

  • mainland_china
  • outside_mainland_china
  • global

page_size

No

Integer

Number of records on each page. The value range is 1 to 10000. If this parameter is not set, the default value 30 is used.

page_number

No

Integer

Specifies the page number that is queried. The value range is 1 to 65535. If this parameter is not set, the default value 1 is used.

user_domain_id

No

String

Specifies the domain ID of the domain name's owner.

enterprise_project_id

No

String

Specifies the enterprise project ID. This parameter is valid only for users who have enabled the enterprise project function. If this parameter is not specified, the default project is queried. ALL indicates that the resources of all authorized projects of the user are queried.

Example request

Requested path

/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Response parameter

Parameter

Type

Description

total

Integer

Specifies the total number of queried acceleration domain names.

domains

Array of objects

Specifies the query results. For details, see Table 3.

domains parameter description

Table 3 describes the parameters.

Table 3 domains parameter description

Parameter

Type

Description

id

String

Specifies the acceleration domain name ID.

domain_name

String

Specifies the acceleration domain name.

business_type

String

Specifies the service type. Valid values are web (static content acceleration), download (download acceleration), and video (streaming media acceleration).

user_domain_id

String

Specifies the domain ID of the domain name's owner.

domain_status

String

Specifies the status of the acceleration domain name. Values include online: CDN is enabled; offline: CDN is disabled; configuring: CDN is being configured; configure_failed: the configuration failed; checking: an acceleration domain name is being audited; check_failed: the audit failed; deleting: the acceleration domain name is being deleted.

cname

String

Specifies the CNAME of the acceleration domain name.

sources

Array of objects

Specifies the domain name or the IP address of the origin server. Enter a maximum of 10 IP addresses and use commas (,) to separate them. Only IPv4 addresses are allowed. For details, see Table 4.

domain_origin_host

Object

Specifies the retrieval configuration of the domain name. For details, see Table 5.

https_status

Integer

Specifies whether HTTPS acceleration is enabled.

create_time

Integer

Specifies the time when the domain name is created, which is expressed as milliseconds since 1970-01-01 00:00:00 Coordinated Universal Time (UTC).

modify_time

Integer

Specifies the time when the domain name is modified, which is expressed as milliseconds since 1970-01-01 00:00:00 UTC.

disabled

Integer

Specifies whether the acceleration service is disabled. 0: not disabled; 1: disabled.

locked

Integer

Specifies whether the acceleration service is locked. 0: not locked; 1: locked.

third_part_cdn

String

Specifies a third-party CDN. When adding HTTP headers, the headers are set based on the third-party CDN.

service_area

String

Specifies the area covered by the acceleration service. Valid values are mainland_china, outside_mainland_china, and global.

range_status

String

Specifies whether range-based retrieval is enabled.

follow_status

String

Specifies whether 302 redirect retrieval is enabled.

enterprise_project_id

String

Specifies the ID of the enterprise project to which the domain name resource belongs. This parameter is returned when the enterprise project function is enabled.

sources parameter description

Table 4 describes the parameters.

Table 4 sources parameter description

Parameter

Type

Description

domain_id

String

Specifies the domain name ID.

ip_or_domain

String

Specifies the IP address or domain name of the origin server.

origin_type

String

Specified the type of the origin server. Valid values are ipaddr (IP address of the origin server), obs_bucket (domain name of an OBS bucket), and domain (domain name of the origin server).

active_standby

Integer

Specifies whether an origin server is active or standby (1: active; 0: standby). An active origin server is mandatory, while a standby origin server is optional. An OBS bucket does not have a standby origin server.

domain_origin_host parameter description

Table 5 describes the parameters.

Table 5 domain_origin_host parameter description

Parameter

Type

Description

domain_id

String

Specifies the domain name ID.

origin_host_type

String

Specifies the type of the retrieval host.

customize_domain

String

Specifies the custom domain name of the retrieval host.

  • Example response
    {
      "total" : 1,
      "domains" : [ {
        "sources" : [ {
          "domain_id" : "ab1234a*********************g56",
          "origin_type" : "ipaddr",
          "ip_or_domain" : "10.62.53.75",
          "active_standby" : 1
        } ],
        "cname" : "www.example.com.c.test.com",
        "id" : "ab1234a*********************g56",
        "user_domain_id" : "1e234********************441",
        "domain_name" : "www.example.com",
        "business_type" : "web",
        "service_area" : "mainland_china",
        "domain_status" : "online",
        "https_status" : null,
        "create_time" : 1516861994806,
        "modify_time" : 1532405346365,
        "domain_origin_host" : {
          "domain_id" : "ab1234a*********************g56",
          "origin_host_type" : "customize",
          "customize_domain" : "www.xxxx.com"
        },
        "disabled" : 0,
        "locked" : 0,
        "third_part_cdn" : null,
        "range_status" : "off",
        "enterprise_project_id" : null
      } ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel