DescribeLiveDomainRecordUsageData-阿里云帮助中心

Queries the number of concurrent recording streams and container format conversion usage for ApsaraVideo Live.

Operation description

Collects statistics on daily concurrent recording streams and sampling data at different time intervals. You can use this operation to query the peak number of daily or monthly concurrent recording streams.
Time shifting streams are not counted as recording streams.
Supports domain-level queries and batch domain queries. Separate multiple domain names with commas (,).
Data granularity: 1 minute. Maximum query span: 24 hours. Maximum data retention: 60 days.
Data granularity: 1 hour. Maximum query span: 31 days. Maximum data retention: 180 days.
Data granularity: 1 day. Maximum query span: 90 days. Maximum data retention: 366 days.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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 to query. Supports single or batch domain queries. Separate multiple domain names with commas (,). If this parameter is left empty, the merged data of all live streaming domain names is returned by default. When you specify DomainName, make sure that the specified domain name is a live streaming domain name and that the caller has the required permissions on the domain name.	example.com
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC. The minimum data granularity is 5 minutes. If this parameter is not specified, data of the last 24 hours is returned by default. Note The start time can be set to a point in time within the last 90 days from the current time, accurate to the second.	2021-05-10T20:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC. Requirements: The end time must be later than the start time (StartTime). The maximum time span between the end time and the start time is 31 days. Requests that exceed 31 days fail and return an error.	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: Germany. ap-northeast-1: Tokyo. ap-southeast-5: Jakarta.	cn-shanghai
SplitBy	string	No	The grouping key. Valid values: domain: groups query results by domain name. record_fmt: groups query results by recording type. Note You can specify one or more values. Separate multiple values with commas (,). Default value: `domain,record_fmt`. If this parameter is set to empty or `null`, the results are not grouped by the preceding keys.	domain,record_fmt
Interval	string	No	The time granularity of the queried data. Unit: seconds. Valid values: Note If this parameter is not specified or an unsupported value is specified, the default time granularity is 300 seconds for query spans within 31 days and 86400 seconds for query spans longer than 31 days.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-05-10T21:00:00Z
StartTime	string	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	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.