文档首页/ 内容分发网络 CDN/ API参考/ 历史API/ 域名配置/ 设置Referer过滤规则
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

设置Referer过滤规则

功能介绍

设置Referer过滤规则。通过设置过滤策略，对访问者身份进行识别和过滤，实现限制访问来源的目的。

URI

PUT /v1.0/cdn/domains/{domain_id}/referer

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

加速域名id。

您可以通过查询加速域名接口查询加速域名id。
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

当用户开启企业项目功能时，该参数生效，表示修改当前企业项目下加速域名的配置，"all"代表所有项目。注意：当使用子账号调用接口时，该参数必传。

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表4 请求Body参数

参数

是否必选

参数类型

描述

referer

是

Referer object

Referrer配置。
表5 Referer

参数

是否必选

参数类型

描述

referer_type

是

Integer

Referer类型。取值：0代表不设置Referer过滤；1代表黑名单；2代表白名单。默认取值为0。

referer_list

否

String

请输入域名或IP地址，以“;”进行分隔，域名、IP地址可以混合输入，支持泛域名添加。输入的域名、IP地址总数不超过400个。当设置防盗链时，此项必填。

include_empty

否

Boolean

是否包含空Referer。如果是黑名单并开启该选项，则表示无referer不允许访问。如果是白名单并开启该选项，则表示无referer允许访问。true:包含，false：不包含，默认值false。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

referer

RefererRsp object

Referrer配置。
表7 RefererRsp

参数

参数类型

描述

referer_type

Integer

Referer类型。取值：0代表不设置Referer过滤；1代表黑名单；2代表白名单。默认取值为0。

referer_list

String

配置的referer地址。

include_empty

Boolean

是否包含空Referer。如果是黑名单并开启该选项，则表示无referer不允许访问。如果是白名单并开启该选项，则表示无referer允许访问。默认不包含,true：包含，false：不包含。

请求示例

PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff8080**********************d71/referer?enterprise_project_id=0

{
  "referer" : {
    "referer_type" : 1,
    "referer_list" : "www.example1.com;www.example2.com",
    "include_empty" : false
  }
}

响应示例

状态码： 200

OK

{
  "referer" : {
    "referer_type" : 1,
    "referer_list" : "www.example1.com;www.example2.com",
    "include_empty" : false
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 域名配置

相关文档