Query daily usage data for accelerated domains with DescribeDomainsUsageByDay - CDN - Alibaba Cloud - CDN

Queries the daily monitoring statistics of accelerated domain names. You can query data from the last 90 days.

Operation description

Invoke frequency per user: 10 times per second.
If you do not specify StartTime and EndTime, data from the last 24 hours is read by default. If you specify StartTime and EndTime, data is queried based on the specified time range.
You can query data for a single domain name or all domain names under the current user.

Supported time granularities

Based on the maximum time span of a single query, the request parameter Interval supports different data timestamp granularities. The corresponding time range of historical data that can be queried and data delay are as follows:

Time granularity	Maximum time span per query	Time range of historical data	Data delay
1 day	90 days	366 days	Generally delayed by 4 hours, and no more than 24 hours.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeDomainsUsageByDay

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Only one domain name is supported. By default, data of all domain names under the current user is queried.	example.com
StartTime	string	No	The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-12-22T08:00:00Z
EndTime	string	No	The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time.	2019-12-23T09:00:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time in the ISO 8601 standard in UTC.	2019-12-23T09:00:00Z
StartTime	string	The start time in the ISO 8601 standard in UTC.	2019-12-22T08:00:00Z
RequestId	string	The request ID.	C88EF8ED-72F0-45EA-9E86-95114E224FC5
DomainName	string	The information about the accelerated domain name.	example.com
DataInterval	string	The time interval of each record. Unit: seconds.	86400
UsageTotal	object	The aggregated data.
MaxSrcBpsTime	string	The time when the peak back-to-origin bandwidth occurred.	2019-12-23 11:45:00
RequestHitRate	string	The request hit rate in percentage.	69.92610837438424
MaxBps	string	The peak bandwidth. Unit: bit/s.	1.0747912780000001E8
TotalAccess	string	The total number of visits.	1319500
BytesHitRate	string	The byte hit rate in percentage.	97.03110726801242
TotalTraffic	string	The total traffic. Unit: bytes.	1117711832100
MaxBpsTime	string	The time when the peak bandwidth occurred.	2019-12-23 10:55:00
MaxSrcBps	string	The peak back-to-origin bandwidth. Unit: bit/s.	72584.072
UsageByDays	object
UsageByDay	array<object>	The statistics for each time interval.
	object
MaxSrcBpsTime	string	The time when the peak back-to-origin bandwidth occurred.	2019-12-23 11:45:00
Qps	string	The queries per second (QPS).	7.466354166666667
RequestHitRate	string	The request hit rate in percentage.	70.24770071912111
MaxBps	string	The peak bandwidth. Unit: bit/s.	306747.76
TotalAccess	string	The total number of visits.	645093
TimeStamp	string	The start time of the time slice for the queried data. The date is in the YYYY-MM-DD format.	2019-12-22
BytesHitRate	string	The byte hit rate in percentage.	97.46250599529726
TotalTraffic	string	The total traffic. Unit: bytes.	564300099309
MaxSrcBps	string	The peak back-to-origin bandwidth. Unit: bit/s.	72584.072
MaxBpsTime	string	The time when the peak bandwidth occurred.	2019-12-23 10:55:00

Examples

Success response

JSON format

{
  "EndTime": "2019-12-23T09:00:00Z",
  "StartTime": "2019-12-22T08:00:00Z",
  "RequestId": "C88EF8ED-72F0-45EA-9E86-95114E224FC5",
  "DomainName": "example.com",
  "DataInterval": "86400",
  "UsageTotal": {
    "MaxSrcBpsTime": "2019-12-23 11:45:00",
    "RequestHitRate": "69.92610837438424",
    "MaxBps": "1.0747912780000001E8",
    "TotalAccess": "1319500",
    "BytesHitRate": "97.03110726801242",
    "TotalTraffic": "1117711832100",
    "MaxBpsTime": "2019-12-23 10:55:00",
    "MaxSrcBps": "72584.072"
  },
  "UsageByDays": {
    "UsageByDay": [
      {
        "MaxSrcBpsTime": "2019-12-23 11:45:00",
        "Qps": "7.466354166666667",
        "RequestHitRate": "70.24770071912111",
        "MaxBps": "306747.76",
        "TotalAccess": "645093",
        "TimeStamp": "2019-12-22",
        "BytesHitRate": "97.46250599529726",
        "TotalTraffic": "564300099309",
        "MaxSrcBps": "72584.072",
        "MaxBpsTime": "2019-12-23 10:55:00"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
404	InvalidDomain.NotFound	The domain provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.