DescribeLiveDelayedStreamingUsage - ApsaraVideo Live - Alibaba Cloud Documentation Center

You can call the DescribeLiveDelayedStreamingUsage operation to query the usage data of delayed streaming.

Operation description

This operation queries the usage data of the delayed streaming service. The default time granularity is 1 hour.
The maximum time span for a query is 31 days.
The minimum time granularity for a query is 1 hour.
You can query data within the last 31 days.

QPS limit

The queries per second (QPS) limit for a single user is 5 calls per second. If the limit is exceeded, API calls are throttled. This may affect your business. Plan your 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:DescribeLiveDelayedStreamingUsage

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 that you want to query. 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 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 Coordinated Universal Time (UTC). By default, data from the last seven days is returned.	2022-10-10T20:00:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. The time span cannot exceed 10 hours. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2022-10-10T21:00:00Z
StreamName	string	No	The stream name. To specify multiple stream names, separate them with commas (,). If you leave this parameter empty, the aggregated data for all streams is returned.	liveStream****
Region	string	No	The live center to query. You can query multiple regions. To query multiple regions, separate them with commas (,). Valid values: cn-beijing: Beijing cn-shanghai: Shanghai cn-shenzhen: Shenzhen cn-qingdao: Qingdao ap-southeast-1: Singapore eu-central-1: Germany ap-northeast-1: Tokyo ap-southeast-5: Jakarta If you do not specify this parameter, the aggregated data for all regions is returned.	cn-shanghai
SplitBy	string	No	The key to group data by. If you leave this parameter empty, the aggregated data for the user is returned. Valid values: domain: The data is grouped by domain name. If you set this parameter to domain, the DomainName parameter in the response takes effect. region: The data is grouped by live center region. If you set this parameter to region, the Region parameter in the response takes effect. stream: The data is grouped by stream name. If you set this parameter to stream, the StreamName parameter in the response takes effect. Note You can query data only when the parameter corresponding to the group key is not empty. Otherwise, an error is returned. For example, you cannot set the group key to domain if the DomainName parameter is empty.	domain
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300 3600 86400 If you do not specify this parameter or specify an invalid value, the default value of 3600 is used.	3600

Response elements

Element	Type	Description	Example
	object	The response data.
DelayData	object
DelayDataItem	array<object>	The usage data of delayed streaming.
	object	The usage data of delayed streaming.
DomainName	string	The domain name for the usage data. This parameter is returned when you set SplitBy to domain.	example.com
Duration	integer	The usage of delayed streaming.	84
Region	string	The live center. This parameter is returned when you set SplitBy to region.	cn-shanghai
StreamName	string	The stream name. This parameter is returned when you set SplitBy to stream.	liveStream****
TimeStamp	string	The start time of the time slice.	2022-10-10T20:00:00Z
EndTime	string	The end of the time range.	2022-10-10T21:00:00Z
RequestId	string	The ID of the request.	4B460F8B-993C-4F48-B98A-91081******
StartTime	string	The start of the time range.	2022-10-10T20:00:00Z

Examples

Success response

JSON format

{
  "DelayData": {
    "DelayDataItem": [
      {
        "DomainName": "example.com",
        "Duration": 84,
        "Region": "cn-shanghai",
        "StreamName": "liveStream****",
        "TimeStamp": "2022-10-10T20:00:00Z"
      }
    ]
  },
  "EndTime": "2022-10-10T21:00:00Z",
  "RequestId": "4B460F8B-993C-4F48-B98A-91081******",
  "StartTime": "2022-10-10T20:00:00Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	InvalidParameter.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidStartTime.ValueNotSupported	The StartTime cannot exceed 31 days before the current time.
400	InvalidTime.Malformed	Specified Time is malformed.	Invalid time. Check whether the time that you specified is correct.
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	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.