You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/安全管理/DescribeIPAccessRule - 查询 IP 访问限制
DescribeIPAccessRule - 查询 IP 访问限制
最近更新时间：2025.08.29 17:55:30首次发布时间：2024.02.04 18:02:03
复制全文
我的收藏
有用
有用
无用
无用

调用 DescribeIPAccessRule 接口，查询推流或拉流域名的 IP 访问限制配置。

注意事项

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

请求说明

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

调试

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取需要配置 IP 访问限制的域名所属的域名空间。
DomainString是push.example.com推流域名或拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取需要查询 IP 访问限制的域名。

返回参数

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

参数类型示例值描述
AccessRuleListsArray of AccessRuleLists-IP 访问限制规则列表。

AccessRuleLists

参数类型示例值描述
VhostStringpush.example.com域名空间名称。
DomainStringpush.example.com推/拉流域名。
IPAccessRuleObject of IPAccessRule-IP 访问限制规则。

IPAccessRule

参数类型示例值描述

Type

String

deny

IP 访问限制的类型。取值如下：

  • allow: 白名单。
    • 如果 Domain 为推流域名，则只有符合规则的 IP 地址才可以推流。
    • 如果 Domain 为拉流域名，则只有符合规则的 IP 地址才可以拉流。
  • deny: 黑名单。
    • 如果 Domain 为推流域名，则符合规则的 IP 地址无法推流。
    • 如果 Domain 为拉流域名，则符合规则的 IP 地址无法拉流。

Enable

Boolean

true

是否开启当前限制。取值如下：

  • true: 开启。
  • false: 关闭。

IPList

Array of String

["1.1.1.2","192.168.0.1/24"]

名单中的 IP 信息。
例如，Type 取值为 deny、Domain 为推流域名、该参数取值为 ["192.168.1.100","192.168.1.0/24","2001:db8:85a3::8a2e:370:7334","2001:db8::/32"] 时，则表示不允许以下 IP 地址推流：

  • IP 地址 192.168.1.100
  • IP 地址 2001:db8:85a3::8a2e:370:7334
  • 192.168.1.0 - 192.168.1.255范围内的所有 IP 地址
  • 2001:db8:0000:0000:0000:0000:0000:0000- 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff 范围内的所有 IP 地址

EnableTS

Boolean

true

校验是否包含 TS 文件。取值如下：

  • true: 包含。
  • false: 不包含。
    使用 HLS 协议拉流时，直播服务器会将完整的直播流切割成小的 TS（Transport Stream）文件。观众观看直播时，播放器会不断请求 TS 文件并拼接成连续的画面。参数取值为 true 时，直播服务器会严格验证请求 TS 文件的 IP 地址，防止黑名单中或不在白名单中的 IP 地址访问 TS 文件。

说明

该配置仅对拉流域名生效。

DenyHTTPStatusCodeInteger403对于黑名单中或非白名单中的 IP 地址，系统返回的 HTTP 状态码。

请求示例

POST https://live.volcengineapi.com?Action=DescribeIPAccessRule&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "Domain": "push.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeIPAccessRule",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "IPAccessRuleLists": [
            {
                "Vhost": "push.example.com",
                "Domain": "push.example.com",
                "IPAccessRule": {
                    "Type": "deny",
                    "Enable": true,
                    "EnableTS": true,
                    "IpList": [
                        "1.1.1.2",
                        "192.168.0.1/24"
                    ],
                    "DenyHTTPStatusCode": 403
                }
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.DomainAndAppdomain and app exist can not exist at the same time入参不能同时传入 Domain 和 App ，请修改入参。
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。