调用 DescribeReferer 接口，查看 Referer 防盗链配置。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeReferer | 接口名称。当前 API 的名称为 DescribeReferer。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间，即直播流地址的域名（ 说明 参数 |
Domain | String | 否 |
| 拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的拉流域名。 说明
|
App | String | 否 |
| 应用名称，取值与直播流地址中 AppName 字段取值相同，默认为空，表示所有应用名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 说明 参数 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RefererList | Array of RefererList | - | Referer 防盗链信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 域名空间。 |
| Domain | String | push.example.com | 拉流域名。 |
| App | String | live | 应用名称。 |
| RefererInfoList | Array of RefererInfoList | - | Referer 防盗链详情列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | referer | 用于标识 referer 防盗链的关键词，返回值为 referer。 |
Type | String |
| referer 防盗链黑白名单类型，取值即含义如下所示。
|
| Value | String | example1.com | Referer 字段规则，即设置的黑名单或白名单的域名。 |
| Priority | Integer | 11 | 优先级，当前默认返回值为 0。当多域名返回值一致时，按照域名输入顺序区分，越早加入列表的域名优先级越高。 |
POST https://live.volcengineapi.com?Action=DescribeReferer&Version=2023-01-01 { "Vhost": "push.example.com", "App": "live" }
{ "ResponseMetadata": { "RequestID": "202103032052250102251070931601EBBB", "Action": "DescribeReferer", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "RefererList": [ { "Vhost": "push.example.com", "App": "live", "RefererInfoList": [ { "Type": "deny", "Key": "referer", "Value": "example1.com", "Priority": 11 } ] }, { "Vhost": "push.example2.com", "App": "live2", "RefererInfoList": [ { "Type": "deny", "Key": "referer", "Value": "example2.com", "Priority": 100 }, { "Type": "allow", "Key": "referer", "Value": "example3.com", "Priority": 90 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 400 | InvalidParam.DomainAndApp | domain and app exist can not exist at the same time | 入参不能同时传入 Domain 和 App ，请修改入参。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误，请联系技术支持。 |
| 500 | InternalError.VhostOrDomain | an internal error related to vhost or domain occurred, please contact the administrator. | 出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。