查询直播域名下所有APP录制配置。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveRecordConfig | 系统规定参数。取值:DescribeLiveRecordConfig。 |
DomainName | String | 是 | example.com | 主播流域名。 |
AppName | String | 否 | liveApp**** | 播流所属应用名称。 |
StreamName | String | 否 | liveStream**** | 播流名称。 |
PageNum | Integer | 否 | 1 | 当前页码。默认值:1。 |
PageSize | Integer | 否 | 5 | 每页大小。默认值:10,取值范围:5~30。 |
Order | String | 否 | asc | 按创建时间排序。取值:
|
返回数据
名称 |
类型 |
示例值 |
描述 |
PageNum | Integer | 5 | 分页的页码。 |
RequestId | String | 5056369B-D337-499E-B8B7-B761BD37B08A | 请求ID。 |
Order | String | desc | 排序。 |
TotalPage | Integer | 20 | 总页数。 |
PageSize | Integer | 10 | 每页大小。 |
TotalNum | Integer | 12 | 符合条件的总个数。 |
LiveAppRecordList | Array of LiveAppRecord | 录制配置列表。 |
|
LiveAppRecord | |||
EndTime | String | 2018-11-08T03:49:18Z | 计划录制结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
StartTime | String | 2018-11-08T02:49:18Z | 计划录制开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
AppName | String | liveApp**** | 播流所属应用名称。 |
StreamName | String | liveStream**** | 直播流名称。 |
DelayTime | Integer | 180 | 断流拼接时长。 直播断流时长超过设定的拼接时长后,将会生成新文件,断流拼接时长支持15~21600秒。 |
CreateTime | String | 2016-05-20T09:33:38Z | 创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
OnDemond | Integer | 0 | 按需录制。取值:
说明 当OnDemand取值为1时,需要先通过AddLiveRecordNotifyConfig接口配置OnDemandUrl,否则默认不录制。 |
OssBucket | String | liveBucket**** | OSS存储Bucket名称。 |
DomainName | String | example.com | 主播流域名。 |
OssEndpoint | String | cn-oss-****.aliyuncs.com | OSS存储的Endpoint名称。 |
RecordFormatList | Array of RecordFormat | 格式列表。 |
|
RecordFormat | |||
SliceDuration | Integer | 30 | 转码流录制单个切片时长。单位:秒。 |
CycleDuration | Integer | 3600 | 周期录制时间。单位:秒。 |
SliceOssObjectPrefix | String | record/{liveApp****}/{liveStream****}/{UnixTimestamp} | 切片名称。 |
OssObjectPrefix | String | record/{liveApp****}/{liveStream****} | 录制文件名称。 |
Format | String | M3U8 | 格式。 |
TranscodeRecordFormatList | Array of RecordFormat | 转码流录制格式列表。 |
|
RecordFormat | |||
SliceDuration | Integer | 30 | 转码流录制单个切片时长。单位:秒。 |
CycleDuration | Integer | 3600 | 周期录制时间。单位:秒。 |
SliceOssObjectPrefix | String | record/{liveApp****}/{liveStream****}/{UnixTimestamp} | 转码流录制切片名称。 |
OssObjectPrefix | String | record/{liveApp****}/{liveStream****} | 转码流录制文件名称。 |
Format | String | M3U8 | 转码流录制格式。 |
TranscodeTemplates | Array of String | ["sd","hd"] | 转码流录制的转码模板。设置了录制所有转码流,则返回为["*"]。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveRecordConfig
&DomainName=example.com
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveRecordConfigResponse>
<Order>desc</Order>
<TotalNum>12</TotalNum>
<TotalPage>20</TotalPage>
<PageSize>10</PageSize>
<PageNum>5</PageNum>
<RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
<LiveAppRecordList>
<LiveAppRecord>
<StreamName>liveStream****</StreamName>
<EndTime>2018-11-08T03:49:18Z</EndTime>
<OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
<DomainName>example.com</DomainName>
<CreateTime>2016-05-20T09:33:38Z</CreateTime>
<StartTime>2018-11-08T02:49:18Z</StartTime>
<OssBucket>liveBucket****</OssBucket>
<OnDemond>0</OnDemond>
<AppName>liveApp****</AppName>
<RecordFormatList>
<RecordFormat>
<Format>M3U8</Format>
<SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>
<CycleDuration>3600</CycleDuration>
<SliceDuration>30</SliceDuration>
<OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>
</RecordFormat>
</RecordFormatList>
<TranscodeRecordFormatList>
<RecordFormat>
<Format>M3U8</Format>
<SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>
<CycleDuration>3600</CycleDuration>
<SliceDuration>30</SliceDuration>
<OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>
</RecordFormat>
</TranscodeRecordFormatList>
<TranscodeTemplates>
<Templates>["sd","hd"]</Templates>
</TranscodeTemplates>
</LiveAppRecord>
</LiveAppRecordList>
</DescribeLiveRecordConfigResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DescribeLiveRecordConfigResponse" : {
"Order" : "desc",
"TotalNum" : 12,
"TotalPage" : 20,
"PageSize" : 10,
"PageNum" : 5,
"RequestId" : "5056369B-D337-499E-B8B7-B761BD37B08A",
"LiveAppRecordList" : {
"LiveAppRecord" : {
"StreamName" : "liveStream****",
"EndTime" : "2018-11-08T03:49:18Z",
"OssEndpoint" : "cn-oss-****.aliyuncs.com",
"DomainName" : "example.com",
"CreateTime" : "2016-05-20T09:33:38Z",
"StartTime" : "2018-11-08T02:49:18Z",
"OssBucket" : "liveBucket****",
"OnDemond" : 0,
"AppName" : "liveApp****",
"RecordFormatList" : {
"RecordFormat" : {
"Format" : "M3U8",
"SliceOssObjectPrefix" : "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
"CycleDuration" : 3600,
"SliceDuration" : 30,
"OssObjectPrefix" : "record/{liveApp****}/{liveStream****}"
}
},
"TranscodeRecordFormatList" : {
"RecordFormat" : {
"Format" : "M3U8",
"SliceOssObjectPrefix" : "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
"CycleDuration" : 3600,
"SliceDuration" : 30,
"OssObjectPrefix" : "record/{liveApp****}/{liveStream****}"
}
},
"TranscodeTemplates" : {
"Templates" : "[\"sd\",\"hd\"]"
}
}
}
}
}
错误码
访问错误中心查看更多错误码。