1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
查询播放鉴权key。
默认接口请求频率限制:500次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLivePlayAuthKey。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| DomainName | 是 | String | 域名。 示例值:a.elementtest.org | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| PlayAuthKeyInfo | PlayAuthKeyInfo | 播放鉴权key信息。 示例值:{"DomainName":"pull.xiangdongshow.com","Enable":0,"AuthKey":"","AuthBackKey":"","AuthDelta":0}} | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=DescribeLivePlayAuthKey
&DomainName=5000.livepush.myqcloud.com
&<公共请求参数>输出示例
{
    "Response": {
        "PlayAuthKeyInfo": {
            "DomainName": "5000.livepush.myqcloud.com",
            "Enable": 1,
            "AuthKey": "AKID0QJ82oYdLJ",
            "AuthDelta": 300,
            "AuthBackKey": "lbPUl5VIKKFB1KazNB"
        },
        "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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError | 内部错误。 | 
| InternalError.ConnectDbError | DB 连接错误。 | 
| InternalError.DBError | DB执行错误。 | 
| InternalError.PlayDomainNoRecord | 播放域名不存在。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue | 参数取值错误。 | 
| MissingParameter | 缺少参数错误。 | 
| ResourceNotFound.ForbidService | 用户被禁用。 | 
| ResourceNotFound.FreezeService | 用户服务被冻结。 | 
| ResourceNotFound.PlayDomainNoRecord | 播放域名不存在。 | 
| ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 | 
| ResourceNotFound.UserDisableService | 用户主动停服。 |