You need to enable JavaScript to run this app.
导航

根据节点获取设备列表

最近更新时间2022.10.31 15:45:33

首次发布时间2022.10.31 15:45:33

获取指定节点的绑定的设备列表信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetDevicesByGroupTreeNode

Version

Query

String

公共参数,OpenAPI 接口版本

2021-01-01

SpaceIDQueryString空间 ID可通过调用 ListSpaces 接口获取

NodeID

Query

String

节点 ID

可通过调用 ListGroupTreeNodes 接口获取

SearchName

Query

String

搜索设备名称,如不指定,则查询节点绑定的所有设备信息

支持模糊查询

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
DataArray of objects查询到的设备列表,参考以下 List<Devices> 数据结构说明

List<Devices> 数据结构说明

字段
类型
说明
IDString设备 ID

Type

String

设备类型:

  • IPC

  • NVR

DeviceNameString设备名称
DescriptionString设备描述
DeviceNSIDString设备国标 ID

Status

String

设备状态:

  • online

  • offline

  • unregisterd

  • invalid_password

ProtocolString接入协议
VendorString设备制造商
AvailableBoolean是否可以添加
ChannelsArray of objects视频流信息,参考以下 List<Channels> 数据结构说明

List<Channels> 数据结构说明

字段
类型
说明
IDString视频流 ID
SipIDStringSIP 服务器 ID
StreamNameString视频流名称
DeviceIDString视频流所属设备 ID

Status

String

视频流状态:

  • online:在线

  • offline:离线

  • failed:失败

  • pulling:拉流中

DescriptionString视频流描述
AvailableBoolean是否可以添加

示例

请求示例

GET https://open.volcengineapi.com?Action=GetDevicesByGroupTreeNode
&Version=2021-01-01
&SpaceID=9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx
&NodeID=0a2a9712-1795-4d4f-a924-577fecxxxxxx
&SearchName=002
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221017113239010174249148046BC75F",
        "Action": "GetDevicesByGroupTreeNode",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "ID": "764de6a7-e814-494f-86c2-089ee9xxxxxx",
                "Type": "IPC",
                "DeviceName": "34020025991320xxxxxx",
                "Description": "",
                "Status": "offline",
                "DeviceNSID": "34020025991320xxxxxx",
                "Protocol": "gb28181",
                "Vendor": "",
                "Channels": [
                    {
                        "ID": "20851f36-03be-4d9d-9c3f-9351c2xxxxxx",
                        "SipID": "3402000000xxxxxxxxxx",
                        "StreamName": "34020025991320xxxxxx_34020025991320xxxxxx",
                        "DeviceID": "764de6a7-e814-494f-86c2-089ee9xxxxxx",
                        "Status": "stopped",
                        "Description": "channel: 34020025991320xxxxxx@device: 34020025991320xxxxxx",
                        "Available": true
                    }
                ],
                "Available": true
            },
            {
                "ID": "190ffc6b-e76c-4707-a6ef-a7eef1xxxxxx",
                "Type": "IPC",
                "DeviceName": "002moniq",
                "Description": "",
                "Status": "offline",
                "DeviceNSID": "34020052991320xxxxxx",
                "Protocol": "gb28181",
                "Vendor": "",
                "Channels": [
                    {
                        "ID": "da7a98d5-fab9-4dd6-a8da-2d17e7xxxxxx",
                        "SipID": "3402000000xxxxxxxxxx",
                        "StreamName": "34020052991320xxxxxx_media_channel_0",
                        "DeviceID": "190ffc6b-e76c-4707-a6ef-a7eef1xxxxxx",
                        "Status": "stopped",
                        "Description": "channel: media_channel_0@device: 34020052991320xxxxxx",
                        "Available": true
                    }
                ],
                "Available": true
            }
        ],
        "PageNumber": 10,
        "PageSize": 0,
        "TotalCount": 1
    }
}