查询用量 - ListRtcHistoryUsage
功能介绍
查询过去的某一时间段内各种业务的用量数据
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/rtc/history/usage
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app |
是 |
String |
应用标识 |
|
metric |
是 |
String |
查询的数据类型
|
|
start_date |
是 |
String |
查询起始时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23，不写默认读取过去1天数据数据。 |
|
end_date |
是 |
String |
查询结束时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求的唯一标识 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
usage |
Array of RtcHistoryUsage objects |
时间戳及相应时间的指标数值列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
date |
String |
采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DD |
|
video_sd |
Long |
标清视频时长，单位秒 |
|
video_hd |
Long |
高清视频时长，单位秒 |
|
video_hdp |
Long |
超高清视频时长，单位秒 |
|
audio |
Long |
音频时长，单位秒 |
|
total_duration |
Long |
音视频总时长，单位秒 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET /v1/{project_id}/rtc/history/usage?app=5fa682b34a974f7ad24d223b&metric=CommunicationDuration&start_date=2020-04-23&end_date=2020-04-26
响应示例
状态码：200
查询成功返回。
{
"usage" : [ {
"date" : "2020-06-04",
"video_sd" : 1,
"video_hd" : 1,
"video_hdp" : 1,
"audio" : 1,
"total_duration" : 4
} ]
}
状态码：400
查询失败返回
{
"error_code" : "DATA.100011001",
"error_msg" : "Required String parameter 'app' is not present"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功返回。 |
|
400 |
查询失败返回 |
错误码
请参见错误码。
