DescribeLiveDomainBpsData

Queries the network bandwidth monitoring data of a live streaming domain.

Operation description

If you do not specify StartTime or EndTime, data of the last 24 hours is returned by default. You can also query data for a specific time range by specifying both StartTime and EndTime.
If you specify only StartTime without EndTime, data within 1 hour from StartTime is returned.
If you specify only EndTime without StartTime, data within 1 hour before EndTime is returned.
You can query data of up to the last 90 days.
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: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. 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.	example.com
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-12-10T08: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 (UTC).	2017-12-10T09:00:00Z
Interval	string	No	The time granularity of the queried data. Unit: seconds. Valid values: 300 (default) 3600 86400 Note If this parameter is not specified or set to an unsupported value, the default value 300 is used. When the time granularity is 300, the returned bps value is the average number of bits transmitted per second within the 300-second interval. When the time granularity is 3600 or 86400, the returned bps value is the peak value among all 300-second data points within the query period.	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.	alibaba
LocationNameEn	string	No	The name of the region in English. You can call the DescribeCdnRegionAndIsp operation to obtain the region name.	tianjin

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-12-10T09:00:00Z
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-12-10T08:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The streaming domain.	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.