DescribeDomainReqHitRateData - CDN - Alibaba Cloud Documentation Center

Queries the request hit ratio in percentage.

Operation description

You can call this operation up to 100 times per second per account.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	366 days	366 days	04:00 on the next day

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	No	The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,). By default, this operation queries the request hit ratio for all accelerated domain names that belong to your Alibaba Cloud account.	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.	2017-12-21T08: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.	2017-12-22T08:00:00Z
Interval	string	No	The time granularity of the data entries. Unit: seconds. The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.	300

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2017-12-22T08:00:00Z
StartTime	string	The start of the time range during which data was queried.	2017-12-21T08:00:00Z
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
ReqHitRateInterval	array<object>	The request hit ratio data at each time interval. The hit ratio is measured in percentage.
	object
Value	string	The request hit ratio.	100.0
TimeStamp	string	The timestamp of the returned data.	2017-12-22T08:00:00:00Z
HttpsValue	string	The hit ratio of HTTPS requests.	50.0

Examples

Sample success responses

JSONformat

{
  "EndTime": "2017-12-22T08:00:00Z",
  "StartTime": "2017-12-21T08:00:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainName": "example.com",
  "DataInterval": "300",
  "ReqHitRateInterval": {
    "DataModule": [
      {
        "Value": "100.0",
        "TimeStamp": "2017-12-22T08:00:00:00Z",
        "HttpsValue": "50.0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The specified start time is invalid. For more information, see the API references.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The format of the end time is invalid. Specify a valid value.
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.

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