DescribeLiveDomainRealTimeTrafficData - ApsaraVideo Live

Operation description

Call this operation to query the real-time traffic and bandwidth of a streaming domain name for a specific region, carrier, and time period.
If you do not specify the StartTime and EndTime parameters, data from the last hour is queried by default. To query data for a specific time range, you must specify both the StartTime and EndTime parameters.
This operation returns monitoring data. This data is collected and processed differently from the data used for billing. Therefore, you cannot use the returned data for billing reconciliation.
You can query data from the last 90 days.

QPS limits

This operation has no queries per second (QPS) limit for a single user. You can call this operation as needed.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	Yes	The streaming domain name. To specify multiple domain names, separate them with commas (,).	example.com,example.aliyundoc.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you do not specify this parameter, data in the last hour is queried.	2015-12-10T15:00:00Z
IspNameEn	string	No	The name of the carrier. You can call the DescribeCdnRegionAndIsp operation to obtain the carrier name.	alibaba
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to obtain the region name.	tianjin
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2015-12-10T15:01:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T15:01:00Z
StartTime	string	The start of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T15:00:00Z
RequestId	string	The request ID.	A666D44F-19D6-490E-97CF-1A64AB962C57
DomainName	string	The streaming domain name.	example.com,example.aliyundoc.com
DataInterval	string	The time interval between data points. Unit: second.	60
RealTimeTrafficDataPerInterval	object
DataModule	array<object>	The traffic data returned for each time interval.
	object
Value	string	The traffic. Unit: byte.	0
TimeStamp	string	The start of the time segment. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T15:01:00Z

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T15:01:00Z",
  "StartTime": "2015-12-10T15:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com,example.aliyundoc.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2015-12-10T15:01:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	StartTime and EndTime can not be single.
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.
400	Abs.DomainName.Malformed	The size of DomainName is too big.
400	InvalidInterval.Malformed	Specified Interval is malformed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.