EdgeNext Documentation

API Endpoint

Request URL: domain (GET)

API Request Domain: cdn.api.edgenext.com
API Version: v2

API Description

This API is used to query detailed information about accelerated domains.

Note:
The request rate limit is specified in the response headers. The maximum request frequency is 60 requests per minute.

Request Parameters

Common Parameters

The user's authentication token is required. Please contact the on-call support team to obtain a valid token.

GET Request Parameters

Request parameters should be added to the query string of the URL.

Example:

?key1=value1&key2=value2

Parameter Name	Data Type	Required	Description
domains	string	Yes	Specifies the accelerated domain names or domain IDs to query. A maximum of 10 domains or domain IDs can be queried in a single request.

Request Example

curl -X GET "https://cdn.api.edgenext.com/v2/domain?token=xxx\
&domains=example.com,example2.com"

Response Example

JSON format

{
    "code": 0, // code=0 indicates that the request was successful. Non-zero values indicate an error.
    "data": [
        {
            "id": "31335",
            "domain": "example.com",
            "type": "download",
            "status": "serving",
            "icp_status": "yes", // ICP filing status (checking: Checking, yes: Filed, no: Not filed)
            "cname": "example.com.edgenext.com.",
            "create_time": "2019-01-01 18:00:00",
            "update_time": "2019-01-01 21:00:00",
            "https": 0, // Whether HTTPS service is enabled (0: Disabled, 1: Enabled)
            "config": {
                "cache_rule": [
                    {
                        "type": 4,
                        "time": "1",
                        "timeunit": "D",
                        "pattern": "\\.(png|jpg)",
                        "ignore_no_cache": true,
                        "ignore_query": true
                    }
                ],
                "origin": {
                    "default_master": "1.1.1.1",
                    "origin_mode": "default",
                    "ori_https": "no",
                    "port": "" // Origin port information is only available for domains with HTTPS origin configuration
                }
            }
        },
        {
            "id": "32810",
            "domain": "example2.com",
            "type": "page",
            "status": "suspend",
            "cname": "example2.com.edgenext.com.",
            "create_time": "2019-03-01 18:00:00",
            "update_time": "2019-03-01 21:00:00",
            "https": 0,
            "config": {
                "referer": {
                    "allow_empty": false,
                    "type": 1,
                    "list": [
                        "*.qingcdn.com",
                        "new.vx.qingcdn.com"
                    ]
                },
                "origin": {
                    "default_master": "133.233.133.33",
                    "default_slave": "12.13.41.21",
                    "origin_mode": "custom",
                    "ori_https": "no",
                    "port": 8080,
                    "dx_master": "133.233.133.33,11.11.11.12",  // China Telecom primary origin
                    "dx_slave": "12.13.41.21,11.11.11.11",      // China Telecom backup origin
                    "lt_master": "133.233.133.33,11.11.11.12",  // China Unicom primary origin
                    "lt_slave": "12.13.41.21,11.11.11.11",      // China Unicom backup origin
                    "yd_master": "133.233.133.33,11.11.11.11",  // China Mobile primary origin
                    "yd_slave": "12.13.41.21,11.11.11.12"       // China Mobile backup origin
                },
                "origin_host": {
                    "host": "test.qingcdn.com"
                }
            }
        }
    ]
}

Response Parameters

Parameter Name	Data Type	Description
id	string	Domain ID
domain	string	Domain name
cname	string	CNAME assigned to the domain
type	string	Domain service type. page: Web page download: Download video_demand: Video on demand video_live: Live streaming dynamic: Dynamic content scdn: SCDN total_station: Whole site upload: Upload rim: RIM
status	string	Domain service status. serving: Serving deploying: Deploying suspend: Suspended
icp_status	string	ICP filing status. checking: Checking yes: Filed no: Not filed
create_time	string	Domain creation time
update_time	string	Domain update time
https	int	Whether HTTPS service is enabled. 0: Disabled 1: Enabled
config	object	Domain feature configuration. For details, refer to the config Parameter Description section.

config Parameter Description

origin (Origin Configuration)

Parameter Name	Data Type	Description
default_master	string	Primary origin server
default_slave	string	Backup origin server
origin_mode	string	Origin request mode. default: Use the same protocol and port as the client request. http: Use HTTP protocol with port 80 for origin requests. https: Use HTTPS protocol with port 443 for origin requests. custom: Use a custom protocol and port for origin requests.
ori_https	string	Whether HTTPS is used for origin requests
port	int	Origin port

origin_host (Origin Host)

Parameter Name	Data Type	Description
host	string	Origin host

referer (Referer Protection)

Parameter Name	Data Type	Description
type	int	Referer protection type. 1: Blocklist 2: Allowlist
list	array	Referer list
allow_empty	boolean	Whether requests with empty Referer are allowed. true: Allowed false: Not allowed

cache_rule (Cache Rules)

Parameter Name	Data Type	Description
type	int	Cache rule matching type. 1: File extension matching 2: Directory matching 3: Full path matching 4: Regular expression matching
pattern	string	Cache matching rule
time	int	Cache duration. When time=0, caching is disabled.
timeunit	string	Cache duration unit. Y: Year M: Month D: Day h: Hour i: Minute s: Second
ignore_no_cache	boolean	Whether to ignore no-cache headers. on: Ignore off: Do not ignore
ignore_expired	boolean	Whether to ignore expiration time. on: Ignore off: Do not ignore
ignore_query	boolean	Whether to ignore URL query strings in cache keys. on: Ignore query strings off: Include query strings

ip_black_list (IP Blocklist)

Parameter Name	Data Type	Description
list	array	IP blocklist

Response Headers

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
X-RateLimit-Remaining: 60  // Remaining requests within the current minute.
X-RateLimit-Limit: 60      // Maximum requests allowed per minute.
X-RateLimit-Grad: minute   // Rate limit granularity (minute/hour/day).
X-Retry-After: 30          // Number of seconds until the current rate limit period is reset.
Api-id: 31741661

HTTP Status Code Description

HTTP Status Code	Description
404	The requested URL is invalid.
401	Authentication failed. The token is invalid or the API permission has not been enabled.
400	Invalid request parameters.
200	Request completed successfully and the requested data is returned.
5xx	Server-side error. Please contact the on-call support team.