API 文档

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

1. 接口描述

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

查询用户套餐包总量、使用量、剩余量、包状态、购买时间和过期时间等。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLivePackageInfo。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
PackageType Integer 包类型,可选值:
0:流量包
1:转码包
2: 连麦包。
OrderBy String 排序规则:
1. BuyTimeDesc: 最新购买的排在最前面
2. BuyTimeAsc: 最老购买的排在最前面
3. ExpireTimeDesc: 最后过期的排在最前面
4. ExpireTimeAsc:最先过期的排在最前面。

注意:
1. PackageType 为 2(连麦包) 的时候,不支持 3、4 排序。
PageNum Integer 取得第几页的数据,和 PageSize 同时传递才会生效。
PageSize Integer 分页大小,和 PageNum 同时传递才会生效。
取值:10 ~ 100 之间的任意整数。

3. 输出参数

参数名称 类型 描述
LivePackageInfoList Array of LivePackageInfo 套餐包信息。
注意:此字段可能返回 null,表示取不到有效值。
PackageBillMode Integer 套餐包当前计费方式:
-1: 无计费方式或获取失败
0: 无计费方式
201: 月结带宽
202: 月结流量
203: 日结带宽
204: 日结流量
205: 日结时长
206: 月结时长
304: 日结流量。
注意:此字段可能返回 null,表示取不到有效值。
TotalPage Integer 总页数。
注意:此字段可能返回 null,表示取不到有效值。
TotalNum Integer 数据总条数。
注意:此字段可能返回 null,表示取不到有效值。
PageNum Integer 当前页数。
注意:此字段可能返回 null,表示取不到有效值。
PageSize Integer 当前每页数量。
注意:此字段可能返回 null,表示取不到有效值。
FluxPackageBillMode String 当请求参数 PackageType = 0 时生效,逗号分隔,从第一个到最后一个分别表示:
标准直播,中国大陆(境内全地区)计费方式。
标准直播,国际/港澳台(境外多地区)计费方式。
快直播,中国大陆(境内全地区)计费方式。
快直播,国际/港澳台(境外多地区)计费方式。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询直播套餐包信息

输入示例

https://live.tencentcloudapi.com/?Action=DescribeLivePackageInfo
&PackageType=0
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "eac6b30c-a32x-493c-8e36-83b295459397",
        "PackageBillMode": 201,
        "TotalPage": 0,
        "TotalNum": 0,
        "PageNum": 0,
        "PageSize": 0,
        "FluxPackageBillMode": "xx",
        "LivePackageInfoList": [
            {
                "Id": "17",
                "Total": 10000,
                "Used": 3000,
                "Left": 7000,
                "Status": 1,
                "BuyTime": "2019-12-17 17:36:20",
                "ExpireTime": "2020-12-17 17:36:20",
                "Type": 0
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.DBError DB执行错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
目录