查询直播流监播任务

最近更新时间:2024-03-12 01:38:42

我的收藏

1. 接口描述

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

该接口用来查询某个特定监播任务的配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveStreamMonitor。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
MonitorId String 监播任务ID。
示例值:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

3. 输出参数

参数名称 类型 描述
LiveStreamMonitor LiveStreamMonitorInfo 直播监播任务相关信息。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询某个监播任务配置

查询某个监播场次,返回该场次的基本配置信息。

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveStreamMonitor
<公共请求参数>

{
    "MonitorId": "1bd5af00-5be5-4e4d-aa75-340ba0f35586"
}

输出示例

{
    "Response": {
        "LiveStreamMonitor": {
            "MonitorId": "1bd5af00-5be5-4e4d-aa75-340ba0f35586",
            "MonitorName": "example_monitor_name",
            "OutputInfo": {
                "OutputStreamName": "example_output_stream_name",
                "OutputStreamWidth": 1920,
                "OutputStreamHeight": 1080,
                "OutputDomain": "",
                "OutputApp": ""
            },
            "InputList": [
                {
                    "InputStreamName": "example_stream_name",
                    "InputDomain": "",
                    "InputApp": "",
                    "InputUrl": "",
                    "Description": ""
                }
            ],
            "Status": 1,
            "CreateTime": 1640694582,
            "UpdateTime": 1640591812,
            "NotifyPolicy": {
                "NotifyPolicyType": 1,
                "CallbackUrl": "xx"
            },
            "AudibleInputIndexList": [
                1
            ],
            "AiAsrInputIndexList": [
                1
            ],
            "CheckStreamBroken": 1,
            "CheckStreamLowFrameRate": 1,
            "AsrLanguage": 1,
            "OcrLanguage": 1
        },
        "RequestId": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.ConflictAction 任务接口执行冲突。
FailedOperation.DatabaseNotAccessible 数据库访问异常。
FailedOperation.MonitorIsActive 监播任务处于启动状态。
FailedOperation.MonitorLimitExceeded 监播任务超出限制。
FailedOperation.MonitorNotExist 监播任务不存在。
FailedOperation.StartTaskFailed 启动监播任务失败。
FailedOperation.StopTaskFailed 停止监播任务失败。
InvalidParameter 参数错误。
InvalidParameter.NotAllowUseLVB 该APPID未开通LVB服务。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。