Queries the configuration of an index file.

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 DescribeLiveStreamRecordIndexFile

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

AppName String Yes testApp

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

DomainName String Yes www.yourdomain.com

The streaming domain.

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

The ID of the index file.

StreamName String Yes testStream

The name of the live stream.

Response parameters

Parameter Type Example Description
RecordIndexInfo Struct

The configuration of the index file.

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

The URL of the index file.

DomainName String www.yourdomain.com

The streaming domain.

AppName String testApp

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

StreamName String testStream

The name of the live stream.

OssBucket String tes123

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

OssEndpoint String oss-cn-hangzhou.aliyuncs.com

The endpoint of OSS.

OssObject String test123

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

StartTime String 2015-12-01T05: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 2016-05-25T05:47:11Z

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 588.849

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.

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

The ID of the index file.

RequestId String 5EBF2AC3-4B73-40A5-8B32-83F49D5F035E

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=DescribeLiveStreamRecordIndexFile
&AppName=testApp
&DomainName=www.yourdomain.com
&RecordId=c4d7f0a4-b506-43f9-8de3-07732c3f****
&StreamName=testStream
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamRecordIndexFileResponse>
	  <RecordIndexInfo>
		    <AppName>testApp</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-07732c3f****</RecordId>
		    <RecordUrl>http://****/atestObject.m3u8</RecordUrl>
		    <StartTime>2016-05-25T05:37:11Z</StartTime>
		    <StreamName>testStream</StreamName>
		    <Width>640</Width>
	  </RecordIndexInfo>
	  <RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>
</DescribeLiveStreamRecordIndexFileResponse>

JSON format

{
    "RecordIndexInfo":{
        "AppName":"testApp",
        "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-07732c3f****",
        "RecordUrl":"http://****/atestObject.m3u8",
        "StartTime":"2016-05-25T05:37:11Z",
        "StreamName":"testStream",
        "Width":640
    },
    "RequestId":"5EBF2AC3-4B73-40A5-8B32-83F49D5F035E"
}

Error codes

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