调用 DescribeForbiddenStreamInfoByPage 接口，分页查询禁推流信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeForbiddenStreamInfoByPage | 接口名称。当前 API 的名称为 DescribeForbiddenStreamInfoByPage。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| PageNum | Integer | 是 | 1 | 查询数据的页码，取值范围为正整数。 |
| PageSize | Integer | 是 | 10 | 每页显示的数据条数，取值范围为 [1,1000]。 |
| Vhost | String | 否 | push.example.com | 域名空间，取值与禁推直播流时设置的域名空间相同，默认为空，表示查询所有域名空间下的禁推流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的禁推流使用的域名所属的域名空间。 |
| Domain | String | 否 | push.example.com | 直播流使用的域名，取值与禁推直播流时设置的应用名称相同，默认为空，表示查询所有当前域名空间下的禁推直播流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的禁推直播流使用的域名。 |
| App | String | 否 | live | 应用名称，取值与禁推直播流时设置的应用名称相同，默认为空，表示查询当前域名空间下所有的禁推流。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 |
| Stream | String | 否 | example_stream | 流名称，取值与禁推直播流时设置的流名称相同，默认为空，表示查询所有流名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。 |
Sort | String | 否 |
| 排列方式，根据推流结束时间排序，默认值为
|
QueryType | String | 否 |
| 指定是否模糊匹配流名称。缺省情况为精准匹配，支持的取值及含义如下所示。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| StreamInfoList | Array of StreamInfoList | - | 禁推流的信息列表。 |
| RoughCount | Integer | 1 | 查询结果中禁推流数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 禁推流的域名空间。 |
| Domain | String | push.example.com | 禁推流的域名。 |
| App | String | live | 禁推流的应用名称。 |
| Stream | String | example_stream | 禁推流的流名称。 |
| CreateTime | String | 2021-10-19T08:16:14Z | 禁推流被禁推的开始时间，RFC3339 格式的 UTC 时间戳，精度为秒。 |
| EndTime | String | 2022-01-08T21:00:36Z | 禁推流结束禁推的时间，RFC3339 格式的 UTC 时间戳，精度为秒。 |
Status | Boolean |
| 当前流的禁推配置是否启用。
|
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-19T16:16:14Z", "Domain": "push.example.com", "EndTime": "2022-01-19T05:00:36Z", "Status": true, "Stream": "example_stream", "Vhost": "push.example.com" } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误，请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。