edit-icon download-icon

DescribeLiveStreamRecordIndexFiles

Last Updated: Mar 19, 2018

Description

Query the record index file.

Request parameters

Parameters Type Required Example value Description
Action String Yes DescribeLiveStreamRecordIndexFiles

The name of this interface. Value: DescribeLiveStreamRecordIndexFiles

AppName String Yes testApp

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

DomainName String Yes www.yourdomain.com

Your CDN domain name.

EndTime String Yes 2017-12-22T08:00:00:00Z

End time.

  • Format: 2015-12-01T17:36:00Z.
  • The interval between the EndTime and StartTime does not exceed 4 days.

StartTime String Yes 2017-12-21T08:00:00:00Z

Start time.
Format: 2015-12-01T17:36:00Z.

StreamName String Yes testStream

Name of the live stream.

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 10

The page size.
Range: [5,30]
Default value: 10.

Return parameters

Parameters Type Example values Description
RecordIndexInfoList

Recording configuration list.

  └RecordUrl String http://xxx.xxx/atestObject.m3u8

Index file address.

  └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.

  └StreamName String test123

Name of the live stream.

  └StartTime String 2015-12-01T17:36:00Z

Start time.
Format: 2015-12-01T17:36:00Z

  └EndTime String 2015-12-01T17:36:00Z

End time.
Format: 2015-12-01T17:36:00Z.

  └Duration Float 588.849

Recording duration.

  └Height Integer 480

Video height.

  └Width Integer 640

Video width.

  └CreateTime String 2016-05-27T09:40:56Z

Creation time.

  └RecordId String c4d7f0a4-b506-43f9-8de3-07732c3f3d82

Index file ID.

  └OssBucket String test123

Name of the bucket in OSS.

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

OSS endpoint.

  └OssObject String test123

OSSObject.

PageNum Integer 10

The page number.

PageSize Integer 5

The page size.

Order String asc

Sort.

TotalPage Integer 20

The total number of pages.

TotalNum Integer 12

The total number of eligible items.

RequestId String DE24625C-7C0F-4020-8448-9C31A50C1556

The request ID.

Example

Request example

  1. https://live.aliyuncs.com/?Action=DescribeLiveStreamRecordIndexFiles&DomainName=live.aliyunlive.com&AppName=aliyuntest&StreamName=xxx&StartTime=xxx&EndTime=xxx&<Public Request Parameter>

For more information, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "RecordIndexInfoList":{
  3. "RecordIndexInfo":[{
  4. "AppName":"xxx",
  5. "CreateTime":"2016-05-27T09:40:56Z",
  6. "DomainName":"xxx",
  7. "Duration":588.849,
  8. "EndTime":"2016-05-25T05:47:11Z",
  9. "Height":480,
  10. "OssBucket":"bucket",
  11. "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com",
  12. "OssObject":"atestObject.m3u8",
  13. "RecordId":"c4d7f0a4-b506-43f9-8de3-07732c3f3d82",
  14. "RecordUrl":"http://xxx.xxx/atestObject.m3u8",
  15. "StartTime":"2016-05-25T05:37:11Z",
  16. "StreamName":"xxx",
  17. "Width":640
  18. }]
  19. },
  20. "RequestId":"DE24625C-7C0F-4020-8448-9C31A50C1556"
  21. }

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.