本接口用于获取端对端指标数据。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:DescribeEndPointMetricData | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | APP ID。 | testappid |
| ChannelId | string | 是 | 频道 ID | testid |
| CreatedTs | long | 是 | 查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于 30 天之前。使用 UNIX 时间戳表示，单位：秒。 | 1614936817 |
| DestroyedTs | long | 否 | 查询时间区间的结束时间，该时间不得晚于频道释放时间。使用 UNIX 时间戳表示，单位：秒。参数为空，表示获取当前时间。 说明
如果传入的结束时间超过频道的释放时间，将返回从开始时间开始到频道释放时间之间的数据，且最多返回最近 3 个小时的数据。
| 1614936817 |
| SubUserId | string | 否 | 订阅端用户 ID。 | testuserid |
| PubUserId | string | 否 | 发布端用户 ID。 说明
PubUserId 和 PubCallIdList 参数只能二选一输入。
| testuserid2 |
| PubCallIdList | string | 否 | 发布端用户通信流的 Call ID，多个用英文逗号（,）分隔。 说明
PubUserId 和 PubCallIdList 参数只能二选一输入。
| testcall1,testcall2 |
| Metrics | string | 是 | 指标枚举列表，多个用英文逗号（,）分隔。 | VIDEO_STUCK_CAMERA |
指标如下所示：
| 名称 | 说明 |
|---|---|
| APP_CPU | APP 占用 CPU。 |
| SYSTEM_CPU | 系统占用 CPU。 |
| APP_MEMORY | APP 占用内存。 |
| SYSTEM_MEMORY | 系统占用内存。 |
| SYSTEM_TOTAL_MEMORY | 系统总内存。 |
| AUDIO_LOST_RATE | 音频丢包率。 |
| VIDEO_LOST_RATE | 视频丢包率。 |
| AUDIO_RTT | 音频延时。 |
| VIDEO_RTT | 视频延时。 |
| AUDIO_BIT_RATE | 音频码率。 |
| AUDIO_STUCK | 音频卡顿。 |
| AUDIO_LEVEL | 音量。 |
| VIDEO_BIT_RATE_CAMERA | 摄像头视频码率。 |
| VIDEO_BIT_RATE_SHARE | 视频码率（屏幕分享）。 |
| VIDEO_STUCK_CAMERA | 摄像头视频卡顿。 |
| VIDEO_STUCK_SHARE | 视频卡顿（屏幕分享）。 |
| VIDEO_RESOLUTION_CAMERA | 摄像头视频分辨率。 |
| VIDEO_RESOLUTION_SHARE | 视频分辨率（屏幕分享）。 |
| VIDEO_FPS_CAMERA | 摄像头视频帧率。 |
| VIDEO_FPS_SHARE | 视频帧率（屏幕分享）。 |
返回参数
示例
正常返回示例
JSON格式
{
"SubMetrics": [
{
"Type": "VIDEO_STUCK_CAMERA",
"UserId": "testuserid",
"Nodes": [
{
"X": "1548670257",
"Y": "230100",
"Ext": {
"test": "test",
"test2": 1
}
}
]
}
],
"PubMetrics": [
{
"Type": "VIDEO_STUCK_CAMERA",
"UserId": "testuserid",
"Nodes": [
{
"X": "1548670257",
"Y": "230100",
"Ext": {
"test": "test",
"test2": 1
}
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ApiParamError | API %s. | Api参数错误 |
| 403 | BizAppError | A business application permission error occurred. | 业务应用权限错误 |
| 403 | BizUidError | A business UID error occurred. | 业务主账号错误 |
| 403 | BizCreatedTsError | A business CreatedTs error occurred. | 参数会议创建时间不准确。 |
| 500 | ServerInternalError | An internal error occurred. | 服务器内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-09 | OpenAPI 错误码发生变更 | 查看变更详情 |