You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询禁推流列表

最近更新时间：2024.03.21 13:55:36

首次发布时间：2023.09.25 14:34:03

我的收藏

调用 DescribeForbiddenStreamInfoByPage 接口，分页查询禁推流信息。

注意事项

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

请求说明

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

调试

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeForbiddenStreamInfoByPage接口名称。当前 API 的名称为 DescribeForbiddenStreamInfoByPage。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。
PageNumInteger是1查询数据的页码，取值范围为正整数。
PageSizeInteger是10每页显示的数据条数，取值范围为 [1,1000]。
VhostString否push.example.com域名空间，取值与禁推直播流时设置的域名空间相同，默认为空，表示查询所有域名空间（Vhost）下的禁推流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的禁推流使用的域名所属的域名空间。
DomainString否push.example.com直播流使用的域名，取值与禁推直播流时设置的应用名称相同，默认为空，表示查询所有当前域名空间（Vhost）下的禁推直播流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的禁推直播流使用的域名。
AppString否live应用名称，取值与禁推直播流时设置的应用名称相同，默认为空，表示查询当前域名空间（Vhost）下所有的禁推流。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
StreamString否example_stream流名称，取值与禁推直播流时设置的流名称相同，默认查询所有流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定 Stream，必须同时指定 App 的值。

Sort

String

否

desc

排列方式，根据推流结束时间排序，默认值为 desc，支持的取值及含义如下所示。

  • asc：从时间最远到最近排序；
  • desc：从时间最近到最远排序。

QueryType

String

否

fuzzy

指定是否模糊匹配流名称。缺省情况为精准匹配，支持的取值及含义如下所示。

  • fuzzy：模糊匹配；
  • strict：精准匹配。

返回参数

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

参数类型示例值描述
StreamInfoListArray of StreamInfoList-禁推流的信息列表。
RoughCountInteger1查询结果中禁推流数量。

StreamInfoList

参数类型示例值描述
VhostStringpush.example.com禁推流的域名空间。
DomainStringpush.example.com禁推流的域名。
AppStringlive禁推流的应用名称。
StreamStringexample_stream禁推流的流名称。
CreateTimeString2021-10-19 16:16:14禁推流被禁推的开始时间。
EndTimeString2022-01-19 05:00:36禁推流结束禁推的时间。

Status

Boolean

true

当前流的禁推配置是否启用。

  • true：启用；
  • false：禁用。

请求示例

GET https://live.volcengineapi.com?Action=DescribeForbiddenStreamInfoByPage&Version=2023-01-01&PageNum=1&PageSize=10&Vhost=push.example.com&App=live&Stream=example_stream&Sort=desc&QueryType=fuzzy

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021102918431901022508421700164AA1",
    "Action": "DescribeForbiddenStreamInfoByPage",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "RoughCount": 1,
    "StreamInfoList": [
      {
        "App": "live",
        "CreateTime": "2021-10-19 16:16:14",
        "Domain": "push.example.com",
        "EndTime": "2022-01-19 05:00:36",
        "Status": true,
        "Stream": "example_stream",
        "Vhost": "push.example.com"
      }
    ]
  }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
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-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。