UpdateIPAccessRule - 创建或更新 IP 访问限制--视频直播-火山引擎

文档中心

立即注册

导航

UpdateIPAccessRule - 创建或更新 IP 访问限制

最近更新时间：2025.08.29 17:55:30首次发布时间：2024.02.04 18:02:03

调用 UpdateIPAccessRule 接口，创建或更新推流或拉流域名的 IP 访问限制，从而有效管理客户端访问，防止未授权请求，提高直播安全性。

使用说明

IP 黑白名单适用于推流和拉流域名。单次接口调用仅允许配置 IP 黑名单或白名单。
- 配置推流域名的 IP 黑白名单：用于控制哪些 IP 地址可以推流，从而防止未经授权的用户或设备进行推流，保护直播内容的来源。
- 配置拉流域名的 IP 黑白名单：用于控制哪些 IP 地址可以拉流，确保只有特定 IP 地址的观众可以观看直播。
调用该接口后，IP 黑白名单配置将被全量替换为最近一次请求中的配置，请谨慎操作。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取需要配置 IP 访问限制的域名所属的域名空间。
Domain	String	是	`push.example.com`	推流域名或拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取需要配置 IP 访问限制的域名。
IPAccessRule	Object 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 信息。支持 IPv4 和 IPv6 格式的 IP 地址和 IP 网段。最多支持配置 500 个 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	否	`false`	校验是否包含 TS 文件。默认值为 `false`。取值如下： `true`: 包含。 `false`: 不包含。使用 HLS 协议拉流时，直播服务器会将完整的直播流切割成小的 TS（Transport Stream）文件。观众观看直播时，播放器会不断请求 TS 文件并拼接成连续的画面。参数取值为 `true` 时，直播服务器会严格验证请求 TS 文件的 IP 地址，防止黑名单中或不在白名单中的 IP 地址访问 TS 文件。说明该配置仅对拉流域名生效。如果无法确保能获取所有客户端请求 TS 文件的出口 IP 地址，建议将参数取值设置为 `false`，以免误拦截观众。
DenyHTTPStatusCode	Integer	否	`403`	对于黑名单中或非白名单中的 IP 地址，系统默认返回 403 错误，表示禁止访问。通过该参数，您可以自定义返回状态码，以便在查看日志时能快速区分禁止访问的原因，方便定位问题。参数取值范围为 [200,999]。

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=UpdateIPAccessRule&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "Domain": "push.example.com",
    "IPAccessRule": {
        "Type": "deny",
        "Enable": true,
        "EnableTS": false,
        "IPList": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "DenyHTTPStatusCode": 403
    }
}

返回示例

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

错误码

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

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

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