DescribeLiveDomainBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

If you do not specify the `StartTime` and `EndTime` parameters, data for the last 24 hours is queried by default. To query data for a specific time range, you must specify both `StartTime` and `EndTime`.
If you specify only `StartTime`, data for the one-hour period after `StartTime` is queried.
If you specify only `EndTime`, data for the one-hour period before `EndTime` is queried.
You can query data from the last 90 days.
This API call returns monitoring data. The data collection and processing methods are different from those used for billing. Do not use the data returned by this API call for billing reconciliation.

QPS limit

A single user can make up to 100 queries per second (QPS). If you exceed this limit, API calls are throttled. This can affect your business. We recommend that you call this API 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:DescribeLiveDomainBpsData

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 name. You can query one or more domain names. To query multiple domain names, separate them with commas (,). If you leave this parameter empty, the merged data for all streaming domains is returned.	example.com
StartTime	string	No	The start time. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2017-12-10T08:00:00Z
EndTime	string	No	The end time. The end time must be later than the start time. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2017-12-10T09:00:00Z
Interval	string	No	The time granularity to query data. Unit: seconds. Valid values: 300 (default) 3600 86400 Note If you do not specify this parameter or specify an invalid value, the default value 300 is used. If the time granularity is 300, the returned value is the average bandwidth in bit/s for a 300-second interval. If the time granularity is 3600 or 86400, the returned value is the peak bandwidth from all the 300-second data points within the query's time range.	300
IspNameEn	string	No	The English name of the carrier. You can obtain the value by calling the DescribeCdnRegionAndIsp operation.	alibaba
LocationNameEn	string	No	The English name of the region. You can obtain the value by calling the DescribeCdnRegionAndIsp operation.	tianjin

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range that was queried. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2017-12-10T09:00:00Z
StartTime	string	The start of the time range that was queried. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2017-12-10T08:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The streaming domain name.	example.com
DataInterval	string	The time granularity of the queried data. Unit: seconds.	300
BpsDataPerInterval	object
DataModule	array<object>	The network bandwidth data for each time interval.
	object	The network bandwidth data for each time interval.
BpsValue	string	The bandwidth value. Unit: bit/s.	11288111
TimeStamp	string	The start time of the time slice.	2017-12-10T08:00:05Z
HttpsBpsValue	string	The bandwidth value for HTTPS requests. Unit: bit/s.	2000
HttpBpsValue	string	The bandwidth value for HTTP requests. Unit: bit/s.	11286111

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T09:00:00Z",
  "StartTime": "2017-12-10T08:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T08:00:05Z",
        "HttpsBpsValue": "2000",
        "HttpBpsValue": "11286111"
      }
    ]
  }
}

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.