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

文档中心

立即注册

导航

GetDeviceChannelsV2 - 查看设备通道列表V2

最近更新时间：2025.06.16 17:00:38首次发布时间：2023.06.15 16:26:58

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetDeviceChannelsV2	要执行的操作，取值：GetDeviceChannelsV2。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
SpaceID	String	否	spaceuuidxxxxx	空间ID
DeviceID	String	是	6851c282-c7f6-4a04-90f9-d9c8baxxxxxx	设备 ID，可通过调用 ListDevices 接口获取
QueryMode	String	否	detail	查询模式，查询通道列表模式，可选项： brief：读取缓存的通道列表信息，仅返回部分关键信息，查询速度快 detail：默认，读取实时通道列表信息，返回详细信息，查询速度慢
Order	String	否	1	排序条件，按照GBID排序，-1倒序，1正序，默认正序
ChannelID	String	否	300000101010101xxx	按照通道ID筛选，默认不筛选
ChannelStatus	String	否	ON	按照通道状态筛选，可选ON、OFF或者空，默认不筛选

返回参数

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

参数	类型	示例值	描述
DeviceName	String	SH-HK-IPC01	设备名称
DeviceID	String	6851c282-c7f6-4a04-90f9-d9c8baxxxxxx	设备ID
DeviceNSID	String	34020033991320xxxxxx	设备国标 ID
Channels	Array of Object		查询到的设备通道列表，参考以下 `List<DeviceItemWithStream>` 结构说明

请求示例

GET https://open.volcengineapi.com?Action=GetDeviceChannelsV2&Version=2021-01-01&DeviceID=6851c282-c7f6-4a04-90f9-d9c8baxxxxxx&QueryMode=

返回示例

{
  "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.3,
          "Latitude": 33.55,
          "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"
        ]
      }
    ]
  }
}

错误码

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