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: 连麦包。 示例值:1 |
OrderBy | 否 | String | 排序规则: 1. BuyTimeDesc: 最新购买的排在最前面 2. BuyTimeAsc: 最老购买的排在最前面 3. ExpireTimeDesc: 最后过期的排在最前面 4. ExpireTimeAsc:最先过期的排在最前面。 注意: 1. PackageType 为 2(连麦包) 的时候,不支持 3、4 排序。 示例值:BuyTime desc |
PageNum | 否 | Integer | 取得第几页的数据,和 PageSize 同时传递才会生效。 示例值:1 |
PageSize | 否 | Integer | 分页大小,和 PageNum 同时传递才会生效。 取值:10 ~ 100 之间的任意整数。 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LivePackageInfoList | Array of LivePackageInfo | 套餐包信息。 |
PackageBillMode | Integer | 套餐包当前计费方式: -1: 无计费方式或获取失败 0: 无计费方式 201: 月结带宽 202: 月结流量 203: 日结带宽 204: 日结流量 205: 日结时长 206: 月结时长 304: 日结流量。 示例值:201 |
TotalPage | Integer | 总页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalNum | Integer | 数据总条数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:95 |
PageNum | Integer | 当前页数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
PageSize | Integer | 当前每页数量。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
FluxPackageBillMode | String | 当请求参数 PackageType = 0 时生效,逗号分隔,从第一个到最后一个分别表示: 标准直播,中国大陆(境内全地区)计费方式。 标准直播,国际/港澳台(境外多地区)计费方式。 快直播,中国大陆(境内全地区)计费方式。 快直播,国际/港澳台(境外多地区)计费方式。 示例值:201,201,204,204 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询直播套餐包信息
输入示例
https://live.tencentcloudapi.com/?Action=DescribeLivePackageInfo
&PackageType=0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "53fc3618-4152-4e12-a1e6-3805e647a602",
"LivePackageInfoList": [
{
"Id": "281975",
"Type": 0,
"Status": 1,
"Total": 500000000000,
"Used": 2365271265,
"Left": 497634728735,
"BuyTime": "2024-07-16 18:46:08",
"ExpireTime": "2025-07-16 18:46:08",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "272177",
"Type": 0,
"Status": 4,
"Total": 500000000000,
"Used": 500000000000,
"Left": 0,
"BuyTime": "2023-12-05 10:17:04",
"ExpireTime": "2024-12-05 10:17:04",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "265480",
"Type": 0,
"Status": 4,
"Total": 100000000000,
"Used": 100000000000,
"Left": 0,
"BuyTime": "2023-07-14 14:14:30",
"ExpireTime": "2024-07-14 14:14:30",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "242917",
"Type": 0,
"Status": 4,
"Total": 1000000000000,
"Used": 1000000000000,
"Left": 0,
"BuyTime": "2022-09-30 10:01:19",
"ExpireTime": "2023-09-30 10:01:19",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "224805",
"Type": 0,
"Status": 4,
"Total": 100000000000,
"Used": 100000000000,
"Left": 0,
"BuyTime": "2022-04-01 10:13:27",
"ExpireTime": "2023-04-01 10:13:27",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "224804",
"Type": 0,
"Status": 4,
"Total": 100000000000,
"Used": 100000000000,
"Left": 0,
"BuyTime": "2022-04-01 10:13:27",
"ExpireTime": "2023-04-01 10:13:27",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "210034",
"Type": 0,
"Status": 4,
"Total": 100000000000,
"Used": 100000000000,
"Left": 0,
"BuyTime": "2021-11-16 16:48:39",
"ExpireTime": "2022-11-16 16:48:39",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "174007",
"Type": 0,
"Status": 4,
"Total": 100000000000,
"Used": 100000000000,
"Left": 0,
"BuyTime": "2021-03-19 16:21:52",
"ExpireTime": "2022-03-19 16:21:52",
"WillRenew": 0,
"RenewalResult": 0
},
{
"Id": "138556",
"Type": 0,
"Status": 4,
"Total": 20000000000,
"Used": 20000000000,
"Left": 0,
"BuyTime": "2020-09-09 12:45:48",
"ExpireTime": "2021-09-09 12:45:48",
"WillRenew": 0,
"RenewalResult": 0
}
],
"PackageBillMode": 204,
"FluxPackageBillMode": "204,204,204,204,-1,-1",
"TotalPage": 1,
"TotalNum": 9,
"PageNum": 1,
"PageSize": 100
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBError | DB执行错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |