查询默认分发配置

最近更新时间:2024-03-12 02:01:31

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口用于查询默认分发配置。

  • 分发域名和分发协议,即媒体文件分发 URL 中的域名和协议。媒体文件按默认分发配置进行分发。
  • 播放密钥,用于计算播放器签名。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDefaultDistributionConfig。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123

3. 输出参数

参数名称 类型 描述
Domain String 分发配置的域名。
示例值:test.vod2.myqcluod.com
Scheme String 分发配置的协议,为 HTTP 或 HTTPS。
示例值:HTTPS
PlayKey String 播放密钥,由大小写字母(a - Z)或者数字(0 - 9)组成,长度在8 - 20个字符之间。
示例值:123
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询默认分发配置

查询默认分发配置。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDefaultDistributionConfig
<公共请求参数>

{}

输出示例

{
    "Response": {
        "RequestId": "requestId",
        "Domain": "test.vod2.myqcluod.com",
        "DomainName": "test.vod2.myqcluod.com",
        "Scheme": "HTTPS",
        "PlayKey": "abc12342a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidVodUser 没有开通点播业务。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。