DescribeLiveDomainBpsDataByLayer - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Data can be stored for up to 90 days. This operation supports batch queries for up to 500 domain names. Separate multiple domain names with commas (,). If you query data for multiple domain names, the data is aggregated. The time granularity of the returned data varies based on the time range that you specify using the StartTime and EndTime parameters. The following list describes the details:

If the time range is 3 days or less, the time granularity is 5 minutes.
If the time range is longer than 3 days but no longer than 31 days, the time granularity is 1 hour.
If the time range is longer than 31 days, the time granularity is 1 day.

Note

If StartTime and EndTime are not specified, data for the last 24 hours is returned by default.

QPS limit

The queries per second (QPS) limit for a single user is 20. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you call this operation 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:DescribeLiveDomainBpsDataByLayer

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

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 specify multiple domain names and separate them with commas (,). If you do not specify this parameter, the aggregated data for all domain names is returned.	pull.aliyundoc.com
StartTime	string	No	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC. Note If this parameter is not specified, data in the last 24 hours is queried. The minimum data granularity is 5 minutes.	2022-03-15T16:00:00Z
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 is in UTC.	2022-03-16T16:59:59Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300 3600 86400 Note If the time range is 3 days or less, valid values for this parameter are 300, 3600, and 86400. If the time range is longer than 3 days but no longer than 31 days, valid values are 3600 and 86400. If the time range is longer than 31 days, you can set this parameter only to 86400. If this parameter is not specified or an invalid value is specified, the default value 300 is used.	300
IspNameEn	string	No	The English name of the ISP. If you do not specify this parameter, data for all ISPs is queried. Note For more information, see DescribeLiveRegionAndIsp.	tele***
LocationNameEn	string	No	The English name of the region. If you do not specify this parameter, data for all regions is queried. Note For more information, see DescribeLiveRegionAndIsp.	hangzhou
Layer	string	No	The dimension to query. Valid values: Network Layer (IPv4 and IPv6) Application Layer (HTTP, HTTPS, and QUIC) all (default)	all

Response elements

Element	Type	Description	Example
	object
BpsDataInterval	object
DataModule	array<object>	The bandwidth in bits per second (Bps) for each time interval.
	object	The bandwidth data for each time interval.
TimeStamp	string	The start of the time slice.	2022-03-15T16:00:00Z
TrafficValue	string	The total traffic. Unit: bytes.	331
Value	string	The peak bandwidth. Unit: bps.	0.56
DataInterval	string	The time interval between data records. Unit: seconds.	300
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-2A48566EA967

Examples

Success response

JSON format

{
  "BpsDataInterval": {
    "DataModule": [
      {
        "TimeStamp": "2022-03-15T16:00:00Z",
        "TrafficValue": "331",
        "Value": "0.56"
      }
    ]
  },
  "DataInterval": "300",
  "RequestId": "BEA5625F-8FCF-48F4-851B-2A48566EA967"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.
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	Specified end time does not math the specified start time,And the time range does not exceed 90 days.	The start time and the end time do not match. The start time cannot be later than the end time, and the interval between the start time and the end time cannot exceed 90 days.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.