设置Referer防盗链黑白名单 - SetRefererChain
功能介绍
设置Referer黑白名单,直播服务会根据配置的referer黑白名单,对访问者的身份进行识别和过滤,符合规则的可以顺利访问到该内容。如果不符合规则,该访问请求将会被禁止。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
live:domain:updateRefererChain
Write
-
-
-
-
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization | 否 | String | 使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必填,携带项目ID信息。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
domain | 是 | String | 参数解释: 直播域名 约束限制: 不涉及 取值范围: 字符长度为[1-255]位 默认取值: 不涉及 |
guard_switch | 是 | String | 参数解释: referer防盗链开关 约束限制: 不涉及 取值范围: 默认取值: false |
referer_config_empty | 否 | String | 参数解释: 是否包含referer头域 约束限制: guard_switch为true则必填 取值范围: 默认取值: false |
referer_white_list | 否 | String | 参数解释: 是否为referer白名单 约束限制: guard_switch为true则必填 取值范围: 默认取值: true |
referer_auth_list | 否 | Array of strings | 参数解释: 域名列表,域名为正则表达式 约束限制: 最多支持配置1000个域名,以英文“;”进行分隔;guard_switch为true则必填 取值范围: 数组长度取值为[1,1000] 默认取值: 不涉及 |
响应参数
状态码:200
设置Referer防盗链黑白名单成功
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
PUT https://{endpoint}/v1/{project_id}/guard/referer-chain
{
"domain" : "play.example.huawei.com",
"guard_switch" : "true",
"referer_config_empty" : "true",
"referer_white_list" : "false",
"referer_auth_list" : [ "^http://test.*com$", "abc.com" ]
} 响应示例
状态码:400
设置Referer防盗链黑白名单失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; import java.util.List; import java.util.ArrayList; public class SetRefererChainSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); SetRefererChainRequest request = new SetRefererChainRequest(); SetRefererChainInfo body = new SetRefererChainInfo(); List<String> listbodyRefererAuthList = new ArrayList<>(); listbodyRefererAuthList.add("^http://test.*com$"); listbodyRefererAuthList.add("abc.com"); body.withRefererAuthList(listbodyRefererAuthList); body.withRefererWhiteList(SetRefererChainInfo.RefererWhiteListEnum.fromValue("false")); body.withRefererConfigEmpty(SetRefererChainInfo.RefererConfigEmptyEnum.fromValue("true")); body.withGuardSwitch(SetRefererChainInfo.GuardSwitchEnum.fromValue("true")); body.withDomain("play.example.huawei.com"); request.withBody(body); try { SetRefererChainResponse response = client.setRefererChain(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = SetRefererChainRequest() listRefererAuthListbody = [ "^http://test.*com$", "abc.com" ] request.body = SetRefererChainInfo( referer_auth_list=listRefererAuthListbody, referer_white_list="false", referer_config_empty="true", guard_switch="true", domain="play.example.huawei.com" ) response = client.set_referer_chain(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.SetRefererChainRequest{} var listRefererAuthListbody = []string{ "^http://test.*com$", "abc.com", } refererWhiteListSetRefererChainInfo:= model.GetSetRefererChainInfoRefererWhiteListEnum().FALSE refererConfigEmptySetRefererChainInfo:= model.GetSetRefererChainInfoRefererConfigEmptyEnum().TRUE request.Body = &model.SetRefererChainInfo{ RefererAuthList: &listRefererAuthListbody, RefererWhiteList: &refererWhiteListSetRefererChainInfo, RefererConfigEmpty: &refererConfigEmptySetRefererChainInfo, GuardSwitch: model.GetSetRefererChainInfoGuardSwitchEnum().TRUE, Domain: "play.example.huawei.com", } response, err := client.SetRefererChain(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 | 描述 |
|---|---|
200 | 设置Referer防盗链黑白名单成功 |
400 | 设置Referer防盗链黑白名单失败 |
错误码
请参见错误码。

