Use DescribeVodDomainRealTimeByteHitRateData to query the real-time byte hit ratio - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Currently, this operation is supported only in the China (Shanghai) region.
Batch queries are supported. You can query data for up to 100 domain names at a time.
If you do not specify StartTime and EndTime, this operation returns data from the last hour by default. If you specify StartTime and EndTime, this operation returns data for the specified time range.

Time granularity of returned data

The time granularity of returned data varies based on the time range specified by StartTime and EndTime. The following table describes the queryable historical data range and data delay for each time granularity:

Time granularity	Time range per query	Queryable historical data range	Data delay
1 minute	Time range per query ≤ 1 hour	7 days	5 minutes
5 minutes	1 hour < Time range per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time range per query < 31 days	186 days	Typically 3 to 4 hours

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodDomainRealTimeByteHitRateData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name to query. Separate multiple domain names with commas (,). You can specify up to 100 domain names at a time. When you query multiple domain names, the returned data is the aggregated data of all specified domain names. Log on to the ApsaraVideo VOD console, and choose Configuration Management > CDN Configuration > Domain Names in the left-side navigation pane to view the accelerated domain names that you have added to ApsaraVideo VOD. You can also call the DescribeVodUserDomains operation to query the list of 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.	2020-05-15T09:13: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.	2020-05-15T09:15:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	70A26B11-3673-479C-AEA8-E03FC5D3496D
Data	object
ByteHitRateDataModel	array<object>	The returned data details.
	object
ByteHitRate	number	The byte hit ratio, in percentage.	0.8956940476262277
TimeStamp	string	The data timestamp. The time is specified in the ISO 8601 standard and is in UTC.	2020-05-15T09:13:00Z

Examples

Success response

JSON format

{
  "RequestId": "70A26B11-3673-479C-AEA8-E03FC5D3496D",
  "Data": {
    "ByteHitRateDataModel": [
      {
        "ByteHitRate": 0.8956940476262277,
        "TimeStamp": "2020-05-15T09:13:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.
400	InvalidDomainName.Malformed	Specified domain name is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidParameterType	The specified Type is invalid.	The Type parameter is invalid. Modify the value of the Type parameter based on the documentation.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span based on the documentation.
400	InvalidParameter	Invalid input parameter.	Input parameter error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.