You need to enable JavaScript to run this app.
文档中心
视频直播

视频直播

请输入
  • 文档首页
    • 视频直播API 参考安全管理UpdateReferer - 添加或更新 Referer 黑白名单
复制全文
下载 pdf
我的收藏
安全管理
UpdateReferer - 添加或更新 Referer 黑白名单
复制全文
下载 pdf
我的收藏
UpdateReferer - 添加或更新 Referer 黑白名单

调用 UpdateReferer 接口，添加或更新 Referer 防盗链配置。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 限额说明：同一个 Domain 下，默认支持配置不超过 100 个 Referer 规则，如需提升限额请创建工单获取技术支持。

请求说明

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

调试

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

请求参数

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

Query

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

Body

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

RefererInfoList

Array of RefererInfoList

是

-

Referer 防盗链规则列表。

说明

  • 同一个 Domain 下，默认支持配置不超过 100 个 Referer 规则，如需提升限额请创建工单获取技术支持；
  • 单次请求最多支持配置 100 个 Referer 规则。

RefererInfoList

参数类型是否必选示例值描述
KeyString是referer用于标识 referer 防盗链的关键词，默认取值为 referer。

Type

String

是

deny

Referer 字段规则类型，取值如下：

  • deny：拒绝，即黑名单；
  • allow：通过，即白名单。

说明

在同一次调用中，RefererInfoList 内所有规则的 Type 取值必须一致。

ValueString否live.example1.netReferer 字段规则，即设置的黑名单或白名单的域名，最大长度限制 300 个字符。

返回参数

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

请求示例 

POST https://live.volcengineapi.com?Action=UpdateReferer&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "Domain": "pull.example.com",
    "RefererInfoList": [
        {
            "Type": "allow",
            "Key": "referer",
            "Value": "live.example1.net"
        },
        {
            "Type": "allow",
            "Key": "referer",
            "Value": "live.example2.net"
        },
        {
            "Type": "allow",
            "Key": "referer",
            "Value": "live.example3.net"
        }
    ]
}

返回示例 

{
    "ResponseMetadata": {
        "Action": "UpdateReferer",
        "Region": "cn-north-1",
        "RequestId": "20230604110420****100232280022D31",
        "Service": "live",
        "Version": "2023-01-01"
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.Length%s should not be longer than %d参数长度错误，请检查错误消息中指定参数的长度是否超过限制。
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.出现与数据库相关的内部错误，请联系技术支持。
500InternalError.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。
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。

最近更新时间：2026.10.13 20:30:36
这个页面对您有帮助吗？
有用
有用
无用
无用