DescribeLivePackageConfig - 查询直播封装配置

接口说明

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

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DomainNamestring

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

example.com
AppNamestring

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

AppName
StreamNamestring

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

StreamName
PageNuminteger

当前页码。默认值:1。

1
PageSizeinteger

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

10
Orderstring

排序。取值:

  • asc(默认值):升序。

  • desc:降序。

asc

返回参数

名称类型描述示例值
object

封装配置信息。

LivePackageConfigListarray<object>

封装配置列表

LivePackageConfigobject

封装配置列表

AppNamestring

App 名。

AppName
DomainNamestring

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

example.com
IgnoreTranscodeboolean

是否忽略转码流,取值:

  • true(默认值):忽略。

  • false:不忽略。

true
PartDurationinteger

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

0
Protocolstring

直播协议与封装格式。

HLS_CMAF
SegmentDurationinteger

切片时长,单位:秒。

5
SegmentNuminteger

直播 M3U8 切片个数。

3
StreamNamestring

直播流名。

StreamName
Orderstring

排序。取值:

  • asc(默认值):升序。

  • desc:降序。

asc
PageNuminteger

当前页码。

1
PageSizeinteger

每页大小。

10
RequestIdstring

请求 ID。

1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0
TotalNuminteger

总个数。

1
TotalPageinteger

总页数。

10

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400MissingParam%s
400InvalidParams%s
400ConfigAlreadyExists%s
400InvalidProtocol%s
400InvalidSegmentNum%s
400InvalidSegmentDuration%s
400InvalidPartDuration%s
500InternalErr%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史