DescribeLiveDomainTrafficData API Reference & Usage - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries network traffic monitoring data for live streaming domains.

Operation description

If you do not specify StartTime or EndTime, data from the past 24 hours is returned by default.
This is a monitoring data API. The data collection and processing method differs from that used for billing. Do not use this API to calculate usage for billing reconciliation.

QPS limit

The single-user QPS limit for this API is 100 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this API 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:DescribeLiveDomainTrafficData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain. You can specify a single domain name or multiple domain names. Separate multiple domain names with commas (,). If this parameter is left empty, the merged data of all live streaming domains is returned by default. Note When you specify DomainName, make sure that the specified domain names are live streaming domains and that you have the required permissions to operate on the specified domain names.	example.com
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC. Note You can query data from the past 90 days.	2017-12-10T14:00:00Z
EndTime	string	No	The end time. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2017-12-10T15:00:00Z
Interval	string	No	The time granularity for querying data. Unit: seconds. Valid values: 300 (default). 3600. 86400. Note If you do not set this parameter or set it to an unsupported value, the default value 300 seconds is used.	300
IspNameEn	string	No	The name of the Internet service provider (ISP) in English. You can call the DescribeCdnRegionAndIsp operation to obtain the ISP name. If you do not set this parameter, data of all ISPs is returned.	alibaba
LocationNameEn	string	No	The name of the region in English. You can call the DescribeCdnRegionAndIsp operation to obtain the region name. If you do not set this parameter, data of all regions is returned.	tianjin

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2017-12-10T15:00:00Z
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2017-12-10T14:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The streaming domain.	example.com
DataInterval	string	The time granularity for querying data.	300
TrafficDataPerInterval	object
DataModule	array<object>	The traffic data for each time interval.
	object	The traffic data for each time interval.
TrafficValue	string	The total traffic. Unit: bytes.	454680793
HttpTrafficValue	string	The HTTP traffic. Unit: bytes.	0
TimeStamp	string	The start of the time slice.	2017-12-10T15:00:05Z
HttpsTrafficValue	string	The HTTPS traffic. Unit: bytes.	454680793

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T15:00:00Z",
  "StartTime": "2017-12-10T14:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "TrafficValue": "454680793",
        "HttpTrafficValue": "0",
        "TimeStamp": "2017-12-10T15:00:05Z",
        "HttpsTrafficValue": "454680793"
      }
    ]
  }
}

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	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
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.