DescribeLiveStreamPushMetricDetailData - ApsaraVideo Live

Queries stream ingest data for a specified domain name at the application and stream level.

Operation description

You can query data for only one domain name at a time. An error is returned if you specify multiple domain names.
The maximum time range for a single query is 24 hours.
The minimum time granularity of the data is 1 minute.
You can query data generated within the last 31 days.
This API provides monitoring data. The data is collected and processed differently than billing data. Do not use this data for billing reconciliation.

QPS limit

A single user can make up to 10 queries per second (QPS). Calls that exceed this limit are throttled, which may affect your business. Plan your API calls accordingly.

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:DescribeLiveStreamPushMetricDetailData

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The accelerated domain name that you want to query. You can query data for only one domain name at a time. An error is returned if you specify multiple domain names. If you do not specify AppName and StreamName, data for all streams that are associated with the accelerated domain name is returned. The data is not aggregated. If you specify a value for DomainName and set both AppName and StreamName to all, aggregated data for all streams that are associated with the accelerated domain name is returned.	example.com
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-09-10T20:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. The end time must be later than the start time. The time range cannot exceed 24 hours. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-09-10T21:00:00Z
AppName	string	No	The name of the application. If you specify an application name, data at the application stream level is returned.	liveApp****
StreamName	string	No	The name of the stream. If you specify a StreamName, data at the stream level is returned for the specified AppName. You must specify AppName when you specify StreamName.	liveStream****
NextPageToken	string	No	The token that is used to retrieve the next page of results. A maximum of 5,000 data entries can be returned for each call. If the number of data entries to query exceeds the limit, the response includes a token. To retrieve the next page of results, include the token in the next request. When you specify the token in the next query, data continues to be obtained from the end of the previous query.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

Response elements

Element	Type	Description	Example
	object	The response.
DomainName	string	The accelerated domain name.	example.com
EndTime	string	The end of the time range to query. The time is in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-09-10T21:00:00Z
NextPageToken	string	The token that is used to retrieve the next page of results. A maximum of 5,000 data entries can be returned for each call. If the number of data entries to query exceeds the limit, the response includes a token. To retrieve the next page of results, include the token in the next request. When you specify the token in the next query, data continues to be obtained from the end of the previous query.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	The number of data entries returned.	5000
RequestId	string	The request ID.	5EBF2AC3-4B73-40A5-8B32-83F49D5F035E
StartTime	string	The start of the time range to query. The time is in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-09-10T20:00:00Z
StreamDetailData	object
StreamData	array<object>	The data group.
	object	The data group.
AppName	string	The application name.	liveApp****
ReqBps	number	The average bandwidth. Unit: Bps.	133.33
ReqTraffic	integer	The total traffic. Unit: byte.	1000
StreamName	string	The stream name.	liveStream****
TimeStamp	string	The start time of the time slice.	2022-09-10T20:00:00Z

Examples

Success response

JSON format

{
  "DomainName": "example.com",
  "EndTime": "2022-09-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "StartTime": "2022-09-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "liveApp****",
        "ReqBps": 133.33,
        "ReqTraffic": 1000,
        "StreamName": "liveStream****",
        "TimeStamp": "2022-09-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	InvalidTime.Malformed	Specified StartTime or 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	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
400	InvalidPageToken	The token of page is invalid.	The specified paging token is incorrect. Specify the correct token returned by the last query and confirm that your request parameters are not modified.
400	InvalidAppName.Mismatch	The AppName param must be passed.	The AppName parameter does not match. Make sure that you specify the correct AppName.
400	InvalidStreamProtocol.NotSupport	The specified stream protocol is not support.
400	InvalidStreamName.LengthTooLong	The specified stream name is too long.
400	InvalidAppName.LengthTooLong	The specified app name is too long.
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	The specified time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.