edit-icon download-icon

DescribeLiveStreamRecordIndexFile

Last Updated: Mar 19, 2018

Description

Query an individual recording index file.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveStreamRecordIndexFile

The name of this interface. Value: DescribeLiveStreamRecordIndexFile

AppName String Yes testApp

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

DomainName String Yes www.yourdomain.com

Your CDN domain name.

RecordId String Yes xxx

Index file ID.

StreamName String Yes testStream

Name of the live stream.

Return parameters

Parameters Type Example values Description
RequestId String 5EBF2AC3-4B73-40A5-8B32-83F49D5F035E

Request ID.

RecordIndexInfo

Recording configuration.

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

Name of the app, which the stream belongs to.

  └StreamName String xxx

Name of the live stream.

  └OssBucket String tes123

Name of the bucket in OSS.

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

Name of the endpoint stored in OSS.

  └OssObject String test123

Name of the recorded file stored in OSS.

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

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

  └EndTime String 2016-05-25T05:47:11Z

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.

Example

Request example

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

For more information, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "RecordIndexInfo":{
  3. "AppName":"xxx",
  4. "CreateTime":"2016-05-27T09:40:56Z",
  5. "DomainName":"xxx",
  6. "Duration":588.849,
  7. "EndTime":"2016-05-25T05:47:11Z",
  8. "Height":480,
  9. "OssBucket":"bucket",
  10. "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com",
  11. "OssObject":"atestObject.m3u8",
  12. "RecordId":"c4d7f0a4-b506-43f9-8de3-07732c3f3d82",
  13. "RecordUrl":"http://xxx.xxx/atestObject.m3u8",
  14. "StartTime":"2016-05-25T05:37:11Z",
  15. "StreamName":"xxx",
  16. "Width":640
  17. },
  18. "RequestId":"5EBF2AC3-4B73-40A5-8B32-83F49D5F035E"
  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.