API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

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

根据域名状态、类型等信息查询用户的域名信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveDomains。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
DomainStatus Integer 域名状态过滤。0-停用,1-启用。
DomainType Integer 域名类型过滤。0-推流,1-播放。
PageSize Integer 分页大小,范围:10~100。默认10。
PageNum Integer 取第几页,范围:1~100000。默认1。
IsDelayLive Integer 0 普通直播 1慢直播 默认0。
DomainPrefix String 域名前缀。
PlayType Integer 播放区域,只在 DomainType=1 时该参数有意义。
1: 国内。
2: 全球。
3: 海外。

3. 输出参数

参数名称 类型 描述
AllCount Integer 总记录数。
DomainList Array of DomainInfo 域名详细信息列表。
CreateLimitCount Integer 可继续添加域名数量。
注意:此字段可能返回 null,表示取不到有效值。
PlayTypeCount Array of Integer 启用的播放域名加速区域统计,数组元素分别为:中国大陆(境内),全球地区,国际/港澳台(境外)域名数量。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询域名列表

输入示例

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

{
    "IsDelayLive": "0",
    "PageSize": "10",
    "PageNum": "1",
    "DomainStatus": "1",
    "DomainType": "1"
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "AllCount": 2,
        "CreateLimitCount": 0,
        "PlayTypeCount": [
            1,
            2,
            3
        ],
        "DomainList": [
            {
                "Name": "abc.com",
                "IsMiniProgramLive": 0,
                "Type": 1,
                "Status": 1,
                "PlayType": 1,
                "IsDelayLive": 0,
                "CreateTime": "2018-08-29 10:00:00",
                "BCName": 1,
                "CurrentCName": "",
                "TargetDomain": "abc.com.liveplay.myqcloud.com",
                "RentTag": 0,
                "RentExpireTime": "0000-00-00 00:00:00"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InternalError 内部错误。
InternalError.ConnectDbError DB 连接错误。
InternalError.DBError DB执行错误。
InternalError.GetBizidError 获取用户账号错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.InvalidUser 用户不支持此接口。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
目录