GetDomainUsage-Documentation

POST

https://api.cdnetworks.com/api/domain-usage

This interface is used to query the traffic data of a specified domain name in the East 9th District. The user needs to provide the query time range, domain name and contract information. The returned result contains the usage data of the domain name corresponding to each timestamp. It helps users monitor domain name traffic, perform resource planning and cost management.

Single user trigger frequency: 300/5min
Applicable Products: Local Storage

Request

Body Params

Name	Description
*dateFromString	Start time 1.The format is yyyy-MM-dd; 2.And smaller than the current time and 'dateTo'; 3.Only the data of the last 2 years can be queried.4.Period between dataFrom and dateTo should not be longer than 31 days
*dateToString	End time 1.The format is yyyy-MM-dd; 2.Must be greater than 'dateFrom'; 3.If it's greater than the current time, then the current time is assigned as the value.
*domainString	Domain. Only support send one domain at a time
*contractString	contract that the domain belong, only support send one contract at a time
typeString	Data granularity h: hourly d: daily If not specified, daily is set as the default value

Response

Body Params

Name	Description
domainString	Domain
- usageList
timestampString	DateTime, the format is yyyy-MM-dd HH:mm
usageString	Usage,the unit is byte

Error code

Error code(code)	Description(message)	HTTP status	Semantic
24102006	The date specified is invalid.	400	The date specified is invalid.
24102021	Date format error.	400	Date format error.
24102008	param: domain is null or invalid.	400	param: domain is null or invalid.
24102500	We encountered an internal error. Please try again.	500	We encountered an internal error. Please try again.
24102023	Failed to get ids. Please check the domain.	400	Failed to get ids. Please check the domain.
24102023	Invalid parameters. Please check the 'contract' or 'dateFrom' or 'dateTo'.	400	Invalid parameters. Please check the 'contract' or 'dateFrom' or 'dateTo'.
34102022	No contract permission	400	No contract permission
24102008	Domain not found	400	Domain not found

Example

JSON

Request example Copy

#!/bin/bash
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/api/domain-usage" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"dateFrom":"2022-08-01","dateTo":"2022-08-05","domain":"edu.xxx.net","type":"d"}'

Response example Copy

{
  "code": "0",
  "message": "success",
  "data": [
    {
      "timestamp": "2022-08-01",
      "usage": "2135"
    },
    {
      "timestamp": "2022-08-02",
      "usage": "2135"
    },
    {
      "timestamp": "2022-08-03",
      "usage": "2141"
    },
    {
      "timestamp": "2022-08-04",
      "usage": "2141"
    },
    {
      "timestamp": "2022-08-05",
      "usage": "2141"
    }
  ]
}

GetDomainUsage

Request

Body Params

Response

Body Params

Error code

Example

Directory