DescribeLiveRecordConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries all recording configurations of an AppName for a streaming domain.

Operation description

Obtain the main streaming domain, and then call this operation to query the recording configurations of an AppName under the main streaming domain.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.

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 main streaming domain.	example.com
AppName	string	No	The AppName of the live stream.	liveApp****
StreamName	string	No	The name of the live stream.	liveStream****
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 5 to 30. Default value: 10.	5
Order	string	No	The order in which the entries are sorted based on creation time. Valid values: asc (default): 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 sorting order of recording configurations by creation time.	desc
TotalPage	integer	The total number of pages.	20
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of recording configurations that meet the specified conditions.	12
LiveAppRecordList	object
LiveAppRecord	array<object>	The list of recording configurations.
	array<object>	The recording configuration.
EndTime	string	The end time of the recording. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-08T03:49:18Z
StartTime	string	The start time of the recording. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-08T02:49:18Z
AppName	string	The AppName of the live stream.	liveApp****
StreamName	string	The name of the live stream.	liveStream****
DelayTime	integer	The window in seconds for merging fragmented recording after an interruption. If a stream disconnects and reconnects within this window, the recording will continue in the same file. Valid values: 15 to 21600.	180
CreateTime	string	The time when the recording configuration was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-05-20T09:33:38Z
OnDemond	integer	The configuration of on-demand recording. Valid values: 0: disables on-demand recording. 1: on-demand recording that is triggered by HTTP callbacks. 2: on-demand recording that is triggered by stream ingest parameters. 7: Call the RealTimeRecordCommand API to manually start or stop recording. Note If you set OnDemand to 1, you must call the AddLiveRecordNotifyConfig operation to configure OnDemandUrl. Otherwise, the configuration of on-demand recording is invalid.	0
OssBucket	string	The name of the Object Storage Service (OSS) bucket in which the recordings are stored.	liveBucket****
DomainName	string	The main streaming domain.	example.com
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com
RecordFormatList	object
RecordFormat	array<object>	The recording formats of the original stream.
	object
SliceDuration	integer	The duration of a single segment. Unit: seconds.	30
CycleDuration	integer	The duration of a recording cycle. Unit: seconds.	3600
SliceOssObjectPrefix	string	The naming pattern for segments.	record/{liveApp**}/{liveStream**}/{UnixTimestamp}
OssObjectPrefix	string	The naming pattern for the recording file stored in OSS.	record/{liveApp**}/{liveStream**}
Format	string	The recording format.	M3U8
TranscodeRecordFormatList	object
RecordFormat	array<object>	The recording formats of transcoded streams.
	object
SliceDuration	integer	The duration of a single segment for transcoded stream recording. Unit: seconds.	30
CycleDuration	integer	The duration of a single recording cycle in seconds.	3600
SliceOssObjectPrefix	string	The naming pattern for segments of the transcoded stream.	record/{liveApp**}/{liveStream**}/{UnixTimestamp}
OssObjectPrefix	string	The maning pattern of the recording file stored in OSS for transcoded stream.	record/{liveApp**}/{liveStream**}
Format	string	The recording format.	M3U8
TranscodeTemplates	object
Templates	array	The transcoding templates.
	string	The transcoding template used. If all transcoded streams are recorded, ["*"] 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.