All Documents
Current Document

Content is empty

If you don't find the content you expect, please try another search term

Documentation

GetReqHitRateData

Last updated:2021-07-20 11:46:09

GetReqHitRateData

Description

  • You can call this operation to obtain the request hit ratio for specified domain names. You can generate a hit ratio line chart based on the data. You can specify a time granularity for the statistics data, including 1 minute, 5 minutes, 1 hour, and 1 day. If you specify a granularity of 1 hour or 1 day, the sum of requests collected in the five-minute periods contained in the granularity is used.
  • You can query data within the past year. The start time and the end time cannot be more than 90 days apart.
  • You can specify the domain names (with the CdnType and Domains parameters) and time granularity to query data.

Request syntax

The API request contains the specified directory /2020-06-30/statistics/GetReqHitRateData, common request headers, and operation-specific request parameters. For more information, see the sample request.

Request parameters

Parameter Required Type Description
StartTime Yes String The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time must be in UTC+8. Example: 2016-08-01T21:10+0800.
EndTime Yes String The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time must be in UTC+8. The end time must be later than the start time. Example: 2016-08-01T21:15+0800.
Interval No Long The time granularity of the statistics data. Valid values: 1 (one minute), 5 (five minutes), 60 (one hour), and 1440 (one day). For granularities that are greater than or equal to 5 minutes, the sum of requests collected in the five-minute periods contained in the granularity is used. The default granularity is 5 minutes. When the granularity is 1 minute, the start time and the end time cannot be more than 24 hours apart. When the granularity is 5 minutes, the start time and the end time cannot be more than 31 days apart. For other granularities, the start time and the end time cannot be more than 90 days apart.
CdnType No String The business type. You can specify only one type at a time. Valid values: file, video, and page. By default, all types are queried. When both the CdnType and Domains parameters are specified, a strong check is performed.
Domains No String The domain names to query. Separate multiple domain names with commas (,). By default, all domain names of the current account that are online in the specified time period are queried. When both the CdnType and Domains parameters are specified, a strong check is performed.
ResultType No String Specifies whether to expand the statistics data. Valid values: unexpand and domain (expand by domain name). Default value: unexpand.

Response parameters

Parameter Type Description
StartTime String The beginning of the time range that is queried.
EndTime String The end of the time range that is queried.
Interval Long The time granularity.
CdnType String The business type.
Domains String The domain names, separated with commas (,).
ResultType String Indicates whether the statistics data is expanded and, if yes, in which dimensions.
Datas Datas[] The statistics data.
RequestId String The ID of the request.

Datas

Parameter Type Description
Condition Condition[] The query conditions.
DetailData DetailData[] The hit ratio of requests.

Condition

Parameter Type Description
Domains String The domain names, separated with commas (,).

DetailData

Parameter Type Description
Time String The time point.
HitPv Long The number of requests that hit the cache, which is calculated as follows: Service requests - Back-to-origin requests.
MissPv Long The number of requests that missed the cache, which is the number of back-to-origin requests.
HitPvProportion Double The proportion of requests that hit the cache, which is calculated as follows: HitPv/(HitPv+MissPv).
MissPvProportion Double The proportion of requests that missed the cache, which is calculated as follows: SrcPv/(HitPv+SrcPv).

Examples

Sample request

GET method:

GET /2020-06-30/statistics/GetReqHitRateData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Interval=5&CdnType=video&ResultType=
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetReqHitRateData
x-version: 2020-06-30

POST method:

POST /2020-06-30/statistics/GetReqHitRateData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetReqHitRateData
x-version: 2020-06-30
Content-Type: application/json
{
    "StartTime":"2020-09-01T08:00+0800",
    "EndTime":"2020-09-01T08:05+0800",
    "Interval":5,
    "CdnType":"video",
    "ResultType":""
}

Sample response

{
    "StartTime": "2020-09-01T08:00+0800",
    "EndTime": "2020-09-01T08:05+0800",
    "Interval": 5,
    "CdnType": "video",
    "Domains": "www.test.com",
    "ResultType": "unexpand",
    "RequestId": "0c24b681-be53-4425-abe3-4193be3dda5f",
    "Datas": [
        {
            "Condition": {},
            "DetailData": [
                {
                    "Time": "2020-09-01T08:00+0800",
                    "HitFlow": 270767,
                    "MissFlow": 15236,
                    "MissFlowProportion": 0.05327216847375727,
                    "HitFlowProportion": 0.9467278315262427
                }
            ]
        }
    ]
}
On this page
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback