DescribeLiveDomainRecordUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the numbers of live recording channels and container format conversions.

Operation description

You can call this operation to query the number of concurrent recording channels on each day and event tracking data at different time intervals. This way, you can measure the peak number of concurrent recording channels on each day or month.
The number of time shifting channels is not included in the number of recording channels.
You can query data by domain name or query data for multiple domain names at a time. If you want to query data for multiple domain names at a time, separate the domain names with commas (,).
If you set the data granularity to 1 minute, the maximum time range to query is 24 hours. You can query data in the last 60 days.
If you set the data granularity to 1 hour, the maximum time range to query is 31 days. You can query data in the last 180 days.
If you set the data granularity to 1 day, the maximum time range to query is 90 days. You can query data in the last 366 days.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveDomainRecordUsageData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The main streaming domain to query. You can query one or more domain names. If you want to query data for multiple domain names at a time, separate the domain names with commas (,). If you do not specify this parameter, the data of all domain names under your account is returned.	example.com
StartTime	string	No	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. The minimum data granularity is 5 minutes. If you do not specify this parameter, the data in the last 24 hours is returned. Note The earliest start time that you can specify is 90 days back from the current time, accurate to seconds.	2021-05-10T20:00:00Z
EndTime	string	No	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. Value requirements: The end time is later than the start time. The time range between the start time and end time is up to 31 days. If the time range is more than 31 days, the request fails and an error is reported.	2021-05-10T21:00:00Z
Region	string	No	The ID of the region. Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) cn-qingdao: China (Qingdao) ap-southeast-1: Singapore eu-central-1: Germany (Frankfurt) ap-northeast-1: Japan (Tokyo) ap-southeast-5: Indonesia (Jakarta)	cn-shanghai
SplitBy	string	No	The key that is used to group data. Valid values: domain: groups results by domain name. record_fmt: groups results by recording type. Note You can select one option or both. If you want to select both options, separate them with a comma (,). The default value is `domain,record_fmt`. If you leave this parameter empty or set the value to `null`, this parameter is ignored.	domain,record_fmt
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 60 300 3600 86400 Note If you do not specify this parameter or specify an invalid value: The time granularity of the query for a time range that is less than or equal to 31 days is 300 seconds by default. The time granularity of the query for a time range that is more than 31 days is 86400 seconds by default.	300

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2021-05-10T21:00:00Z
StartTime	string	The beginning of the time range during which data was queried.	2021-05-10T20:00:00Z
RequestId	string	The request ID.	4B460F8B-993C-4F48-B98A-910811DEBFEB
RecordUsageData	array<object>	The recording data that was collected for each interval.
DataModule	object
Type	string	The recording file type. This parameter is returned if the value of the request parameter SplitBy contains `record_fmt`.	MP4
Domain	string	The main streaming domain. This parameter is returned if the value of the request parameter SplitBy contains `domain`.	example.com
Region	string	The region ID.	cn-shanghai
TimeStamp	string	The time when recording started.	2021-05-10T20:00:00Z
Duration	long	The recording length. Unit: seconds.	3560
Count	long	The number of peak channels.	1

Examples

Sample success responses

JSONformat

{
  "EndTime": "2021-05-10T21:00:00Z",
  "StartTime": "2021-05-10T20:00:00Z",
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "RecordUsageData": {
    "DataModule": [
      {
        "Type": "MP4",
        "Domain": "example.com",
        "Region": "cn-shanghai",
        "TimeStamp": "2021-05-10T20:00:00Z",
        "Duration": 3560,
        "Count": 1
      }
    ]
  }
}

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	InvalidRecordFmt.NotSupported	The RecordFmt parameter is not supported.	-
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	LiveServiceNotFound	%s	-

For a list of error codes, visit the Service error codes.

Special error codes

Error code	Description	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The error message returned because the request was denied due to traffic throttling.
InvalidDomain.NotFound	The domain provided does not belong to you.	404	The error message returned because the specified domain name does not exist or does not belong to the current account.