1. 接口描述
接口请求域名： live.tencentcloudapi.com 。
设置直播域名 Referer 黑白名单。
由于 Referer 信息包含在 http 协议中，在开启配置后，播放协议为 rtmp 或 WebRTC 不会校验 Referer 配置，仍可正常播放。如需配置 Referer 鉴权建议使用 http-flv 或 http-hls 协议播放。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyLiveDomainReferer。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DomainName | 是 | String | 播放域名。 示例值：5000.liveplay.myqcloud.com |
| Enable | 是 | Integer | 是否开启当前域名的 Referer 黑白名单鉴权。 示例值：1 |
| Type | 是 | Integer | 名单类型，0：黑名单，1：白名单。 示例值：0 |
| AllowEmpty | 是 | Integer | 是否允许空 Referer，0：不允许，1：允许。 示例值：1 |
| Rules | 是 | String | Referer 名单列表，以;分隔。 示例值：aaa.com;bbb.com |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=ModifyLiveDomainReferer
&DomainName=5000.liveplay.myqcloud.com
&Enable=1
&Type=0
&AllowEmpty=1
&Rules=aaa.com;bbb.com
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.ConnectDbError | DB 连接错误。 |
| InternalError.DBError | DB执行错误。 |
| InternalError.DomainNotExist | 域名不存在。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.DomainNotExist | 域名不存在或不匹配。 |
| ResourceNotFound.ForbidService | 用户被禁用。 |
| ResourceNotFound.FreezeService | 用户服务被冻结。 |
| ResourceNotFound.StopService | 账号停服，请先冲正开通服务后再操作。 |
| ResourceNotFound.UserDisableService | 用户主动停服。 |