
# 查询Referer防盗链黑白名单 - GetRefererChain
#### 功能介绍
查询Referer防盗链黑白名单
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-live/live_03_0001.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-live/live_03_0013.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                         | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | live:domain:getRefererChain | Read | -           | -   | -  | -      |
     
  
 
#### URI
GET /v1/{project_id}/guard/referer-chain
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| domain | 是    | String | **参数解释**： 直播播放域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 |
   
#### 请求参数
表3请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                      |
|:---|:---|:---|:---|
| 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信息。                                                |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数                   | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| domain               | String           | **参数解释**： 直播域名 **取值范围**： 字符长度为\[1-255\]位                                                                                                                                                                                                                                                                                                               |
| guard_switch         | String           | **参数解释**： referer防盗链开关 **取值范围**： - true：开启   - false：关闭       |
| referer_config_empty | String           | **参数解释**： 是否包含referer头域 **取值范围**： - true：包含   - false：不包含     |
| referer_white_list   | String           | **参数解释**： 是否为referer白名单 **取值范围**： - true：白名单   - false：黑名单    |
| referer_auth_list    | Array of strings | **参数解释**： 域名列表，域名为正则表达式 **取值范围**： 数组长度取值为\[1,1000\]                                                                                                                                                                                                                                                                                                    |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
```
GET https://{endpoint}/v1/{project_id}/guard/referer-chain?domain=play.example.huawei.com
```
#### 响应示例
**状态码：200**
查询Referer黑白名单成功
```
{
  "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"
}
```
#### 状态码
| 状态码 | 描述              |
|:---|:---|
| 200 | 查询Referer黑白名单成功 |
| 400 | 查询Referer黑白名单失败 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。
