DescribeLiveDomainRealTimeBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the traffic and bandwidth usage of a specified domain name.
You can query data from the last 7 days. The time range of a single query cannot exceed 24 hours.
If you do not specify StartTime and EndTime, data for the last hour is returned by default.
This operation provides monitoring data. The data collection and processing methods are different from those used for billing. You cannot use the data from this operation for billing reconciliation.

QPS limit

The queries per second (QPS) limit for a single user is 10. If you exceed this limit, your API calls are throttled. This 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:DescribeLiveDomainRealTimeBpsData

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. Separate multiple domain names with commas (,).	example1.aliyundoc.com,example2.aliyundoc.com
IspNameEn	string	No	The English name of the carrier. For more information, see DescribeCdnRegionAndIsp.	alibaba
LocationNameEn	string	No	The English name of the region. For more information, see DescribeCdnRegionAndIsp.	tianjin
StartTime	string	No	The start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-11-30T05:39:00Z
EndTime	string	No	The end time. It must be later than the start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC). Note If you do not specify this parameter, data within one hour of the start time is queried by default.	2015-11-30T05:40:00Z

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-11-30T05:40:00Z
StartTime	string	The start of the time range. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-11-30T05:33:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B6******
DomainName	string	The streaming domain name.	example1.aliyundoc.com,example2.aliyundoc.com
DataInterval	string	The time granularity of the queried data.	60
RealTimeBpsDataPerInterval	object
DataModule	array<object>	The bandwidth data of the domain name at a 1-minute granularity.
	object	The bandwidth data of the domain name at a 1-minute granularity.
Value	string	The bandwidth data. Unit: bit/second.	59392614.8
TimeStamp	string	The data timestamp.	2015-11-30T05:39:00Z

Examples

Success response

JSON format

{
  "EndTime": "2015-11-30T05:40:00Z",
  "StartTime": "2015-11-30T05:33:00Z",
  "RequestId": "BC858082-736F-4A25-867B-E5B6******",
  "DomainName": "example1.aliyundoc.com,example2.aliyundoc.com",
  "DataInterval": "60",
  "RealTimeBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "59392614.8",
        "TimeStamp": "2015-11-30T05:39:00Z"
      }
    ]
  }
}

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.	Specified domain name is malformed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.