查询Referer防盗链黑白名单
功能介绍
查询Referer防盗链黑白名单
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/guard/referer-chain
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain |
是 |
String |
直播播放域名 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
domain |
String |
直播域名 |
|
guard_switch |
String |
referer防盗链开关：true表示开启；false表示关闭 |
|
referer_config_empty |
String |
是否包含referer头域：true表示包含；false表示不包含；guard_switch为true则必填 |
|
referer_white_list |
String |
是否为referer白名单：true表示白名单；false表示黑名单；guard_switch为true则必填 |
|
referer_auth_list |
Array of strings |
域名列表，域名为正则表达式；最多支持配置100个域名，以英文“;”进行分隔；guard_switch为true则必填 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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黑白名单失败 |
错误码
请参见错误码。
