文档中心>API 中心>实时音视频>用量统计相关接口>查询TRTC音视频房间维度用量

查询TRTC音视频房间维度用量

最近更新时间:2024-03-12 10:45:12

我的收藏

1. 接口描述

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

查询TRTC音视频房间维度用量。

  • 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。
  • 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。
  • 默认接口请求频率限制:1次/15秒。
  • 数据最早可查日期为2023年4月1日0点,最大可查范围近3个月。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTrtcRoomUsage。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
SdkAppid Integer TRTC的SdkAppId,和房间所对应的SdkAppId相同。
示例值:1400017192
StartTime String 查询开始时间,格式为YYYY-MM-DD HH:MM,精确到分钟级。
示例值:2023-01-06 00:00
EndTime String 查询结束时间,格式为YYYY-MM-DD HH:MM,单次查询不超过24h。
示例值:2023-01-06 10:00

3. 输出参数

参数名称 类型 描述
Data String 房间维度用量数据,csv文件格式,单位:秒。
示例值:"RoomId,Audio,SD,hd,FullHD,2K,4K\ntest_room,1,2,3,4,5,6\n"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询TRTC音视频房间维度用量

查询TRTC音视频房间维度用量

输入示例

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

{
    "StartTime": "2023-01-06 00:00",
    "EndTime": "2023-01-06 10:00",
    "SdkAppid": 1400017192
}

输出示例

{
    "Response": {
        "RequestId": "68fccf1c-c2c7-466a-9f14-1db4bed6054b",
        "Data": "RoomId,Audio,SD,hd,FullHD,2K,4K\ntest_room,1,2,3,4,5,6\n"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SdkAppIdNotExist 应用ID不存在。
InternalError.DBError 数据库查询异常。
InvalidParameter 参数错误。