DescribeLiveTopDomainsByFlow - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call DescribeLiveTopDomainsByFlow to retrieve a list of domain names ranked by traffic.

Operation description

If you do not specify StartTime and EndTime, data for the current month is read by default. To query data for a specific time range, you must specify both a start time and an end time.
You can retrieve data from the last 90 days.

QPS limit

A single user can make up to 10 queries per second (QPS) for this operation. If you exceed the limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

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

live:DescribeLiveTopDomainsByFlow

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No		2018-03-17T16:00:00Z
EndTime	string	No	The start time of the query in UTC. The time must be in ISO 8601 notation in the YYYY-MM-DDThh:mm:ssZ format. The minimum data granularity is 5 minutes. If this parameter is omitted, data for the current month is returned by default.	2018-03-20T16:00:00Z
Limit	integer	No	The end time must be later than the start time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	20

Response elements

Element	Type	Description	Example
	object
DomainOnlineCount	integer	The total number of active domain names under the account.	1
EndTime	string	The end of the time range.	2018-03-20T16:00:00Z
StartTime	string	The start of the time range.	2018-03-17T16:00:00Z
RequestId	string	The request ID.	33834C3E-388E-5FFE-A8AE-63575035C064
DomainCount	integer	The total number of domain names under the account.	1
TopDomains	object
TopDomain	array<object>	The list of top domain names.
	object	The list of top domain names.
MaxBps	integer	The peak bandwidth.	22139626
Rank	integer	The rank.	1
TotalAccess	integer	The number of access requests.	107784230
TrafficPercent	string	The traffic percentage.	30.64191989360235
DomainName	string	The domain name.	example.com
TotalTraffic	string	The total traffic.	2043859876683.9001
MaxBpsTime	string	The time when the peak bandwidth was reached.	1457111400

Examples

Success response

JSON format

{
  "DomainOnlineCount": 1,
  "EndTime": "2018-03-20T16:00:00Z",
  "StartTime": "2018-03-17T16:00:00Z",
  "RequestId": "33834C3E-388E-5FFE-A8AE-63575035C064",
  "DomainCount": 1,
  "TopDomains": {
    "TopDomain": [
      {
        "MaxBps": 22139626,
        "Rank": 1,
        "TotalAccess": 107784230,
        "TrafficPercent": "30.64191989360235",
        "DomainName": "example.com",
        "TotalTraffic": "2043859876683.9001",
        "MaxBpsTime": "1457111400"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.