edit-icon download-icon

DescribeLiveRecordConfig

Last Updated: Apr 11, 2018

Description

Query the recording configuration of all the apps under the domain name.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveRecordConfig

The name of this interface. Value: DescribeLiveRecordConfig

DomainName String Yes www.yourdomain.com

Your CDN domain name.

AppName String No testApp

Name of the app, which the live stream belongs to.

Order String No asc

Sort.

  • Asc:ascending.
  • Desc:descending.
Default value: Asc

PageNum Integer No 1

The page number.
Default value: 1

PageSize Integer No 5

The page size.
Range: 5 ~ 30.
Default value: 10

Return parameters

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

The ID of the job request.

LiveAppRecordList

Recording configuration.

  └DomainName String test.com

The CDN domain name, which the stream belongs to.

  └AppName String test123

Name of the app, which the stream belongs to.

  └OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSS endpoint.

  └OssBucket String test123

Name of the bucket in OSS.

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

Creation time.

  └RecordFormatList

Recording format list.

    └Format String xxx

Name of the format.

    └OssObjectPrefix String xxx

Name of the file stored in OSS.

    └SliceOssObjectPrefix String xxx

Name of the slice file stored in OSS.

    └CycleDuration Integer 3600

Cycle recording time. Unit: seconds.

PageNum Integer 5

The page number.

PageSize Integer 10

The page size.

Order String desc

Sort.

TotalPage Integer 20

The total number of pages.

TotalNum Integer 12

The total number of eligible items.

Example

Request example

  1. https://live.aliyuncs.com/?Action=DescribeLiveRecordConfig&DomainName=xxxxx<Public Request Parameter>

For more inormation, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "LiveAppRecordList":{
  3. "LiveAppRecord":[{
  4. "AppName":"aliyuntest",
  5. "CreateTime":"2016-05-20T09:33:38Z",
  6. "DomainName":"xxxxx",
  7. "FormatList":{
  8. "Format":[{
  9. "Name":"m3u8",
  10. "OssObjectPrefix":"xxx",
  11. "SliceOssObjectPrefix":"xxx"
  12. }]
  13. },
  14. "OssBucket":"chimang.bucket",
  15. "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com"
  16. }]
  17. },
  18. "RequestId":"5056369B-D337-499E-B8B7-B761BD37B08A"
  19. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.