查询TRTC音视频用量

最近更新时间:2024-07-12 01:27:49

我的收藏

1. 接口描述

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

获取TRTC音视频互动的用量明细,单位:分钟。

  • 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
  • 单次查询统计区间最多不能超过31天。
  • 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
  • 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
  • 默认接口请求频率限制:5次/秒。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTrtcUsage。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
StartTime String 查询开始时间,格式为YYYY-MM-DD。
示例值:2022-01-01 00:00:00
EndTime String 查询结束时间,格式为YYYY-MM-DD。
单次查询统计区间最多不能超过31天。
示例值:2022-01-01 00:00:00
SdkAppId Integer TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
示例值:1400123456

3. 输出参数

参数名称 类型 描述
UsageKey Array of String 用量类型,与UsageValue中各个位置的值对应。
UsageList Array of TrtcUsage 各个时间点用量明细,单位:分钟
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用户在2022年1月1日-2022年1月2日范围内,SdkAppId为1400123456的应用的用量明细。

输入示例

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

{
    "EndTime": "2022-01-01",
    "StartTime": "2022-01-02",
    "SdkAppId": 1400123456
}

输出示例

{
    "Response": {
        "UsageKey": [
            "Audio",
            "SD",
            "HD",
            "FullHD",
            "2K",
            "4K"
        ],
        "UsageList": [
            {
                "TimeKey": "2022-01-01 00:00:00",
                "UsageValue": [
                    10,
                    20,
                    30,
                    40,
                    50,
                    60
                ]
            },
            {
                "TimeKey": "2022-01-02 00:00:00",
                "UsageValue": [
                    10,
                    20,
                    30,
                    40,
                    50,
                    60
                ]
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.QueryScaleOversize 查询范围超过文档限制。
InvalidParameter.SdkAppId SdkAppId参数错误。