文档中心

更新 Referer 防盗链配置

最近更新时间：2023.05.26 13:11:19

首次发布时间：2021.02.23 10:42:28

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

请求说明

接口名称：UpdateRefer
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=UpdateRefer&Version=2018-08-01
请求频率限制：20 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

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

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

ServiceId

String

是

服务 ID。

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

Body

参数	类型	是否必选	描述
domain	String	是	域名，您可以通过获取服务下全部域名获取服务下域名信息。
refer_link	Array of refer_link	是	refer 配置

refer_link

参数	类型	是否必填	描述
enabled	Bool	是	是否开启，取值如下所示： true：开启 false：关闭
is_white_mode	Bool	否	是否选择白名单，取值如下所示： true：选择白名单 false：不选择白名单
values	Array of String	否	根据是否为白名单，为对应的白/黑名单的值。
allow_empty_refer	Bool	否	是否允许空 Refer，取值如下所示： true：允许空 Refer false：不允许空 Refer

返回参数

正确更新返回 ok，否则错误在 Err 中返回。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateRefer&Version=2018-08-01
{
  "domain": "i.imagex.com",
  "refer_link":{
        "enabled":true,
        "is_white_mode":true,
        "values":["s.com", "y.com", "q.com"]
    }
}

正常返回示例

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

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateRefer",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "UpdateReferErr",
            "Message": "refer format error"
        }
    }
}

错误码

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