DescribeLiveRtcRecordUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the usage data of cloud recording.

Operation description

Returns daily statistics on the recording duration for different cloud recording specifications.
You can query data at the application level for ApsaraVideo Real-time Communication.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second for this API. If you exceed the limit, API calls are throttled, which may affect your business. We recommend that you make API calls 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:DescribeLiveRtcRecordUsageData

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time to query data. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time. The query time range must be greater than or equal to 5 minutes and less than or equal to 31 days. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2022-10-10T21:00:00Z
AppId	string	Yes	The ID of the ApsaraVideo Real-time Communication application. For more information, see Application Management.	intl7f92-a5a8*************7ce4eb44a6
RecordMode	string	Yes	The recording mode: 0: Single-stream recording. 1: Stream mixing recording.	0
Interval	string	No	The time granularity to query data. Unit: seconds. Valid values: 3600 (default) 86400	3600

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	16A96B9A-F2*************B92E68F4CD8
RecordMode	string	The recording mode. 0: Single-stream recording. 1: Stream mixing recording.	0
AppId	string	The ID of the ApsaraVideo Real-time Communication application that was queried.	7fd341b3-c6fa-43e1-96b8-7295a1dd****
TotalSummaryDuration	number	The total duration. Unit: seconds.	150
AudioSummaryDuration	number	The total duration of audio-only recordings. Unit: seconds.	20
V480SummaryDuration	number	The total duration of videos with a resolution of 480p or lower. Unit: seconds.	30
V720SummaryDuration	number	The total duration of videos with a resolution of 720p or lower. Unit: seconds.	40
V1080SummaryDuration	number	The total duration of videos with a resolution higher than 720p, including 1080p. Unit: seconds.	10
Data	array<object>	The usage statistics.
	object	The usage statistics.
Timestamp	string	The timestamp of the data point. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).	2022-10-10T20:00:00Z
TotalDuration	number	The total duration. Unit: seconds.	150
AudioDuration	number	The duration of audio-only recordings. Unit: seconds.	20
V480Duration	number	The duration of videos with a resolution of 480p or lower. Unit: seconds.	30
V720Duration	number	The duration of videos with a resolution of 720p or lower. Unit: seconds.	40
V1080Duration	number	The duration of videos with a resolution higher than 720p. Unit: seconds.	10

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F2*************B92E68F4CD8",
  "RecordMode": "0",
  "AppId": "7fd341b3-c6fa-43e1-96b8-7295a1dd****",
  "TotalSummaryDuration": 150,
  "AudioSummaryDuration": 20,
  "V480SummaryDuration": 30,
  "V720SummaryDuration": 40,
  "V1080SummaryDuration": 10,
  "Data": [
    {
      "Timestamp": "2022-10-10T20:00:00Z",
      "TotalDuration": 150,
      "AudioDuration": 20,
      "V480Duration": 30,
      "V720Duration": 40,
      "V1080Duration": 10
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
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	InvalidRecordModeParameter	RecordMode parameter error.	RecordMode parameter error
400	InvalidAppIdParameter	AppId parameter error.	AppId parameter error
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.