DescribeChannelOverallData - 查询频道概览数据_音视频通信(RTC)-阿里云帮助中心

本接口用于查询频道概览数据。

接口说明

使用说明

本接口用于查询频道概览数据。例如：您可以查询通信基本信息、指标趋势图等信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	APP ID。	testappid
ChannelId	string	是	频道 ID。	testid
CreatedTs	long	是	创建频道的时间戳，支持查询最近 30 天的数据。使用 UNIX 时间戳表示，单位：秒。	1615860711
DestroyedTs	long	否	频道释放时间，使用 UNIX 时间戳表示，单位：秒。参数为空表示获取当前时间。说明如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。	1615860811

返回参数

名称	类型	描述	示例值
	object
MetricDatas	object []	指标数据列表。
Type	string	指标类型。取值： CALL_QUALITY：通信质量。 CONN_NUM：加入频道成功用时的区间分布。	CALL_QUALITY
Nodes	object []	指标趋势图坐标点列表。
X	string	指标趋势图中 x 轴横坐标。	1612418625
Y	string	指标趋势图中 y 轴纵坐标。	123
Ext	object	扩展数据。
OverallData	object	概览数据。
ConnAvgTime	float	平均通信连接的用时，单位：秒。	0.5
FiveSecJoinRate	float	5 秒内连通成功率，用小数表示，例如 1.0 表示连通成功率为 100%。	0.91
TotalAudioStuckRate	float	整体音频卡顿率，用小数表示，例如 0.02 表示音频卡顿率为 2%。	0.02
TotalVideoStuckRate	float	整体视频卡顿率，用小数表示，例如 0.02 表示视频卡顿率为 2%。	0.02
TotalVideoVagueRate	float	整体视频模糊率，用小数表示，例如 0.02 表示视频模糊率为 2%。	0.02
CallInfo	object	通信基本信息。
AppId	string	应用 ID。	testappid
ChannelId	string	频道 ID。	testid
CallStatus	string	通信状态。取值： IN：进行中。 OUT：已结束。	IN
CreatedTs	long	创建频道的时间戳，使用 UNIX 时间戳表示，单位：秒。	1615860711
DestroyedTs	long	释放频道的时间戳，使用 UNIX 时间戳表示，单位：秒。	1615860811
Duration	long	频道时长，单位：秒。	100
RequestId	string	请求 ID。	231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "MetricDatas": [
    {
      "Type": "CALL_QUALITY",
      "Nodes": [
        {
          "X": "1612418625",
          "Y": "123",
          "Ext": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    }
  ],
  "OverallData": {
    "ConnAvgTime": 0.5,
    "FiveSecJoinRate": 0.91,
    "TotalAudioStuckRate": 0.02,
    "TotalVideoStuckRate": 0.02,
    "TotalVideoVagueRate": 0.02
  },
  "CallInfo": {
    "AppId": "testappid",
    "ChannelId": "testid",
    "CallStatus": "IN",
    "CreatedTs": 1615860711,
    "DestroyedTs": 1615860811,
    "Duration": 100
  },
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ApiParamError	API %s.	Api参数错误
403	BizCreatedTsError	A business CreatedTs error occurred.	参数会议创建时间不准确。
403	BizAppError	A business application permission error occurred.	业务应用权限错误
403	BizUidError	A business UID error occurred.	业务主账号错误
500	ServerInternalError	An internal error occurred.	服务器内部错误

访问错误中心查看更多错误码。