You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/直播垫片/DescribeLivePadStreamList - 查询正在播放垫片的直播流
DescribeLivePadStreamList - 查询正在播放垫片的直播流
最近更新时间：2025.05.28 15:48:43首次发布时间：2025.05.28 15:48:43
我的收藏
有用
有用
无用
无用

调用 DescribeLivePadStreamList 接口查询当前正在播放垫片的直播流列表，适用于监控直播流状态、排查异常情况等场景，帮助您快速定位和处理垫片播放问题。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribeLivePadStreamList&Version=2023-01-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是DescribeLivePadStreamList接口名称。当前 API 的名称为 DescribeLivePadStreamList。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要录制的直播流使用的域名所属的域名空间。
AppString否live待查询的直播流所属的应用名称。
PageNumLong是1查询数据的页码，默认为 1，表示查询第一页的数据，取值范围为 [1,10000]。
PageSizeLong是100每页显示的数据条数，默认为 100，表示每页最多展示 100 条数据，取值范围为 [1,1000]。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述

StreamList

Array of StreamList

-

流列表，包含每个流的详细信息。每个流对象包含以下属性：

  • Vhost：虚拟主机名称；
  • App：应用程序的名称；
  • Stream：流名称。

StreamList

参数类型示例值描述
VhostStringpush.example.com域名空间。
AppStringlive应用名称，用于标识特定的应用。
StreamStringstream1流名称，用于标识特定的直播流。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePadStreamList&Version=2023-01-01
{
    "Vhost": "vhost",
    "App": "app",
    "PageNum": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeLivePadStreamList",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "StreamList": [
            {
                "Vhost": "vhost",
                "App": "app",
                "Stream": "stream"
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.Empty%s is required参数缺失，请检查错误消息中指定的参数是否传入。
400InvalidParam.Format%s format error参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
400InvalidParam.Length%s should not be longer than %d参数长度错误，请检查错误消息中指定参数的长度是否超过限制。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.TimeLogicstartTime later than endTime, etc.传入的时间参数不符合时间逻辑，请检查是否存在以下问题。开始时间晚于结束时间或过期时间早于当前时间。
400InvalidParam.DomainAndAppdomain and app exist can not exist at the same time入参不能同时传入 Domain 和 App ，请修改入参。
400InvalidParam.VhostOrDomainEmptyPlease enter vhost or domain入参需传入 Vhost 或 Domain 中的任意一个，请修改入参。
400InvalidParam.StillUsing%s is still in use, can't delete服务正在使用错误消息中指定的资源导致，无法删除，请释放资源后重试。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
404ResourceNotFound.VhostNotExistvhost not found未找到域名空间（Vhost）。请检查传入的域名空间是否与实际使用的域名空间一致。
404ResourceNotFound.DomainNotExistdomain not found未找到域名（Domain）。请检查传入的域名是否与实际使用的域名一致。
404ResourceNotFound.AppNotExistapp not found未找到应用（App）。请检查传入的应用名称是否与实际使用的应用名称一致。
404ResourceNotFound.PresetNotExistpreset not found未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。
429RequestLimitExceeded-请求创建的资源（域名空间、域名、应用、配置模版、证书）超出限制。
429RequestLimitExceeded.Exist%s already exist请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
500InternalError.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。
500InternalError.ServicesOrBillingan internal error related to service or billing occurred, please contact the administrator.出现与服务或账单相关的内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
500InternalError.Streaman internal error related to stream occurred, please contact the administrator.出现与流相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。