All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveRecordConfig

Last Updated:Nov 14, 2024

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

Operation description

Usage notes

Before you call this operation, make sure that you obtained the name of the main streaming domain.

QPS limits

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. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveRecordConfigget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The name of the main streaming domain.

example.com
AppNamestringNo

The name of the application to which the live stream belongs.

liveApp****
StreamNamestringNo

The name of the live stream.

liveStream****
PageNumintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 5 to 30. Default value: 10.

5
OrderstringNo

The order in which the entries are sorted based on creation time. Valid values:

  • asc (default): ascending order
  • desc: descending order
asc

Response parameters

ParameterTypeDescriptionExample
object
PageNuminteger

The page number.

5
RequestIdstring

The request ID.

5056369B-D337-499E-B8B7-B761BD37B08A
Orderstring

The sorting order of recording configurations by creation time.

desc
TotalPageinteger

The total number of pages.

20
PageSizeinteger

The number of entries per page.

10
TotalNuminteger

The total number of recording configurations that meet the specified conditions.

12
LiveAppRecordListarray<object>

The list of recording configurations.

LiveAppRecordobject

The recording configuration.

EndTimestring

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
StartTimestring

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
AppNamestring

The name of the application to which the live stream belongs.

liveApp****
StreamNamestring

The name of the live stream.

liveStream****
DelayTimeinteger

The maximum interruption duration of the live stream. If the actual interruption duration exceeds the threshold, a new recording is generated. Valid values: 15 to 21600. Unit: seconds.

180
CreateTimestring

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
OnDemondinteger

The configuration of on-demand recording. Valid values:

  • 0: disables on-demand recording.
  • 1: enables on-demand recording that is triggered by HTTP callbacks.
  • 2: enables on-demand recording that is triggered by stream ingest parameters.
  • 7: enables on-demand recording by calling the RealTimeRecordCommand operation 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
OssBucketstring

The name of the Object Storage Service (OSS) bucket in which the recordings are stored.

liveBucket****
DomainNamestring

The name of the main streaming domain.

example.com
OssEndpointstring

The endpoint of the OSS bucket.

cn-oss-****.aliyuncs.com
RecordFormatListarray<object>

The recording formats of original streams.

RecordFormatobject
SliceDurationinteger

The duration of a segment file. Unit: seconds.

30
CycleDurationinteger

The duration of a recording file. Unit: seconds.

3600
SliceOssObjectPrefixstring

The naming format of a segment file.

record/{liveApp****}/{liveStream****}/{UnixTimestamp}
OssObjectPrefixstring

The naming format of a recording file.

record/{liveApp****}/{liveStream****}
Formatstring

The format of recording files.

M3U8
TranscodeRecordFormatListarray<object>

The recording formats of transcoded streams.

RecordFormatobject
SliceDurationinteger

The duration of a segment file. Unit: seconds.

30
CycleDurationinteger

The duration of a recording file. Unit: seconds.

3600
SliceOssObjectPrefixstring

The naming format of a segment file.

record/{liveApp****}/{liveStream****}/{UnixTimestamp}
OssObjectPrefixstring

The naming format of a recording file.

record/{liveApp****}/{liveStream****}
Formatstring

The format of recording files.

M3U8
TranscodeTemplatesarray

The transcoding templates.

Templatesstring

The transcoding template used by the recorded stream. If all transcoded streams are recorded, ["*"] is returned.

["sd","hd"]

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.