DescribeLiveDomainRecordUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call the DescribeLiveDomainRecordUsageData operation to query the number of concurrent recordings and the container format conversion usage.

Operation description

This operation queries the number of concurrent recordings per day and returns data points at specified intervals. You can use this data to determine the peak number of concurrent recordings for a day or a month.
Time-shifted streams are not included in the recording count to avoid double counting.
You can query data for one or more domain names. To query multiple domain names, separate them with a comma (,).
For data with a 1 minute granularity, the maximum query span is 24 hours, and the maximum retention period is 60 days.
For data with a 1 hour granularity, the maximum query span is 31 days, and the maximum retention period is 180 days.
For data with a 1 day granularity, the maximum query span is 90 days, and the maximum retention period is 366 days.

QPS limit

The queries per second (QPS) limit for each user is 10. If you exceed this limit, your API calls are throttled, which may affect your business. We recommend that you call this operation within the limit.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain name that you want to query. You can query data for a single domain name or multiple domain names. To query multiple domain names, separate them with a comma (,). If you leave this parameter empty, the merged data for all your streaming domain names is returned. If you specify a domain name, make sure that it is a streaming domain name and that you have the required permissions to operate on it.	example.com
StartTime	string	No	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in Coordinated Universal Time (UTC). The minimum data granularity is 5 minutes. If you do not set this parameter, data from the last 24 hours is queried. Note The earliest start time you can set is 90 days before the current time. The time must be accurate to the second.	2021-05-10T20:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC. The following limits apply: The end time must be later than the start time. The time range between the start time and the end time cannot exceed 31 days. If it does, the request fails and an error is returned.	2021-05-10T21:00:00Z
Region	string	No	The region. Valid values: cn-beijing: Beijing cn-shanghai: Shanghai cn-shenzhen: Shenzhen cn-qingdao: Qingdao ap-southeast-1: Singapore eu-central-1: Frankfurt ap-northeast-1: Tokyo ap-southeast-5: Jakarta	cn-shanghai
SplitBy	string	No	The key to group data by. Valid values: domain: Groups the query results by domain name. record_fmt: Groups the query results by recording format. Note You can specify one or more keys. Separate multiple keys with a comma (,). The default value is `domain,record_fmt`. If you leave this parameter empty or set it to `null`, the data is not grouped.	domain,record_fmt
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 60 300 3600 86400 Note If you do not set this parameter or specify an invalid value, the default value is 300 seconds when the time span is 31 days or less, and 86400 seconds when the time span is more than 31 days.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2021-05-10T21:00:00Z
StartTime	string	The start of the time range.	2021-05-10T20:00:00Z
RequestId	string	The request ID.	4B460F8B-993C-4F48-B98A-910811DEBFEB
RecordUsageData	object
DataModule	array<object>	The recording usage data for each time interval.
	object
Type	string	The recording file format. This parameter is returned only if the SplitBy parameter in the request includes `record_fmt`.	MP4
Domain	string	The streaming domain name. This parameter is returned only if the SplitBy parameter in the request includes `domain`.	example.com
Region	string	The region.	cn-shanghai
TimeStamp	string	The start of the time interval.	2021-05-10T20:00:00Z
Duration	integer	The total recording duration. Unit: seconds.	3560
Count	integer	The peak number of concurrent recordings.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.