You need to enable JavaScript to run this app.
导航
添加或更新 Referer 黑白名单
最近更新时间:2023.10.12 17:39:57首次发布时间:2021.11.10 14:58:09

调用改接口创建Referer 防盗链,或更新 Referer 防盗链配置。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版添加或更新 Referer 黑白名单接口。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostStringlive.push.example.com域名空间名称。

Domain

String

live.push.example.com

拉流域名。

说明

参数 DomainApp 传且仅传一个。

App

String

live

应用名称,默认为所有应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成

说明

参数 DomainApp 传且仅传一个。

RefererInfoListArray of RefererInfoList-Referer 防盗链信息列表

RefererInfoList

参数类型是否必选示例值描述
KeyStringreferer用于标识 referer 防盗链的关键词默认取值为 referer
PriorityInteger80指定域名的优先级。默认值为 0,取值范围为 [0,100],数值越大,优先级越高。如果优先级相同,则越早加入列表的域名优先级越高

Type

String

deny

防盗链类型。支持如下取值。

  • deny:黑名单;
  • allow:白名单。
ValueStringlive.example1.net防盗链规则,即设置的黑名单或白名单的域名,最大长度限制 300 个字符

返回参数

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

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestID": "202011121850010102250920591B011F85",
    "Action": "UpdateReferer",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

访问公共错误码获取详细信息。