Query Live Recording Configurations by Domain with DescribeLiveRecordConfig - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries all recording configurations of apps under a live streaming domain.

Operation description

Obtain the ingest domain first, and then call this operation to query all app recording configurations under a live streaming domain.

QPS limit

The single-user QPS limit for this operation is 100 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:DescribeLiveRecordConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streamer's streaming domain.	example.com
AppName	string	No	The name of the application to which the stream belongs.	liveApp****
StreamName	string	No	The stream name.	liveStream****
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 5 to 30.	5
Order	string	No	The order in which entries are sorted by creation time. Valid values: asc (default): ascending order. desc: descending order. Valid values: asc : ascending order. desc : descending order.	asc

Response elements

Element	Type	Description	Example
	object
PageNum	integer	The page number.	5
RequestId	string	The request ID.	5056369B-D337-499E-B8B7-B761BD37B08A
Order	string	The sort order.	desc
TotalPage	integer	The total number of pages.	20
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of entries that meet the specified conditions.	12
LiveAppRecordList	object
LiveAppRecord	array<object>	The list of recording configurations.
	array<object>	The list of recording configurations.
EndTime	string	The scheduled recording end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-08T03:49:18Z
StartTime	string	The scheduled recording start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-08T02:49:18Z
AppName	string	The name of the application to which the stream belongs.	liveApp****
StreamName	string	The live stream name.	liveStream****
DelayTime	integer	The stream interruption concatenation duration. If the stream interruption duration exceeds the specified concatenation duration, a new file is generated. The concatenation duration ranges from 15 to 21600 seconds.	180
CreateTime	string	The creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2016-05-20T09:33:38Z
OnDemond	integer	The on-demand recording mode. Valid values: 0: Disabled. 1: Uses the HTTP callback method. 2: Uses the stream ingest parameter method. 7: Does not record by default. You can use the RealTimeRecordCommand operation to manually start or stop recording. Note If OnDemand is set to 1, configure OnDemandUrl by calling the AddLiveRecordNotifyConfig operation first. Otherwise, recording is not performed by default.	0
OssBucket	string	The name of the OSS bucket.	liveBucket****
DomainName	string	The streamer's streaming domain.	example.com
OssEndpoint	string	The OSS endpoint.	cn-oss-****.aliyuncs.com
RecordFormatList	object
RecordFormat	array<object>	The format list.
	object	The format list.
SliceDuration	integer	The segment length for a single segment of transcoding stream recording. Unit: seconds.	30
CycleDuration	integer	The periodic recording duration. Unit: seconds.	3600
SliceOssObjectPrefix	string	The segment name.	record/{liveApp**}/{liveStream**}/{UnixTimestamp}
OssObjectPrefix	string	The recording file name.	record/{liveApp**}/{liveStream**}
Format	string	The format.	M3U8
TranscodeRecordFormatList	object
RecordFormat	array<object>	The transcoded stream recording format list.
	object	The recording configuration file format list.
SliceDuration	integer	The segment length for a single segment of transcoding stream recording. Unit: seconds.	30
CycleDuration	integer	The periodic recording duration. Unit: seconds.	3600
SliceOssObjectPrefix	string	The segment name for transcoded stream recording.	record/{liveApp**}/{liveStream**}/{UnixTimestamp}
OssObjectPrefix	string	The file name for transcoded stream recording.	record/{liveApp**}/{liveStream**}
Format	string	The transcoded stream recording format.	M3U8
TranscodeTemplates	object
Templates	array	The transcoding template.
	string	The transcoding template for transcoded stream recording. If recording all transcoded streams is configured, the value ["*"] is returned.	["sd","hd"]

Examples

Success response

JSON format

{
  "PageNum": 5,
  "RequestId": "5056369B-D337-499E-B8B7-B761BD37B08A",
  "Order": "desc",
  "TotalPage": 20,
  "PageSize": 10,
  "TotalNum": 12,
  "LiveAppRecordList": {
    "LiveAppRecord": [
      {
        "EndTime": "2018-11-08T03:49:18Z",
        "StartTime": "2018-11-08T02:49:18Z",
        "AppName": "liveApp****",
        "StreamName": "liveStream****",
        "DelayTime": 180,
        "CreateTime": "2016-05-20T09:33:38Z",
        "OnDemond": 0,
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "OssEndpoint": "cn-oss-****.aliyuncs.com",
        "RecordFormatList": {
          "RecordFormat": [
            {
              "SliceDuration": 30,
              "CycleDuration": 3600,
              "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
              "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
              "Format": "M3U8"
            }
          ]
        },
        "TranscodeRecordFormatList": {
          "RecordFormat": [
            {
              "SliceDuration": 30,
              "CycleDuration": 3600,
              "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
              "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
              "Format": "M3U8"
            }
          ]
        },
        "TranscodeTemplates": {
          "Templates": [
            "[\"sd\",\"hd\"]"
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.