API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

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

直播推流带宽和流量数据查询。
推流计费会先取全球推流用量和全球播放用量进行比较,满足计费条件后再按各地区用量出账。详情参见计费文档

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePushBandwidthAndFluxList。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间点,格式为 yyyy-mm-dd HH:MM:SS。
EndTime String 结束时间点,格式为 yyyy-mm-dd HH:MM:SS,起始和结束时间跨度不支持超过31天。
PushDomains.N Array of String 域名,可以填多个,若不填,表示总体数据。
MainlandOrOversea String 可选值:
Mainland:查询中国大陆(境内)数据,
Oversea:则查询国际/港澳台(境外)数据,
不填则默认查询全球地区(境内+境外)的数据。
Granularity Integer 数据粒度,支持如下粒度:
5:5分钟粒度,(跨度不支持超过1天),
60:1小时粒度(跨度不支持超过一个月),
1440:天粒度(跨度不支持超过一个月)。
默认值:5。
RegionNames.N Array of String 大区,映射表如下:
China Mainland 中国大陆
Asia Pacific I 亚太一区
Asia Pacific II 亚太二区
Asia Pacific III 亚太三区
Europe 欧洲
North America 北美
South America 南美
Middle East 中东
Africa 非洲。
CountryNames.N Array of String 国家,映射表参照如下文档:
https://cloud.tencent.com/document/product/267/34019。

3. 输出参数

参数名称 类型 描述
PeakBandwidthTime String 峰值带宽所在时间点,格式为 yyyy-mm-dd HH:MM:SS。
PeakBandwidth Float 峰值带宽,单位是 Mbps。
P95PeakBandwidthTime String 95峰值带宽所在时间点,格式为 yyyy-mm-dd HH:MM:SS。
P95PeakBandwidth Float 95峰值带宽,单位是 Mbps。
SumFlux Float 总流量,单位是 MB。
DataInfoList Array of BillDataInfo 明细数据信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{
    "StartTime": "2019-02-01 00:00:00",
    "EndTime": "2019-02-03 00:00:00",
    "PushDomains": [
        "tx-game.push.yximgs.com",
        "tx-game2.push.yximgs.com"
    ],
    "MainlandOrOversea": "Mainland",
    "Granularity": 5
}

输出示例

{
    "Response": {
        "P95PeakBandwidth": 117042.495,
        "P95PeakBandwidthTime": "2019-02-01 00:00:00",
        "DataInfoList": [
            {
                "Bandwidth": 117042.495,
                "Flux": 4389093.551,
                "Time": "2019-02-01 00:00:00",
                "PeakTime": "2019-02-01 00:00:00"
            },
            {
                "Bandwidth": 110364.995,
                "Flux": 4138687.32,
                "Time": "2019-02-01 00:05:00",
                "PeakTime": "2019-02-01 00:05:00"
            },
            {
                "Bandwidth": 99380.978,
                "Flux": 3726786.679,
                "Time": "2019-02-01 00:10:00",
                "PeakTime": "2019-02-01 00:10:00"
            }
        ],
        "PeakBandwidth": 117042.495,
        "PeakBandwidthTime": "2019-02-01 00:00:00",
        "RequestId": "f54e3deb-f318-4148-8a68-3c959642f9ec",
        "SumFlux": 12254567.55
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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