API 文档

有奖调研

查询流状态

最近更新时间:2021-09-07 08:06:40

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

返回直播中、无推流或者禁播等状态。
注意:该接口仅提供辅助查询流状态功能,业务重要场景不要强依赖该接口!

使用建议:

  1. 去除将该接口的返回结果作为开播、关播等重要业务场景的依赖。
  2. 如业务需要该状态,可通过推断流事件通知进行存储维护直播间状态。
  3. 自行维护的直播间状态,可通过定时(>1 min)查询直播中的流接口,进行状态校准。
  4. 如使用了流状态查询接口查询到流不活跃,可通过上述多种方案综合判定流状态。
  5. 接口查询时,如发生访问异常或解析异常等,可默认为活跃,减少对业务影响。

默认接口请求频率限制:300次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveStreamState。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
AppName String 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。
DomainName String 您的推流域名。
StreamName String 流名称。

3. 输出参数

参数名称 类型 描述
StreamState String 流状态,
active:活跃,
inactive:非活跃,
forbid:禁播。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamState
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&<公共请求参数>

输出示例

{
  "Response": {
    "StreamState": "active",
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InternalError 内部错误。
InternalError.CallOtherSvrError 调用内部服务错误。
InternalError.ConfigNotExist 配置不存在。
InternalError.GetBizidError 获取用户账号错误。
InternalError.GetStreamInfoError 获取流信息失败。
InternalError.GetUpstreamInfoError 获取直播源信息错误。
InternalError.NotPermmitOperat 无权限操作。
InternalError.StreamStatusError 流状态异常。
InternalError.UpdateDataError 更新数据失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.UserNotExist 用户未注册直播。
目录