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

获取虚拟组织树节点

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

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

获取指定空间下所有虚拟组织树节点的信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

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

Version

Query

String

公共参数,OpenAPI 接口版本

2021-01-01

SpaceID

Query

String

空间 ID

可通过调用 ListSpaces 接口获取

Order

Query

Integer

查询结果排序方式

可选枚举值:

  • 1(正序)

  • -1(倒序,默认)

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
NodesArray of objects查询到的节点列表,参考以下 List<Nodes> 数据结构说明

List<Nodes> 数据结构说明

字段
类型
说明
IDString节点唯一标识
NameString节点名称
NSIDString分配的国标 ID
DescriptionString节点描述
SharedBoolean节点是否属于级联任务共享节点
SpaceIDString空间 ID
SpaceNameString空间名称
RegionString接入地点
ParentIDString父节点ID,根节点为空
NodesArray of objects子节点列表
DeviceObjects节点绑定的设备信息,参考以下 设备信息结构说明

设备信息结构说明

字段
类型
说明
IDString设备唯一标识

Type

String

设备类型:

  • IPC

  • NVR

  • Platform

DeviceNameString设备名称
DescriptionString设备描述
StatusString设备状态
DeviceNSIDString设备国标 ID
ProtocolString设备协议类型
VendorString设备厂商
ChannelsArray of objects设备通道信息列表,参考以下 List<Channels> 数据结构说明
AvailableBoolean是否可以添加

List<Channels> 数据结构说明

字段
类型
说明
IDString通道唯一标识
SipIDString通道 Sip ID
StreamNameString通道名称
DeviceIDString设备 ID
StatusString通道状态
DescriptionString通道描述
AvailableBoolean是否可以添加

示例

请求示例

GET https://open.volcengineapi.com?Action=ListGroupTreeNodes
&Version=2021-01-01
&SpaceID=9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022100916271901022508219901221152",
        "Action": "ListGroupTreeNodes",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Nodes": [
            {
                "ID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                "Name": "test1",
                "NSID": "110108004921xxxxxxxx",
                "Description": "",
                "Shared": false,
                "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                "SpaceName": "edge-gateway",
                "Region": "",
                "ParentID": "",
                "Nodes": [
                    {
                        "ID": "856ea30f-c782-4b70-ab5f-54580fxxxxxx",
                        "Name": "1",
                        "NSID": "110108004913xxxxxxxx",
                        "Description": "",
                        "Shared": false,
                        "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                        "SpaceName": "edge-gateway",
                        "Region": "",
                        "ParentID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                        "Nodes": [
                            {
                                "ID": "ac6ff86a-372d-48fe-a382-1e49e7xxxxxx",
                                "Name": "2",
                                "NSID": "110108004913xxxxxxxx",
                                "Description": "",
                                "Shared": false,
                                "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                                "SpaceName": "edge-gateway",
                                "Region": "",
                                "ParentID": "856ea30f-c782-4b70-ab5f-54580fxxxxxx",
                                "Nodes": null,
                                "Device": null
                            },
                            {
                                "ID": "e7103bdc-6a4e-41bc-9c7f-5f47d7xxxxxx",
                                "Name": "2",
                                "NSID": "110108004913xxxxxxxx",
                                "Description": "",
                                "Shared": false,
                                "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                                "SpaceName": "edge-gateway",
                                "Region": "",
                                "ParentID": "856ea30f-c782-4b70-ab5f-54580fxxxxxx",
                                "Nodes": null,
                                "Device": {
                                    "ID": "86ed737b-1203-463f-a943-b3d6b5xxxxxx",
                                    "Type": "IPC",
                                    "DeviceName": "shhk",
                                    "Description": "",
                                    "Status": "offline",
                                    "DeviceNSID": "34020098991320xxxxxx",
                                    "Protocol": "gb28181",
                                    "Vendor": "",
                                    "Channels": [
                                        {
                                            "ID": "ab9e0a7d-fcb9-41bb-a227-23f809xxxxxx",
                                            "SipID": "34020098991320xxxxxx",
                                            "StreamName": "34020098991320xxxxxx_34020035991320xxxxxx",
                                            "DeviceID": "86ed737b-1203-463f-a943-b3d6b5xxxxxx",
                                            "Status": "failed",
                                            "Description": "channel: 34020035991320xxxxxx@device: 340200989913207xxxxxx",
                                            "Available": false
                                        }
                                    ],
                                    "Available": false
                                }
                            },
                            {
                                "ID": "5b68c0ba-77a8-46bf-adc8-d064caxxxxxx",
                                "Name": "2",
                                "NSID": "110108004913xxxxxxxx",
                                "Description": "",
                                "Shared": false,
                                "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                                "SpaceName": "edge-gateway",
                                "Region": "",
                                "ParentID": "856ea30f-c782-4b70-ab5f-54580fxxxxxx",
                                "Nodes": null,
                                "Device": {
                                    "ID": "145c43db-5355-4cbe-89eb-23744dxxxxxx",
                                    "Type": "IPC",
                                    "DeviceName": "测试设备",
                                    "Description": "",
                                    "Status": "online",
                                    "DeviceNSID": "34020013991320xxxxxx",
                                    "Protocol": "gb28181",
                                    "Vendor": "",
                                    "Channels": [
                                        {
                                            "ID": "37b287c8-b7d5-44a9-b705-d6db77xxxxxx",
                                            "SipID": "34020013991320xxxxxx",
                                            "StreamName": "34020013991320xxxxxx_media_channel_0",
                                            "DeviceID": "145c43db-5355-4cbe-89eb-23744dxxxxxx",
                                            "Status": "failed",
                                            "Description": "channel: media_channel_0@device: 340200139913206xxxxxx",
                                            "Available": false
                                        }
                                    ],
                                    "Available": false
                                }
                            }
                        ],
                        "Device": null
                    },
                    {
                        "ID": "f9d59848-e503-4075-9b0d-970d36xxxxxx",
                        "Name": "1",
                        "NSID": "110108004913xxxxxxxx",
                        "Description": "",
                        "Shared": false,
                        "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                        "SpaceName": "edge-gateway",
                        "Region": "",
                        "ParentID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                        "Nodes": null,
                        "Device": null
                    }
                ],
                "Device": null
            }
        ],
        "PageNumber": 10,
        "PageSize": 1,
        "TotalCount": 1
    }
}