Use DescribeVodDomainRealTimeDetailData to query real-time detail data for accelerated domain names - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Currently, this operation is available only in the China (Shanghai) region.
Batch queries are supported. You can query data for up to 20 domain names at a time.
The maximum time range per query (the time range between StartTime and EndTime) is 10 minutes, and data is returned at a time granularity of 1 minute.
Only data within the last 7 days can be queried.

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:DescribeVodDomainRealTimeDetailData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name to query. Batch queries are supported. Separate multiple domain names with commas (,). You can specify up to 20 domain names at a time. Log on to the ApsaraVideo VOD console, and in the left-side navigation pane, choose Configuration Management > CDN Configuration > Domain Names to view the accelerated domain names that you have added to ApsaraVideo VOD. Alternatively, call the DescribeVodUserDomains operation to query the list of accelerated domain names.	example.com
StartTime	string	Yes	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.	2019-01-23T12:35:12Z
EndTime	string	Yes	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, and the difference between the end time and the start time cannot exceed 10 minutes.	2019-01-23T12:40:00Z
Field	string	Yes	The type of access data to query. You can specify multiple types. Separate multiple types with commas (,). Valid values: qps: queries per second (QPS). bps: bandwidth data. http_code: HTTP status codes.	qps
LocationNameEn	string	No	The region name in English. If you do not specify this parameter, data for all regions is queried by default.	shanghai
IspNameEn	string	No	The Internet service provider (ISP) name in English. If you do not specify this parameter, data for all ISPs is queried by default.	unicom
Merge	string	No	Specifies whether to return aggregated data by domain name. Valid values: true: Returns aggregated data across all domain names. false (default): Returns data grouped by domain name.	false
MergeLocIsp	string	No	Specifies whether to return aggregated data by region and ISP. Valid values: true: Returns data grouped only by domain name, with region and ISP values aggregated. false (default): Returns data grouped by domain name, region, and ISP.	true

Response elements

Element

Type

Description

Example

object

Data

string

The returned data details. The data is returned as a JSON string. The following table describes the structure and fields:

Note

If no data exists for a field, the field is not returned.

Field	Type	Description
domain_name	String	The accelerated domain name.
isp	String	The ISP name.
location	String	The region name.
qps	Long	The queries per second (QPS).
bps	Long	The bandwidth data. Unit: bit/s.
http_code	Map	The HTTP status code details. The key is the status code name, and the value is the count of the status code.
time_stp	String	The data timestamp. The time is in the ISO 8601 standard in UTC.

[ { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Guangdong", "isp": "telecom", "qps": 10 }, { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Jiangsu", "isp": "unicom", "qps": 11.1 } ]

RequestId

string

The request ID.

1710298E-8AFA-5F6D-A3E9-47103C52177D

Examples

Success response

JSON format

{
  "Data": "[\n      {\n            \"time_stp\": \"2018-06-05T20:00:00Z\",\n            \"domain_name\": \"example.com\",\n            \"location\": \"Guangdong\",\n            \"isp\": \"telecom\",\n            \"qps\": 10\n      },\n      {\n            \"time_stp\": \"2018-06-05T20:00:00Z\",\n            \"domain_name\": \"example.com\",\n            \"location\": \"Jiangsu\",\n            \"isp\": \"unicom\",\n            \"qps\": 11.1\n      }\n]",
  "RequestId": "1710298E-8AFA-5F6D-A3E9-47103C52177D"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.