DescribeLiveDomainRecordUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

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 specify multiple domain names, separate them 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 limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveDomainRecordUsageData	The operation that you want to perform. Set the value to DescribeLiveDomainRecordUsageData.
DomainName	String	No	example.com	The main streaming domain to query. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you do not specify this parameter, the data of all domain names within your account is returned.
StartTime	String	No	2021-05-10T20:00:00Z	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.
EndTime	String	No	2021-05-10T21:00:00Z	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.
Region	String	No	cn-shanghai	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)
SplitBy	String	No	domain,record_fmt	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 only one option or both options. 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.
Interval	String	No	300	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 86,400 seconds by default.

Response parameters

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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainRecordUsageData
&StartTime=2021-05-10T20:00:00Z
&EndTime=2021-05-10T21:00:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDomainRecordUsageDataResponse>
    <StartTime>2021-05-10T20:00:00Z</StartTime>
    <EndTime>2021-05-10T21:00:00Z</EndTime>
    <RequestId>4B460F8B-993C-4F48-B98A-910811DEBFEB</RequestId>
    <RecordUsageData>
        <DataModule>
            <Type>MP4</Type>
            <Duration>3560</Duration>
            <Count>1</Count>
            <Domain>example.com</Domain>
            <TimeStamp>2021-05-10T20:00:00Z</TimeStamp>
        </DataModule>
    </RecordUsageData>
</DescribeLiveDomainRecordUsageDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Check whether the value of the EndTime parameter matches.
400	InvalidTimeSpan	The time span exceeds the limit.	The time range exceeds the limit. Configure a valid time range to query.
400	InvalidRecordFmt.NotSupported	The RecordFmt parameter is not supported.	The recording format is not supported. Specify a valid recording format.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

For a list of error codes, see Service error codes.

Special error codes

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