查询录像计划通道--慢直播-火山引擎

文档中心

立即注册

导航

查询录像计划通道

最近更新时间：2024.02.29 14:55:33首次发布时间：2023.06.27 11:40:49

查询录像计划通道列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListRecordPlanChannels&Version=2021-01-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRecordPlanChannels`	接口名称。当前 API 的名称为 `ListRecordPlanChannels`。
Version	String	是	`2021-01-01`	接口版本。当前 API 的版本为 `2021-01-01`。
PlanID	String	是	`plan0xxxx`	录像计划 ID。
PageNumber	Integer	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
PageSize	Integer	否	`20`	每页显示的数据条数，默认为 20，最大值为500。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNumber	Integer	`1`	当前所在分页的页码。
PageSize	Integer	`20`	每页显示的数据条数。
TotalCount	Integer	`1`	查询结果的数据总条数。
List	JSON Map	`-`	通道信息，格式为 `"Key":"Value"`，其中： `"Key"`为设备国标 ID。 `"Value"`为流信息，详细信息参见 List。

List

参数	类型	示例值	描述
ChannelID	String	`98880000xxxx0000000`	通道 ID。
DeviceNSID	String	`999114xxxx903407`	设备国标 ID。
PullUrls	Array of String	`["rtmp://example.com/5o4i3xxxxwvky/999xxx407_988xxx000","http://example.com/5o4i3xxxxwvky/999xxx3407_988xxx000.flv","http://example.com/5o4i3xxxxwvky/999xxx407_988xxx000/index.m3u8","http://example.com/5o4i3xxxxwvky/999xxx407_988xxx000.sdp"]`	拉流地址列表。
Resolution	String	`3`	分辨率编码（可参考 GB28181-2022 协议附录G中的定义）。
StreamID	String	`8831c5ac-xxxx-c51cfe16d481`	视频流 ID。
StreamName	String	`999xxx407_988xxx000`	视频流名称。
StreamingIndex	String	`0`	主子码流编号，含义如下。 0：主码流； 1~n：子码流。
StreamingType	String	`main_stream`	通道对应的视频流类型，含义如下。 main_stream：主码流； sub_stream：子码流。

请求示例

GET https://open.volcengineapi.com?Action=ListRecordPlanChannels&Version=2021-01-01&PlanID=plan0xxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "ListRecordPlanChannels",
        "Region": "cn-north-1",
        "RequestId": "202401251427194DBD5F05CB8EF2B1F6AD",
        "Service": "aiotvideo",
        "Version": "2021-01-01"
    },
    "Result": {
        "List": {
            "99911470001180903407": [
                {
                    "ChannelID": "98880000001320000000",
                    "DeviceNSID": "99911470001180903407",
                    "PullUrls": [
                        "rtmp://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000000",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000000.flv",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000000/index.m3u8",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000000.sdp"
                    ],
                    "Resolution": "",
                    "StreamID": "8831c5ac-d078-4ee9-947d-c51cfe16d481",
                    "StreamName": "99911470001180903407_98880000001320000000",
                    "StreamingIndex": "0",
                    "StreamingType": "main_stream"
                },
                {
                    "ChannelID": "98880000001320000002",
                    "DeviceNSID": "99911470001180903407",
                    "PullUrls": [
                        "rtmp://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000002",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000002.flv",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000002/index.m3u8",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99911470001180903407_98880000001320000002.sdp"
                    ],
                    "Resolution": "",
                    "StreamID": "bad30dbf-37f0-4016-9826-6208ab68db7e",
                    "StreamName": "99911470001180903407_98880000001320000002",
                    "StreamingIndex": "0",
                    "StreamingType": "main_stream"
                }
            ],
            "99914790461180940405": [
                {
                    "ChannelID": "98880000001320000000",
                    "DeviceNSID": "99914790461180940405",
                    "PullUrls": [
                        "rtmp://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000000",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000000.flv",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000000/index.m3u8",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000000.sdp"
                    ],
                    "Resolution": "",
                    "StreamID": "0fa8bf39-606a-4863-af2f-22b0695c71b8",
                    "StreamName": "99914790461180940405_98880000001320000000",
                    "StreamingIndex": "0",
                    "StreamingType": "main_stream"
                },
                {
                    "ChannelID": "98880000001320000002",
                    "DeviceNSID": "99914790461180940405",
                    "PullUrls": [
                        "rtmp://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000002",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000002.flv",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000002/index.m3u8",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000002.sdp"
                    ],
                    "Resolution": "",
                    "StreamID": "2796d524-d1c3-4566-a531-3b23c68b61aa",
                    "StreamName": "99914790461180940405_98880000001320000002",
                    "StreamingIndex": "0",
                    "StreamingType": "main_stream"
                },
                {
                    "ChannelID": "98880000001320000001",
                    "DeviceNSID": "99914790461180940405",
                    "PullUrls": [
                        "rtmp://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000001",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000001.flv",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000001/index.m3u8",
                        "http://9t0tqktpqxn4ytp9.fcdn-boe-pull.byted.org/5o4i3mn98ec3wvky/99914790461180940405_98880000001320000001.sdp"
                    ],
                    "Resolution": "",
                    "StreamID": "485e36b0-7187-4e40-8c4a-268d85e6aa29",
                    "StreamName": "99914790461180940405_98880000001320000001",
                    "StreamingIndex": "0",
                    "StreamingType": "main_stream"
                }
            ]
        },
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 5
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。