云直播查询直播流监播任务配置列表-API 文档-文档中心-腾讯云

1. 接口描述

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

该接口用来查询直播流监播任务配置的列表信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLiveStreamMonitorList。
Version	是	String	公共参数，本接口取值：2018-08-01。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
Index	是	Integer	查询列表时的起始偏移。示例值：0
Count	是	Integer	本次查询的记录个数。最小值为1。示例值：1

3. 输出参数

参数名称	类型	描述
TotalNum	Integer	账号下的直播流监播任务个数。注意：此字段可能返回 null，表示取不到有效值。示例值：7
LiveStreamMonitors	Array of LiveStreamMonitorInfo	直播流监播任务列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询所有的直播流监播任务

返回所有监播场次列表，包含各监播场次的基本信息

输入示例

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

{
    "Index": 0,
    "Count": 1
}

输出示例

{
    "Response": {
        "LiveStreamMonitors": [
            {
                "MonitorId": "1bd5af00-5be5-4e4d-aa75-340ba0f35586",
                "MonitorName": "",
                "OutputInfo": {
                    "OutputStreamName": "example_output_stream_name",
                    "OutputStreamWidth": 1920,
                    "OutputStreamHeight": 1080,
                    "OutputDomain": "",
                    "OutputApp": ""
                },
                "Status": 1,
                "StartTime": 1640694582,
                "StopTime": 1640591812,
                "InputList": [
                    {
                        "InputStreamName": "example_stream_name",
                        "Description": "",
                        "InputDomain": "",
                        "InputApp": "",
                        "InputUrl": ""
                    }
                ]
            }
        ],
        "TotalNum": 7,
        "RequestId": "3f3fd3ae-23a1-44dc-94d6-35380052b4f4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DatabaseNotAccessible	数据库访问异常。
InvalidParameter.NotAllowUseLVB	该APPID未开通LVB服务。
ResourceNotFound.ForbidService	用户被禁用。
ResourceNotFound.FreezeService	用户服务被冻结。
ResourceNotFound.StopService	账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService	用户主动停服。

查询直播流监播任务配置列表

本页目录：