DescribeLiveDomainPushBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

The bandwidth data is measured in bit/s.
You can query data for multiple domain names. To do this, separate the domain names with commas (,).
If you do not specify the StartTime and EndTime parameters, data from the last 24 hours is returned. To query data for a specific time range, you must specify both the StartTime and EndTime parameters.
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, 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:DescribeLiveDomainPushBpsData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The ingest domain name. You can specify multiple domain names and separate them with commas (,). If you leave this parameter empty, the merged data for all ingest domains is returned.	demo.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 Coordinated Universal Time (UTC). If you do not specify this parameter, data from the last 24 hours is returned.	2017-12-10T20:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time.	2017-12-10T21:00:00Z
Interval	string	No	The time granularity of the data. Unit: seconds. Valid values: 300 3600 86400 If you do not specify this parameter or specify an invalid value, the default value 300 is used.	300
IspNameEn	string	No	The English name of the carrier. You can call the DescribeCdnRegionAndIsp operation to obtain the name. If you do not specify this parameter, data for all carriers is returned.	alibaba
LocationNameEn	string	No	The English name of the region. You can call the DescribeCdnRegionAndIsp operation to obtain the name. If you do not specify this parameter, data for all regions is returned.	tianjin

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2017-12-10T21:00:00Z
StartTime	string	The start of the time range.	2017-12-10T20:00:00Z
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
DomainName	string	The ingest domain name that was queried.	demo.aliyundoc.com
DataInterval	string	The time granularity of the queried data.	300
BpsDataPerInterval	object
DataModule	array<object>	The network bandwidth data at each time interval.
	object
BpsValue	string	The bandwidth value in bit/s.	11288111
TimeStamp	string	The start time of the time slice.	2017-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "DomainName": "demo.aliyundoc.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

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.