Queries the byte hit ratio that is measured in percentage.

Note
  • If you do not set the StartTime or EndTime parameter, data collected within the last 24 hours is queried. If you set both the StartTime and EndTime parameters, data collected within the specified time range is queried.
  • You can specify one or more domain names and separate them with commas (,).
  • You can query data collected within the last 90 days.

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 one or more domain names and separate them with commas (,).

StartTime String No 2017-12-21T08:00:00:00Z

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.
  • Data is collected every 5 minutes.
  • If you do not set this parameter, data within the last 24 hours is returned.
EndTime String No 2017-12-22T08:00:00:00Z

The end of the time range to query.

  • The end time must be later than the start time.
  • Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.
  • The time must be in UTC.
Interval String No 300

The time interval between the data entries. Unit: seconds.

  • Valid values are 300, 3600, 14400, 28800, and 86400.
  • The default value is 300. If you do not set this parameter or if you specify an invalid value, the default value is used.

Response parameters

Parameter Type Example Description
DomainName String example.com

The accelerated domain name.

DataInterval String 300

The time interval between the returned entries, in seconds.

StartTime String 2015-12-10T20:00Z

The start of the time range that was queried.

EndTime String 2015-12-10T21:00Z

The end of the time range that was queried.

HitRateInterval Array of DataModule

The byte hit ratio at each time interval. The byte hit ratio is measured in percentage.

DataModule
TimeStamp String 2017-12-22T08:00:00:00Z

The timestamp of the data returned.

Value String 100.0

The byte hit ratio.

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http://cdn.aliyuncs.com?Action=DescribeDomainHitRateData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T21:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainHitRateDataResponse>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <RequestId>5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD</RequestId>
      <StartTime>2015-12-10T20:00:00Z</StartTime>
      <EndTime>2015-12-10T21:00:00Z</EndTime>
      <HitRateInterval>
            <DataModule>
                  <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
                  <Value>100.0</Value>
                  <HttpsValue>50.0</HttpsValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
                  <Value>100.0</Value>
                  <HttpsValue>50.0</HttpsValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:50:00Z</TimeStamp>
                  <Value>99.99932881437826</Value>
                  <HttpsValue>50.0</HttpsValue>
            </DataModule>
      </HitRateInterval>
</DescribeDomainHitRateDataResponse>

JSON format

{
    "DomainName": "example.com",
    "DataInterval": "300",
    "RequestId": "5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD",
    "StartTime": "2015-12-10T20:00:00Z",
    "EndTime": "2015-12-10T21:00:00Z",
    "HitRateInterval": {
        "DataModule": [
            {
                "TimeStamp": "2015-12-10T21:00:00Z",
                "Value": "100.0",
                "HttpsValue": "50.0"
            },
            {
                "TimeStamp": "2015-12-10T20:35:00Z",
                "Value": "100.0",
                "HttpsValue": "50.0"
            },
            {
                "TimeStamp": "2015-12-10T20:50:00Z",
                "Value": "99.99932881437826",
                "HttpsValue": "50.0"
            }
        ]
    }
}

Error codes

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