更新 Referer 防盗链配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新 Referer 防盗链配置

最近更新时间：2024.09.30 14:07:50首次发布时间：2021.02.23 10:42:28

本接口支持通过其指定服务 ID 和域名更新防盗链配置。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateRefer&Version=2018-08-01

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

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

Action String 是 UpdateRefer 接口名称。当前 API 的名称为 UpdateRefer。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateRefer`	接口名称。当前 API 的名称为 `UpdateRefer`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`9h**09`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

9h**09

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
refer_link	Object of Refer_link	是	`-`	Referer 配置
domain	String	是	`http://test.com`	域名，您可以通过获取服务下全部域名获取服务下域名信息。

Refer_link

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启 Referer 访问限制，取值如下所示： `true`：开启 `false`：关闭
is_white_mode	Boolean	是	`true`	是否选择白名单模式，取值如下所示： `true`：选择白名单 `false`：选择黑名单
values	Array of String	否	`["test.example.com", "*.example.com", "10.0.0.1"]`	Referer 通用规则列表，根据是否为白名单，为对应的白/黑名单的值。您可以指定一个或者多个 IP 地址，域名和泛域名。支持填写二级域名，支持混合输入。 IP 地址格式支持 IPv4 和 IPv6，最多可输入 100 个 IP 地址。域名无需包含`http://` 或 `https://`。说明 `values` 和 `regex_valses` 均存在时，两者同时生效。若您需要对同类型名单内已设定的 `values` 地址进行增删处理，那么您可调用获取域名配置接口获取已配置的全部地址列表后，在此基础上添加或删除您期望变更的值，最后重新传入 `values`。
allow_empty_refer	Boolean	是	`false`	是否允许空 Referer 访问，取值如下所示： `true`：允许 `false`：不允许
regex_values_enabled	Boolean	是	`true`	是否启用正则表达列表，取值如下所示： `true`：启用 `false`：不启用
regex_values	Array of String	否	`\192\.23\.1\.8\b`	Referer 的正则表达式的列表，仅支持填写 IPv4 和 IPv6 格式的 IP 地址，参数长度范围为（1，1024）。不支持域名、泛域名、CIDR 网段。

返回参数

本接口调用成功返回 OK。更多信息请见公共返回参数。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateRefer&Version=2018-08-01&ServiceId=9h%2A%2A09
{
   "refer_link":{
      "enabled":true,
      "is_white_mode":false,
      "values":[
         "*.test.com",
         "10.0.0.1"
      ],
      "allow_empty_refer":true，
      "allow_empty_refer":true,
      "regex_values":[
          "\192\.23\.1\.8\b"
          ]
   },
   "domain":"text.volcimagextest.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateRefer",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": "ok"
}

错误码

访问公共错误码和域名相关错误码获取详细信息。