调用DescribeChannelOverallData查询频道概览数据。
使用说明
本接口用于查询频道概览数据。例如:您可以查询通信基本信息、指标趋势图等信息。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /api/channel/describeChannelOverallData HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
AppId | String | Query | 是 | 9qb1**** |
App ID,可通过控制台创建和查询。 |
ChannelId | String | Query | 是 | 123333 |
频道ID。 |
CreatedTs | Long | Query | 是 | 1615893133 |
创建频道的时间戳,支持查询最近30天的数据。使用UNIX时间戳表示,单位:秒。 |
DestroyedTs | Long | Query | 否 | 1615893757 |
释放频道的时间戳,使用UNIX时间戳表示,单位:秒。参数为空表示获取当前时间。 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
|
返回数据
示例
请求示例
POST api/channel/describeChannelOverallData?AppId=9qb1****&ChannelId=123333&CreatedTs=1615893133&DestroyedTs=1615893757 HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com
Date: GMT Date
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeChannelOverallDataResponse>
<code>200</code>
<data>
<RequestId>C9F1EB03-1B7E-4115-ABFA-CB945B2348E7</RequestId>
<OverallData>
<ConnAvgTime>0.10325</ConnAvgTime>
<FiveSecJoinRate>1</FiveSecJoinRate>
</OverallData>
<MetricDatas>
<Type>CONN_NUM</Type>
<Nodes>
<Ext>
<num>4</num>
</Ext>
<X>WITHIN_FIVE</X>
<Y>1.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>FIVE_TO_TEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>TEN_TO_FIFTEEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>ABOVE_FIFTEEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>CONN_FAIL</X>
<Y>0.0000</Y>
</Nodes>
</MetricDatas>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>C9F1EB03-1B7E-4115-ABFA-CB945B2348E7</requestId>
<successResponse>true</successResponse>
</DescribeChannelOverallDataResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200",
"data" : {
"RequestId" : "C9F1EB03-1B7E-4115-ABFA-CB945B2348E7",
"OverallData" : {
"ConnAvgTime" : 0.10325,
"FiveSecJoinRate" : 1.0
},
"MetricDatas" : [ {
"Type" : "CONN_NUM",
"Nodes" : [ {
"Ext" : {
"num" : 4
},
"X" : "WITHIN_FIVE",
"Y" : "1.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "FIVE_TO_TEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "TEN_TO_FIFTEEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "ABOVE_FIFTEEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "CONN_FAIL",
"Y" : "0.0000"
} ]
} ]
},
"httpStatusCode" : "200",
"requestId" : "C9F1EB03-1B7E-4115-ABFA-CB945B2348E7",
"successResponse" : true
}