You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/安全管理/创建或更新 IP 访问限制
创建或更新 IP 访问限制
最近更新时间：2024.05.14 17:06:33首次发布时间：2024.02.04 18:02:03
我的收藏

调用 UpdateIPAccessRule 接口，创建或更新域名的 IP 访问限制。

使用说明

  • 域名的 IP 访问限制以黑白名单的形式设置，为域名创建 IP 访问限制以实现对访客身份的识别和过滤。
  • 如果设置 IP 黑名单，黑名单外的 IP 会被允许访问；
  • 如果设置 IP 白名单，白名单内的 IP 会被允许访问。

注意事项

  • 使用限制：
    • IP 黑白名单支持配置 IPv4 地址。
    • IP 黑白名单均支持 IP 网段配置。
  • 请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

调试

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

请求参数

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

Query

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

Body

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

IPAccessRule

参数类型是否必选示例值描述

Type

String

是

deny

IP 访问限制的类型，取值及含义如下所示。

  • allow: 白名单；
  • deny: 黑名单。

Enable

Boolean

是

true

是否开启当前限制，取值及含义如下所示。

  • true: 开启；
  • false: 关闭。
IPListArray of String是["1.1.1.2","192.168.0.1/24"]名单中的 IP 信息。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=UpdateIPAccessRule&Version=2023-01-01

{
    "Vhost": "push.example.com",
    "Domain": "push.example.com",
    "IPAccessRule": [
        { 
            "Type": "deny", 
            "Enable": true,
            "IPList": ["192.168.1.1", "192.168.1.2"]
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202011121850010102250920591B011F85",
        "Action": "UpdateIPAccessRule",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.Empty%s is required参数缺失，请检查错误消息中指定的参数是否传入。
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.DomainNotExistdomain not found未找到域名（Domain）。请检查传入的域名是否与实际使用的域名一致。
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。