首页 视频直播 开发参考 API参考(新) API目录 监控统计 DescribeLiveDomainPublishErrorCode - 查询域名推流状态码

DescribeLiveDomainPublishErrorCode - 查询域名推流状态码

更新时间: 2024-12-24 14:35:52

查询推流域名下某个时间段内的推流状态码。

接口说明

  • 本接口为监控数据接口,数据采集处理方式不同于计费,不能用于计算用量进行对账参考。
  • 最多可获取最近 90 天的数据。
  • 接口数据延时在 3-5 分钟。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

推流域名,允许传入多个推流域名,多个域名之间用英文逗号(,)分隔。

说明 该参数为必填参数。
example1.aliyundoc.com,example2.aliyundoc.com
AppNamestring

按照 AppName 进行过滤汇聚,若指定了 AppName,则 DomainName 必须指定一个特定的推流域名。

AppName
StartTimestring

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 不写默认查询过去 1 小时的数据。
2016-06-29T09:00:00Z
EndTimestring

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 不写默认查询过去 1 小时的数据。
2016-06-29T09:10:00Z

返回参数

名称类型描述示例值
object

Schema of Response

DataIntervalstring

查询数据的时间粒度,单位是秒。默认值为 60。

60
DomainNamestring

推流域名。

example1.aliyundoc.com,example2.aliyundoc.com
EndTimestring

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-06-29T09:10:00Z
RealTimeCodeDataarray<object>

每个时间间隔的错误码占比数据。

rtcdobject

每个时间间隔的错误码占比数据。

CodeDataarray<object>

各返回码占比使用数据列表。

cdobject

各返回码占比使用数据列表。

Codestring

响应码。响应码取值:

  • 3:读数据超时 。
  • 4:写数据错误 。
  • 6:写数据超时 。
  • 200:成功。
  • 500:内部系统未知错误 。
  • 501:推流异常。
  • 502:信令耗时过长 。
  • 401:推流参数异常 。
  • 403:推流鉴权失败。
200
Countstring

响应数量。

20
Proportionstring

响应数量占比。

66.04
TimeStampstring

时间片起始时刻。

2016-06-29T09:01:00Z
RequestIdstring

请求 ID。

BC858082-736F-4A25-867B-E5B67C******
StartTimestring

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-06-29T09:00:00Z

示例

正常返回示例

JSON格式

{
  "DataInterval": "60",
  "DomainName": "example1.aliyundoc.com,example2.aliyundoc.com",
  "EndTime": "2016-06-29T09:10:00Z",
  "RealTimeCodeData": [
    {
      "CodeData": [
        {
          "Code": "200",
          "Count": "20",
          "Proportion": "66.04"
        }
      ],
      "TimeStamp": "2016-06-29T09:01:00Z"
    }
  ],
  "RequestId": "BC858082-736F-4A25-867B-E5B67C******",
  "StartTime": "2016-06-29T09:00:00Z"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DescribeLiveStreamPushMetricDetailData - 查询指定域名推流流粒度批量数据 下一篇: DescribeLiveUpVideoAudioInfo - 获取直播视频音频信息
阿里云首页 视频直播 相关技术圈