調用PutBucketReferer接口設置存儲空間(Bucket)級別的Referer訪問白名單以及黑名單。
請求語法
PUT /?referer HTTP/1.1
Date: GMT Date
Content-Length:ContentLength
Content-Type: application/xml
Host: BucketName.oss.aliyuncs.com
Authorization: SignatureValue
<?xml version="1.0" encoding="UTF-8"?>
<RefererConfiguration>
<AllowEmptyReferer>false</AllowEmptyReferer>
<AllowTruncateQueryString>true</AllowTruncateQueryString>
<TruncatePath>true</TruncatePath>
<RefererList>
<Referer>http://www.aliyun.com</Referer>
<Referer>https://www.aliyun.com</Referer>
<Referer>http://www.*.com</Referer>
<Referer>https://www.?.aliyuncs.com</Referer>
</RefererList>
<RefererBlacklist>
<Referer>http://www.refuse.com</Referer>
<Referer>https://*.hack.com</Referer>
<Referer>http://ban.*.com</Referer>
<Referer>https://www.?.deny.com</Referer>
</RefererBlacklist>
</RefererConfiguration>
當您在OSS ON云盒中調用該接口時,您需要將Host替換為云盒Endpoint。更多信息,請參見云盒Endpoint。
請求元素
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
RefererConfiguration | 容器 | 是 | 不涉及 | 保存Referer配置內容的容器。 子節點:AllowEmptyReferer、AllowTruncateQueryString、RefererList 父節點:無 |
AllowEmptyReferer | 枚舉字符串 | 是 | false | 指定是否允許Referer字段為空的請求訪問OSS。取值如下:
父節點:RefererConfiguration |
AllowTruncateQueryString | 枚舉字符串 | 否 | true | 指定匹配Referer時,是否截斷URL中的QueryString。取值如下:
父節點:RefererConfiguration |
TruncatePath | 枚舉字符串 | 否 | true | 指定匹配Referer時,是否截斷URL中包括Path在內的后續所有部分。取值如下:
父節點:RefererConfiguration |
RefererList | 容器 | 是 | 不涉及 | 保存Referer訪問白名單的容器。 說明 PutBucketReferer為覆蓋語義,即RefererList中新指定的白名單列表將覆蓋已配置的白名單列表。當您上傳的RefererList為空時(即不包含Referer請求元素),此操作將清空RefererList中已配置的白名單列表。 父節點:RefererConfiguration 子節點:Referer |
RefererBlacklist | 容器 | 否 | 不涉及 | 保存Referer訪問黑名單的容器。 說明 PutBucketReferer為覆蓋語義,即RefererBlacklist中新指定的黑名單列表將覆蓋已配置的黑名單列表。當您上傳的RefererBlacklist為空時(即不包含Referer請求元素),此操作將清空RefererBlacklist中已配置的黑名單列表。 父節點:RefererConfiguration 子節點:Referer |
Referer | 字符串 | 否 | http://www.aliyun.com | 指定Referer訪問白名單或黑名單記錄。 父節點:RefererList或RefererBlacklist |
此接口還涉及其他公共請求頭,例如Host、Authorization等。更多信息,請參見公共請求頭(Common Request Headers)。
響應頭
此接口僅涉及公共響應頭。更多信息,請參見公共響應頭(Common Response Headers)。
示例
請求示例
不包含Referer的請求示例
PUT /?referer HTTP/1.1 Host: BucketName.oss.example.com Content-Length: 247 Date: Fri, 04 May 2012 03:21:12 GMT Authorization: OSS qn6q**************:77Dv**************** <?xml version="1.0" encoding="UTF-8"?> <RefererConfiguration> <AllowEmptyReferer>true</AllowEmptyReferer> <RefererList/> </RefererConfiguration>
僅包含白名單Referer的請求示例
PUT /?referer HTTP/1.1 Host: BucketName.oss.example.com Content-Length: 247 Date: Fri, 04 May 2012 03:21:12 GMT Authorization: OSS qn6q**************:77Dv**************** <?xml version="1.0" encoding="UTF-8"?> <RefererConfiguration> <AllowEmptyReferer>false</AllowEmptyReferer> <AllowTruncateQueryString>true</AllowTruncateQueryString> <TruncatePath>true</TruncatePath> <RefererList> <Referer>http://www.aliyun.com</Referer> <Referer>https://www.aliyun.com</Referer> <Referer>http://www.*.com</Referer> <Referer>https://www.?.aliyuncs.com</Referer> </RefererList> </RefererConfiguration>
同時包含白名單Referer以及黑名單Referer的請求示例
PUT /?referer HTTP/1.1 Host: BucketName.oss.example.com Content-Length: *** Date: Fri, 04 May 2012 03:21:12 GMT Authorization: OSS qn6q**************:77Dv**************** <?xml version="1.0" encoding="UTF-8"?> <RefererConfiguration> <AllowEmptyReferer>false</AllowEmptyReferer> <AllowTruncateQueryString>true</AllowTruncateQueryString> <TruncatePath>true</TruncatePath> <RefererList> <Referer>http://www.aliyun.com</Referer> <Referer>https://www.aliyun.com</Referer> <Referer>http://www.*.com</Referer> <Referer>https://www.?.aliyuncs.com</Referer> </RefererList> <RefererBlacklist> <Referer>http://www.refuse.com</Referer> <Referer>https://*.hack.com</Referer> <Referer>http://ban.*.com</Referer> <Referer>https://www.?.deny.com</Referer> </RefererBlacklist> </RefererConfiguration>
返回示例
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Fri, 04 May 2012 03:21:12 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
x-oss-server-time: 110
SDK
此接口所對應的各語言SDK如下:
錯誤碼
錯誤碼 | HTTP狀態碼 | 描述 |
AccessDenied | 403 | 沒有操作權限。只有Bucket的擁有者才能發起PutBucketReferer請求。 |
InvalidDigest | 400 | 上傳了Content-MD5請求頭后,OSS會計算消息體的Content-MD5并檢查一致性。如果不一致,則返回此錯誤碼。 |
InlineDataTooLarge | 400 | 防盜鏈Referer名單超過了20 KB大小上限,請減少名單中的條目以滿足限制要求。 |