DescribeVodDomainHitRateData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the byte hit ratios of accelerated domain names. Byte hit ratios are measured in percentage.

Operation description

This operation is supported only in the China (Shanghai) region.
You can specify a maximum of 500 accelerated domain names.
If you specify neither StartTime nor EndTime, the data of the last 24 hours is queried. You can specify both StartTime and EndTime parameters to query data of a specified time range.

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 when you do not set Interval.

Time granularity	Time range per query	Historical data available	Data delay
5 minutes	Time range per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time range per query < 31 days	186 days	3 to 4 hours
1 day	31 days ≤ Time span of a single query ≤ 366 days	366 days	4 hours in most cases, not more than 24 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	No	The accelerated domain name. If you leave this parameter empty, the merged data of all your accelerated domain names is returned. You can specify multiple domain names and separate them with commas (,). You can specify a maximum of 500 domain names in each call. To obtain the accelerated domain name, perform the following steps: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > CDN Configuration > Domain Names. On the Domain Names page, view the accelerated domain names. Alternatively, you can call the DescribeVodUserDomains operation to query the accelerated domain names.	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.	2024-01-20T13:59:58Z
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.	2024-01-20T14:59:58Z
Interval	string	No	The time granularity. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used. The supported time granularity varies based on the time range specified by `EndTime` and `StartTime`. The following content describes the supported time granularity. Time range per query < 3 days: 300 (default), 3600, and 86400 3 days ≤ Time range per query < 31 days: 3600 (default) and 86400 31 days ≤ Time range per query ≤ 90 days: 86400 (default)	300

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
EndTime	string	The end of the time range.	2024-01-20T14:59:58Z
StartTime	string	The beginning of the time range.	2024-01-20T13:59:58Z
RequestId	string	The ID of the request.	D94E471F-1A27-442E-552D-D4D2000C****
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval at which data is returned, which is the time granularity. Unit: seconds.	300
HitRateInterval	array<object>	The byte hit rate data at each time interval.
	object
Value	string	The total byte hit rate.	100
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.	2024-01-20T13:59:58Z
HttpsValue	string	The HTTPS byte hit rate.	50

Examples

Sample success responses

JSONformat

{
  "EndTime": "2024-01-20T14:59:58Z",
  "StartTime": "2024-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "DataInterval": "300",
  "HitRateInterval": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2024-01-20T13:59:58Z",
        "HttpsValue": "50"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.