DescribeDomainHitRateData - API Reference| Alibaba Cloud Documentation Center

Usage notes

The maximum number of times that each user can call this operation per second is 100.
If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.

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 time range to query, as described in the following table.


Time granularity	Time range to 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDomainHitRateData	The operation that you want to perform. Set the value to DescribeDomainHitRateData.
DomainName	String	No	example.com	You can specify multiple domain names and separate them with commas (,). You can specify at most 500 domain names in each call. By default, this operation queries the byte hit ratios of all accelerated domain names that belong to your Alibaba Cloud account.
StartTime	String	No	2019-12-30T08:00:00Z	The start 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.
EndTime	String	No	2019-12-30T08:10:00Z	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.
Interval	String	No	300	The time interval between the data entries. Unit: seconds. The time granularity varies with the time range to query. Supported values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

Response parameters


Parameter	Type	Example	Description
EndTime	String	2019-12-30T08:10:00Z	The end of the time range that was queried.
StartTime	String	2019-12-30T08:00:00Z	The beginning of the time range that was queried.
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	The ID of the request.
DomainName	String	example.com	The accelerated domain name.
DataInterval	String	300	The time interval between the data entries returned. Unit: seconds.
HitRateInterval	Array of DataModule		The byte hit ratio at each time interval. The byte hit ratio is measured in percentage.
DataModule
Value	String	100.0	The byte hit ratio.
TimeStamp	String	2019-12-30T08:00:00Z	The timestamp of the data returned.
HttpsValue	String	50.0	The byte hit ratio of HTTPS requests.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainHitRateData
&DomainName=example.com
&StartTime=2019-12-30T08:00:00Z
&EndTime=2019-12-30T08:10:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainHitRateDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<RequestId>0A521165-99B6-41EF-B166-5B8B8068E1CF</RequestId>
<EndTime>2019-12-30T08:10:00Z</EndTime>
<StartTime>2019-12-30T08:00:00Z</StartTime>
<HitRateInterval>
    <DataModule>
        <TimeStamp>2019-12-30T08:00:00Z</TimeStamp>
        <Value>74.82824427480917</Value>
        <HttpsValue>0</HttpsValue>
    </DataModule>
    <DataModule>
        <TimeStamp>2019-12-30T08:05:00Z</TimeStamp>
        <Value>62.83283497081019</Value>
        <HttpsValue>100</HttpsValue>
    </DataModule>
</HitRateInterval>
</DescribeDomainHitRateDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DomainName" : "example.com",
  "DataInterval" : 300,
  "RequestId" : "0A521165-99B6-41EF-B166-5B8B8068E1CF",
  "EndTime" : "2019-12-30T08:10:00Z",
  "StartTime" : "2019-12-30T08:00:00Z",
  "HitRateInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2019-12-30T08:00:00Z",
      "Value" : "74.82824427480917",
      "HttpsValue" : 0
    }, {
      "TimeStamp" : "2019-12-30T08:05:00Z",
      "Value" : "62.83283497081019",
      "HttpsValue" : 100
    } ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.