最近更新时间：2023.11.13 19:57:29
首次发布时间：2023.09.25 14:32:22
调用该接口创建Referer 防盗链，或更新 Referer 防盗链配置。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateReferer | 接口名称。当前 API 的名称为 UpdateReferer。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Vhost | String | 是 | live.push.example.com | 域名空间名称。 |
Domain | String | 否 |
| 拉流域名。 说明 参数 |
App | String | 否 |
| 应用名称，默认为所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 说明 参数 |
| RefererInfoList | Array of RefererInfoList | 是 | - | Referer 防盗链信息列表。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Key | String | 是 | referer | 用于标识 referer 防盗链的关键词默认取值为 referer。 |
| Priority | Integer | 否 | 80 | 指定域名的优先级。默认值为 0，取值范围为 [0,100]，数值越大，优先级越高。如果优先级相同，则越早加入列表的域名优先级越高。 |
Type | String | 是 |
| 防盗链类型，支持如下取值。
|
| Value | String | 否 | live.example1.net | 防盗链规则，即设置的黑名单或白名单的域名，最大长度限制 300 个字符。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=UpdateReferer&Version=2023-01-01 { "Vhost": "live.push.example.com", "Domain": "live.push.example.com", "RefererInfoList": [ { "Type": "allow", "Key": "referer", "Value": "live.example1.net", "Priority": 80 }, { "Type": "allow", "Key": "referer", "Value": "live.example2.net", "Priority": 80 }, { "Type": "deny", "Key": "referer", "Value": "live.example3.net", "Priority": 80 } ] }
{ "ResponseMetadata": { "RequestID": "202011121850010102250920591B011F85", "Action": "UpdateReferer", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 400 | InvalidParam.OutOfRange | %s should be one of {[%s]}%s should be between %d and %d | 参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。 |
| 400 | InvalidParam.Length | %s should not be longer than %d | 参数长度错误，请检查错误消息中指定参数的长度是否超过限制。 |
| 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. | 内部服务超时，请联系技术支持。 |