Creates an M3U8 index file for a recording in the specified time range.

Note
  • You can create an index file only after a live stream is ingested. If no live video is streamed in the specified time range or the specified live stream name is invalid, the index file fails to be created.
  • TS segment information is stored in ApsaraVideo Live only for three months. You can create M3U8 index files only for the recordings of the previous three months.

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 CreateLiveStreamRecordIndexFiles

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

AppName String Yes AppName

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

DomainName String Yes live.yourdomain.com

The streaming domain.

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

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

OssBucket String Yes test123

The name of the Object Storage Service (OSS) bucket in which the index file is stored.

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

The endpoint of OSS.

OssObject String Yes {AppName}/{StreamName}/{Date}/{Hour}/{Minute}_{Second}.m3u8

The name of the index file that is stored in OSS.

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

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

StreamName String Yes testStream

The name of the live stream.

Response parameters

Parameter Type Example Description
RecordInfo Struct

The recording configuration.

RecordUrl String http://*****/atestObject.m3u8

The URL of the index file.

DomainName String test.com

The streaming domain.

AppName String AppName

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

StreamName String TestStream

The name of the live stream.

StartTime String 2015-12-01T07:36:00Z

The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

EndTime String 2015-12-01T07:40:00Z

The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Duration Float 20

The recording length. Unit: seconds.

Height Integer 480

The height of the video.

Width Integer 640

The width of the video.

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

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

OssBucket String bucket

The name of the OSS bucket in which the index file is stored.

OssEndpoint String oss-cn-hangzhou.aliyuncs.com

The endpoint of OSS.

OssObject String atestObject.m3u8

The name of the index file that is stored in OSS.

RecordId String c4d7f0a4-b506-43f9-8de3-07732c3f****

The ID of the index file.

RequestId String 550439A3-F8EC-4CA2-BB62-B9DB43EEEF30

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=CreateLiveStreamRecordIndexFiles
&AppName=AppName
&DomainName=live.yourdomain.com
&EndTime=2017-12-22T08:00:00Z
&OssBucket=test123
&OssEndpoint= oss-cn-shanghai.aliyuncs.com
&OssObject={AppName}/{StreamName}/{Date}/{Hour}/{Minute}_{Second}.m3u8
&StartTime=2017-12-21T08:00:00Z
&StreamName=testStream
&<common request parameters>

Sample success responses

XML format

<CreateLiveStreamRecordIndexFilesResponse>
	  <RecordInfo>
		    <AppName>AppName</AppName>
		    <CreateTime>2016-05-27T09:40:56Z</CreateTime>
		    <DomainName>www.yourdomain.com</DomainName>
		    <Duration>588.849</Duration>
		    <EndTime>2016-05-25T05:47:11Z</EndTime>
		    <Height>480</Height>
		    <OssBucket>bucket</OssBucket>
		    <OssEndpoint>oss-cn-hangzhou.aliyuncs.com</OssEndpoint>
		    <OssObject>atestObject.m3u8</OssObject>
		    <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f3d82</RecordId>
		    <RecordUrl>http://****/atestObject.m3u8</RecordUrl>
		    <StartTime>2016-05-25T05:37:11Z</StartTime>
		    <StreamName>testStream</StreamName>
		    <Width>640</Width>
	  </RecordInfo>
	  <RequestId>550439A3-F8EC-4CA2-BB62-B9DB43EEEF30</RequestId>
</CreateLiveStreamRecordIndexFilesResponse>

JSON format

{
    "RecordInfo":{
        "AppName":"AppName",
        "CreateTime":"2016-05-27T09:40:56Z",
        "DomainName":"www.yourdomain.com",
        "Duration":588.849,
        "EndTime":"2016-05-25T05:47:11Z",
        "Height":480,
        "OssBucket":"bucket",
        "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com",
        "OssObject":"atestObject.m3u8",
        "RecordId":"c4d7f0a4-b506-43f9-8de3-07732c3f3d82",
        "RecordUrl":"http://****/atestObject.m3u8",
        "StartTime":"2016-05-25T05:37:11Z",
        "StreamName":"testStream",
        "Width":640
    },
    "RequestId":"550439A3-F8EC-4CA2-BB62-B9DB43EEEF30"
}

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is correct.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is correct.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time is earlier than the start time. Check whether the values of the StartTime and EndTime parameters are correct.
400 InvalidOssBucket.Malformed Specified OssBucket is malformed. The error message returned because the format of the OSS bucket name is invalid. Check whether the value of the OssBucket parameter is correct.
400 InvalidOssObject.Malformed Specified OssObject is malformed. The error message returned because the format of the OSS object name is invalid. Check whether the value of the OSSObject parameter is correct.
400 InvalidStream.NotFound Speicified stream does not exist. The error message returned because the live stream does not exist. Check whether the value of the StreamName parameter is correct.
400 InvalidConfig.Changed The oss bucket info between StartTime and EndTime has changed. The error message returned because the bucket information changed in the time range specified by the StartTime and EndTime parameters.
400 NoRecordContent The record content between StartTime and EndTime is empty. The error message returned because the StartTime or EndTime parameter is not specified.

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