DescribeLiveDomainPvUvData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to view the geographic distribution of your video viewers, check access rankings for your accelerated domain names, and count the number of unique IP addresses that send requests to the domain name within a specific period.
If you do not specify the StartTime and EndTime parameters, data from the last 24 hours is queried by default. You can also query data for a specified time range.
You can query only one domain name at a time.
You can query data from the last 90 days.

QPS limit

The queries per second (QPS) limit for a single user is 100. If you exceed this limit, API calls are throttled. This may affect your business. We recommend that you call this operation at a reasonable frequency.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain. Note Make sure that the specified domain name is a streaming domain and that you have the required permissions to operate on it.	example.com
StartTime	string	No	The start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-17T16:00:00Z
EndTime	string	No	The end time. The time must be later than the start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-20T16:00:00Z

Response parameters

Parameter	Type	Description	Example
	object	The PV and UV data of the streaming domain.
EndTime	string	The end time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-20T16:00:00Z
StartTime	string	The start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-17T16:00:00Z
RequestId	string	The request ID.	E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
DomainName	string	The streaming domain.	example.com
DataInterval	string	The time interval for each record. Unit: seconds. The value is fixed at 3600.	3600
PvUvDataInfos	object
PvUvDataInfo	array<object>	A list of PV and UV data.
	object	A list of PV and UV data.
PV	string	The PV data.	3036
TimeStamp	string	The start time of the time slice. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-19T16:00:00Z
UV	string	The UV data.	2

Examples

Success response

JSON format

{
  "EndTime": "2018-03-20T16:00:00Z",
  "StartTime": "2018-03-17T16:00:00Z",
  "RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "DomainName": "example.com",
  "DataInterval": "3600",
  "PvUvDataInfos": {
    "PvUvDataInfo": [
      {
        "PV": "3036",
        "TimeStamp": "2018-03-19T16:00:00Z",
        "UV": "2"
      }
    ]
  }
}

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.
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	The specified time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.