Queries the recording configurations of all applications under a domain name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveRecordConfig

The operation that you want to perform. Set the value to DescribeLiveRecordConfig.

DomainName String Yes www.yourdomain.com

The main streaming domain.

AppName String No testApp

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

StreamName String No myStreamName

The name of the live stream.

PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 5

The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.

Order String No asc

The rule used to sort entries. Valid values:

  • asc: The entries are sorted in ascending order. This is the default value.
  • desc: The entries are sorted in descending order.

Response parameters

Parameter Type Example Description
RequestId String 5056369B-D337-499E-B8B7-B761BD37B08A

The ID of the request.

LiveAppRecordList Array of LiveAppRecord

The recording configurations of applications.

LiveAppRecord
DomainName String www.yourdomain.com

The main streaming domain.

AppName String testApp

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

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of Object Storage Service (OSS).

OssBucket String test123

The name of the OSS bucket in which recordings are stored.

CreateTime String 2016-05-20T09:33:38Z

The time when the configuration was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RecordFormatList Array of RecordFormat

The formats of recordings.

RecordFormat
Format String M3U8

The format of the recording.

OssObjectPrefix String record/{AppName}/{StreamName}

The name of the recording.

SliceOssObjectPrefix String record/{AppName}/{StreamName}/{UnixTimestamp}

The name of the media segment file.

CycleDuration Integer 3600

The duration of the periodically recorded video. Unit: seconds.

EndTime String 2018-11-08T03:49:18Z

The time when the system started the recording operation. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

OnDemond Integer 0

Indicates whether on-demand recording is enabled. Valid values:

  • 0: On-demand recording is disabled.
  • 1: The live stream was recorded by using HTTP callbacks.
  • 2: The live stream was recorded by setting the ingest parameters.

StartTime String 2018-11-08T02:49:18Z

The time when the system stopped the recording operation. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

StreamName String myStreamName

The name of the live stream.

PageNum Integer 5

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

Order String desc

The rule used to sort entries.

TotalPage Integer 20

The total number of returned pages.

TotalNum Integer 12

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

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=DescribeLiveRecordConfig
&DomainName=www.yourdomain.com
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveRecordConfigResponse>
      <LiveAppRecordList>
            <LiveAppRecord>
                  <AppName>aliyuntest</AppName>
                  <CreateTime>2016-05-20T09:33:38Z</CreateTime>
                  <DomainName>www.yourdomain.com</DomainName>
                  <FormatList>
                        <Format>
                              <Name>m3u8</Name>
                              <OssObjectPrefix>record/{AppName}/{StreamName}</OssObjectPrefix>
                              <SliceOssObjectPrefix>record/{AppName}/{StreamName}/{UnixTimestamp}</SliceOssObjectPrefix>
                        </Format>
                  </FormatList>
                  <OssBucket>chimang.bucket</OssBucket>
                  <OssEndpoint>oss-cn-hangzhou.aliyuncs.com</OssEndpoint>
            </LiveAppRecord>
      </LiveAppRecordList>
      <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
</DescribeLiveRecordConfigResponse>

JSON format

{
    "LiveAppRecordList":{
        "LiveAppRecord":[{
            "AppName":"aliyuntest",
            "CreateTime":"2016-05-20T09:33:38Z",
            "DomainName":"www.yourdomain.com",
            "FormatList":{
                "Format":[{
                    "Name":"m3u8",
                    "OssObjectPrefix":"record/{AppName}/{StreamName}",
                    "SliceOssObjectPrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}"
                }]
            },
            "OssBucket":"chimang.bucket",
            "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com"
        }]
    },
    "RequestId":"5056369B-D337-499E-B8B7-B761BD37B08A"
}

Error codes

For a list of error codes, visit the API Error Center.