最近更新时间：2023.09.25 21:09:56
首次发布时间：2021.11.10 14:58:09
查询 Referer 防盗链内容。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询 Referer 黑白名单接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeReferer | 接口名称。当前 API 的名称为 DescribeReferer。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间名称 说明 参数 |
Domain | String | 否 |
| 拉流域名 说明
|
App | String | 否 |
| 应用名称，默认为所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成 说明 参数 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RefererList | Array of RefererList | - | Referer 防盗链信息列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | live.push.example.com | 域名空间名称 |
| Domain | String | live.push.example.com | 拉流域名 |
| App | String | live | 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 |
| RefererInfoList | Array of RefererInfoList | - | Referer 防盗链详情列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | referer | 用于标识 referer 防盗链的关键词，返回值为 referer |
Type | String |
| 防盗链类型。
|
| Value | String | example1.com | 防盗链规则 |
| Priority | Integer | 11 | 优先级，当前默认返回值为 0。当多域名返回值一致时，按照域名输入顺序区分，越早加入列表的域名优先级越高 |
POST https://live.volcengineapi.com?Action=DescribeReferer&Version=2020-08-01 { "Vhost": "live.push.example.com", "App": "live" }
{ "ResponseMetadata": { "RequestID": "202103032052250102251070931601EBBB", "Action": "DescribeReferer", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "RefererList": [ { "Vhost": "live.push.example.com", "App": "live", "RefererInfoList": [ { "Type": "deny", "Key": "referer", "Value": "example1.com", "Priority": 11 } ] }, { "Vhost": "live.push.example2.com", "App": "live2", "RefererInfoList": [ { "Type": "deny", "Key": "referer", "Value": "example2.com", "Priority": 100 }, { "Type": "allow", "Key": "referer", "Value": "example3.com", "Priority": 90 } ] } ] } }
访问公共错误码获取详细信息。