DescribeDomainRealTimeByteHitRateData - CDN - Alibaba Cloud Documentation Center

Queries the byte hit ratios of accelerated domain names.

Operation description

You can call this operation up to 10 times per second per account.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
The network traffic destined for different domain names may be redirected to the same origin server. Therefore, the byte hit ratios may be inaccurate. The accuracy of query results is based on the actual configurations.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularity	Maximum time range per query	Historical data available	Data delay
1 minute	1 hour	7 days	5 minutes
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify up to 100 domain names in each call. Separate multiple domain names with commas (,).	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.	2020-05-15T09:13: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.	2020-05-15T09:15:00Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	70A26B11-3673-479C-AEA8-E03FC5D3496D
Data	array<object>	The data returned.
	object
ByteHitRate	float	The byte hit ratio. The byte hit ratio is measured in percentage.	0.8956940476262277
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-11-30T05:40:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "70A26B11-3673-479C-AEA8-E03FC5D3496D",
  "Data": {
    "ByteHitRateDataModel": [
      {
        "ByteHitRate": 0.8956940476262277,
        "TimeStamp": "2019-11-30T05:40:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The specified start or end time is invalid.
400	InvalidDomainName.Malformed	Specified domain name is malformed.	-

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