全部产品
Search
文档中心

视频直播:DescribeLiveGrtnDuration - 查询连麦通话时长用量数据

更新时间:Dec 05, 2024

调用DescribeLiveGrtnDuration查询连麦通话时长用量数据。

接口说明

  • 最大查询跨度:31 天。
  • 最小查询粒度:5 分钟。
  • 最大查询范围:最近 90 天的数据。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveGrtnDuration
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
StartTimestring

获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2022-10-10T20:00:00Z
EndTimestring

结束时间需大于起始时间,查询粒度≥5 分钟且≤31 天;日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2022-10-10T21:00:00Z
AppIdstring

应用 ID,支持查询多个应用 ID,多个 ID 用逗号(半角)分隔,最多可查询 30 个 ID。默认返回所有应用合并后的数据。

4346289a-a790-4869-9e23-22766d5e****
Areastring

区域代号。支持:

  • CN:中国内地。
  • OverSeas:海外大区。
  • AP1:亚太 1 区,包含中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。
  • AP2:亚太 2 区,包含印尼、韩国、越南。
  • AP3:亚太 3 区,包含澳大利亚、新西兰。
  • NA:北美,包含美国、加拿大。
  • SA:南美,特指巴西。
  • EU:欧洲,包含乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。
  • MEAA:中东非洲,包含南非、阿曼、阿联酋、科威特。

不传值时默认为所有区域数据聚合输出。

CN
Intervalstring

查询数据的时间粒度。单位:秒。取值:

  • 300
  • 3600
  • 86400

不传或传值不支持时,使用默认值 3600 秒。

3600

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

该条任务请求 ID。

4B460F8B-993C-4F48-B98A-910811DEBFEB
StreamDetailDataarray<object>

连麦用量数据明细。

StreamDataobject

连麦用量数据明细。

AppIdstring

应用 ID。

4346289a-a790-4869-9e23-22766d5e****
Durationlong

连麦时长,单位:分钟。

30
MediaProfilestring

媒体规格,取值:

  • 0:纯音频时长,基础规格。
  • 480P:标清时长,视频分辨率为 640×480 及以下。
  • 720P:高清时长,视频分辨率为 1280×720 及以下。
  • 1080P:全高清时长,视频分辨率为 1920×1080 及以下。
480P
MediaTypestring

媒体类型,取值:

  • audio:音频。
  • video:视频。
audio
TimeStampstring

时间片起始时刻。

2022-12-10T20:00:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppId": "4346289a-a790-4869-9e23-22766d5e****",
        "Duration": 30,
        "MediaProfile": "480P",
        "MediaType": "audio",
        "TimeStamp": "2022-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误,请您确认结束时间是否正确。
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.-
400InvalidAreaParameterThe specified Area parameter is invalid.Area参数不正确,需要传入正确的大区简写。
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配,请您确认时间的匹配度。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400InvalidAppIdParameterThe specified AppId parameter is invalid.-
400InvalidInstanceIdParameterThe specified InstanceId parameter is invalid.-
400InvalidTime.ValueNotSupportedSpecified Time is malformed.指定的时间无效。

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

变更历史

变更时间变更内容概要操作
暂无变更历史

特殊错误码

错误代码描述HTTP 状态码语义
ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
IllegalOperationIllegal domain, operation is not permitted.403非法域名,无法操作。
OperationDeniedYour account does not open LIVE service yet.403未开通 LIVE 服务。
OperationDeniedYour LIVE service is suspended.403LIVE 服务已被停止。
InvalidStartTime.MalformedSpecified StartTime is malformed.400参数错误。
InvalidEndTime.MalformedSpecified EndTime is malformed.400时间格式错误。
InvalidTime.MalformedSpecified StartTime or EndTime is malformed.400开始时间或结束时间格式错误。
InvalidEndTime.MismatchSpecified end time does not math the specified start time.400开始时间和结束时间不匹配。
InvalidTimeSpanThe time span exceeds the limit.400查询跨度错误。
InvalidAppIdParameterThe specified AppId parameter is invalid.400AppID 参数错误。
InvalidParameterIntervalInvalid Parameter Interval.400Interval 参数错误。