查看设备通道列表V2--慢直播-火山引擎

导航

查看设备通道列表V2

最近更新时间：2023.08.11 11:41:07首次发布时间：2023.06.15 16:26:58

查询指定设备的通道列表。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetDeviceChannelsV2
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
DeviceID	Query	String	是	设备 ID	可通过调用 ListDevices 接口获取
QueryMode	Query	String	否	查询模式	查询通道列表模式，可选项： brief：读取缓存的通道列表信息，仅返回部分关键信息，查询速度快 detail：默认，读取实时通道列表信息，返回详细信息，查询速度慢

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
DeviceName	String	设备名称
DeviceID	String	设备ID
DeviceNSID	String	设备国标 ID
Channels	Array of objects	查询到的设备通道列表，参考以下 `List<DeviceItemWithStream>` 结构说明

`List<DeviceItemWithStream>` 结构说明

字段	类型	说明
StreamID	String	通道对应的视频流 ID
CreateAt	String	通道创建时间
SubStreams	String[]	子码流列表，数组下标为子码流序号
DeviceItem	List	设备信息，参考以下 DeviceItem 结构说明

DeviceItem 结构说明

字段	类型	说明
ChannelID	String	通道国标 ID
Name	String	通道名称
Manufacturer	String	通道设备厂家
Model	String	通道设备型号
CivilCode	String	行政区域
Parental	String	通道是否有下级通道子设备： 1：有 0：没有
ParentID	String	父级国标 ID
RegisterWay	String	注册方式： 1：IETF RFC3261（默认） 2：基于口令的双向认证 3：基于数字证书的双向认证
Secrecy	String	保密属性： 0：不涉密（默认） 1：涉密
IPAddress	String	设备 IP 地址
Port	Integer	设备端口
Status	String	通道在线状态： ON：在线 OFF：离线
Longitude	Float	经度
Latitude	Float	纬度
PTZType	Integer	通道设备云台类型： 0：未知 1：球机 2：半球 3：固定枪机 4：遥控枪机
DownloadSpeed	String	通道设备支持的下载倍速列表： 1 2 4 8
Resolution	String	通道支持的分辨率列表： 1（QCIF - 176x144） 2（CIF - 320x288) 3（4CIF - 704x576) 4（D1 - 720x576) 5（720p) 6（1080p/i) 其他（自定义宽高，如19201080等，需设备支持）

示例

请求示例

GET https://open.volcengineapi.com?Action=GetDeviceChannelsV2
&Version=2021-01-01
&DeviceID=6851c282-c7f6-4a04-90f9-d9c8baxxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081436130102120352160401A250",
        "Action": "GetDeviceChannelsV2",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "DeviceName": "SH-HK-IPC01",
        "DeviceID": "6851c282-c7f6-4a04-90f9-d9c8baxxxxxx",
        "DeviceNSID": "34020033991320xxxxxx",
        "Channels": [
            {
                "DeviceItem": {
                  "ChannelID": "988800xxxxxx20000000",
                  "Name": "988800xxxxxx20000000",
                  "Manufacturer": "ABC",
                  "Model": "Camera",
                  "CivilCode": "3402",
                  "Parental": "0",
                  "ParentID": "34020069991180xxxxxx",
                  "RegisterWay": "1",
                  "Secrecy": "0",
                  "IPAddress": "xx.xx.xxx.xxx",
                  "Port": 8883,
                  "Status": "ON",
                  "Longitude": 65.300,
                  "Latitude": 33.550,
                  "PTZType": 3,
                  "DownloadSpeed": "1/2/4/8",
                  "Resolution": "6"
                },
                "StreamID": "7572b1d1-d92c-4023-b2cc-59b5bfxxxxxx",
                "CreateAt": "2023-04-11T17:15:12+08:00",
                "SubStreams": [
                  "516bcfaa-9075-4007-85a4-ebd543xxxxxx",
                  "516bcfaa-9075-4007-85a4-ebd543xxxxxx",
                  "516bcfaa-9075-4007-85a4-ebd543xxxxxx",
                ]
            },
        ]
    }
}

慢直播