DescribeDomainsUsageByDay - CDN - Alibaba Cloud Documentation Center

Queries the monitoring data of an accelerated domain name. Data is collected every day. You can query data collected within the last 90 days.

Operation description

You can call this operation up to 10 times per second per account.
If you do not set StartTime or EndTime, data within the last 24 hours is queried. If you set both StartTime and EndTime, data within the specified time range is queried.
You can query the monitoring data of a specific accelerated domain name or all accelerated domain names that belong to your Alibaba Cloud account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeDomainsUsageByDay	none	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify only one domain name. If you do not specify an accelerated domain name, the data of all accelerated domain names that belong to your account is queried.	example.com
StartTime	string	No	The beginning of the time range to query. 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 of the time range to query. 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 parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2019-12-23T09:00:00Z
StartTime	string	The start of the time range during which data was queried.	2019-12-22T08:00:00Z
RequestId	string	The ID of the request.	C88EF8ED-72F0-45EA-9E86-95114E224FC5
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	86400
UsageTotal	object	The summarized monitoring data.
MaxSrcBpsTime	string	The time when the bandwidth during back-to-origin routing reached the peak value.	2019-12-23 11:45:00
RequestHitRate	string	The cache hit ratio that is calculated based on requests. The cache hit ratio is measured in percentage.	69.92610837438424
MaxBps	string	The peak bandwidth value. Unit: bit/s.	1.0747912780000001E8
TotalAccess	string	The total amount of requests.	1319500
BytesHitRate	string	The byte hit ratio. The byte hit ratio is measured in percentage.	97.03110726801242
TotalTraffic	string	The total amount of network traffic. Unit: bytes.	1117711832100
MaxBpsTime	string	The time when the bandwidth reached the peak value.	2019-12-23 10:55:00
MaxSrcBps	string	The peak bandwidth value during back-to-origin routing. Unit: bit/s.	72584.072
UsageByDays	array<object>	The monitoring data collected at each time interval.
UsageByDay	object
MaxSrcBpsTime	string	The time when the bandwidth during back-to-origin routing reached the peak value.	2019-12-23 11:45:00
Qps	string	The number of queries per second (QPS).	7.466354166666667
RequestHitRate	string	The cache hit ratio that is calculated based on requests. The cache hit ratio is measured in percentage.	70.24770071912111
MaxBps	string	The peak bandwidth value. Unit: bit/s.	306747.76
TotalAccess	string	The total amount of requests.	645093
TimeStamp	string	The timestamp of the data returned.	2019-12-22
BytesHitRate	string	The byte hit ratio. The byte hit ratio is measured in percentage.	97.46250599529726
TotalTraffic	string	The total amount of network traffic. Unit: bytes.	564300099309
MaxSrcBps	string	The peak bandwidth value during back-to-origin routing. Unit: bit/s.	72584.072
MaxBpsTime	string	The time when the bandwidth reached the peak value.	2019-12-23 10:55:00

Examples

Sample success responses

JSONformat

{
  "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.	The specified start time is invalid. For more information, see the help documentation of this operation.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	The specified EndTime parameter is invalid.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The start time is invalid. Set this parameter to another value and try again.
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.	The specified domain name does not exist or does not belong to the current account. Check whether the domain name is valid, belongs to the current account, or has expired.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-13	The Error code has changed	View Change Details