查询点播域名列表

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

我的收藏

1. 接口描述

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

该接口用于查询点播域名信息列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVodDomains。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
Domains.N Array of String 域名列表。当该字段不填时,则默认列出所有域名信息。本字段限制如下:
  • 域名个数度最大为 20。

  • 示例值:["myexample.com"]
    Limit Integer 分页拉取的最大返回结果数。默认值:20。
    示例值:10
    Offset Integer 分页拉取的起始偏移量。默认值:0。
    示例值:0
    SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
    示例值:1490012345

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 域名总数量。
    示例值:5
    DomainSet Array of DomainDetailInfo 域名信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询所有域名

    查询所有域名的信息。

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeVodDomains
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "DomainSet": [
                {
                    "Domain": "myexample.com",
                    "AccelerateAreaInfos": [
                        {
                            "Area": "Internation",
                            "TencentDisableReason": "",
                            "TencentEdgeDomain": "myexmample.com.dnsv1.com"
                        }
                    ],
                    "RefererAuthPolicy": {
                        "Status": "Disabled",
                        "AuthType": "",
                        "BlankRefererAllowed": "No",
                        "Referers": []
                    },
                    "DeployStatus": "Deploying",
                    "HTTPSConfig": {
                        "CloudCertId": "abc",
                        "CertExpireTime": "2030-01-23T07:25:52Z"
                    },
                    "UrlSignatureAuthPolicy": {
                        "Status": "Enabled",
                        "EncryptedKey": "acmowmeomeo13432a"
                    },
                    "CreateTime": "2019-12-23T07:25:52Z",
                    "QUICConfig": null
                }
            ],
            "RequestId": "aeomo-133w3-amomow-22"
        }
    }

    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 没有开通点播业务。
    InvalidParameter 参数错误。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.LimitTooLarge 参数值错误:Limit 过大。
    InvalidParameterValue.Offset 参数值错误:Offset 无效。
    InvalidParameterValue.OffsetTooLarge 参数值错误:Offset 过大。