全部产品
Search
文档中心

视频直播:查询直播封装配置

更新时间:Aug 31, 2023

调用DescribeLivePackageConfig查询直播封装配置。

使用说明

先获取主播流域名,再调用本接口查询播流域名下的直播封装配置。

QPS限制

本接口的单用户QPS限制为300次/分钟。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLivePackageConfig

系统规定参数。取值:DescribeLivePackageConfig

DomainName String example.com

直播域名(主播放域名)。

AppName String AppName

App名,置空表示匹配所有名称。

StreamName String StreamName

直播流名,置空表示匹配所有流名。

PageNum Integer 1

当前页码。默认值:1。

PageSize Integer 10

每页大小。默认值:10,取值范围:5~30。

Order String asc

排序。取值:

  • asc(默认值):升序。
  • desc:降序。

返回数据

名称

类型

示例值

描述

PageNum Integer 1

当前页码。

RequestId String 1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0

请求ID。

Order String asc

排序。取值:

  • asc(默认值):升序。
  • desc:降序。
TotalPage Integer 10

总页数。

PageSize Integer 10

每页大小。

TotalNum Integer 1

总个数。

LivePackageConfigList Array of LivePackageConfig
LivePackageConfig
AppName String AppName

App名。

SegmentNum Integer 3

直播M3U8切片个数。

StreamName String StreamName

直播流名。

Protocol String HLS_CMAF

直播协议与封装格式。

IgnoreTranscode Boolean true

是否忽略转码流,取值:

  • true(默认值):忽略。
  • false:不忽略。
PartDuration Integer 0

Part切片时长,单位:毫秒。

SegmentDuration Integer 5

切片时长,单位:秒。

DomainName String example.com

直播域名(主播放域名)。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLivePackageConfig
&DomainName=example.com
&AppName=AppName
&StreamName=StreamName
&PageNum=1
&PageSize=10
&Order=asc
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLivePackageConfigResponse>
    <PageNum>1</PageNum>
    <RequestId>1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0</RequestId>
    <Order>asc</Order>
    <TotalPage>10</TotalPage>
    <PageSize>10</PageSize>
    <TotalNum>1</TotalNum>
    <LivePackageConfigList>
        <AppName>AppName</AppName>
        <SegmentNum>3</SegmentNum>
        <StreamName>StreamName</StreamName>
        <Protocol>HLS_CMAF</Protocol>
        <IgnoreTranscode>true</IgnoreTranscode>
        <PartDuration>0</PartDuration>
        <SegmentDuration>5</SegmentDuration>
        <DomainName>example.com</DomainName>
    </LivePackageConfigList>
</DescribeLivePackageConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNum" : 1,
  "RequestId" : "1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0",
  "Order" : "asc",
  "TotalPage" : 10,
  "PageSize" : 10,
  "TotalNum" : 1,
  "LivePackageConfigList" : [ {
    "AppName" : "AppName",
    "SegmentNum" : 3,
    "StreamName" : "StreamName",
    "Protocol" : "HLS_CMAF",
    "IgnoreTranscode" : true,
    "PartDuration" : 0,
    "SegmentDuration" : 5,
    "DomainName" : "example.com"
  } ]
}

错误码

访问错误中心查看更多错误码。