You need to enable JavaScript to run this app.
导航
慢直播
  • 文档首页
    • /
  • 慢直播

获取共享节点信息

最近更新时间：2022.11.01 17:47:37

首次发布时间：2022.11.01 17:47:37

我的收藏

查询指定级联任务的共享节点信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称GetGroupNodesByCascadeTask

Version

Query

String

是

公共参数，OpenAPI 接口版本

2021-01-01

TaskID

Query

String

是

级联任务 ID

可通过调用 ListCascadeTask 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段
类型
说明
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=GetGroupNodesByCascadeTask
&Version=2021-01-01
&TaskID=35
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221018151653010174249148033A80A8",
        "Action": "GetGroupNodesByCascadeTask",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
        "Name": "test1",
        "NSID": "110108004921xxxxxxxx",
        "Description": "",
        "Shared": true,
        "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
        "SpaceName": "edge-gateway",
        "Region": "",
        "ParentID": "",
        "Nodes": [
            {
                "ID": "856ea30f-c782-4b70-ab5f-54580xxxxxx",
                "Name": "1",
                "NSID": "110108004913xxxxxxxx",
                "Description": "",
                "Shared": true,
                "SpaceID": "9f84d4ff-bdee-4105-a8ae-f2a3cfxxxxxx",
                "SpaceName": "edge-gateway",
                "Region": "",
                "ParentID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                "Nodes": [
                    {
                        "ID": "e7103bdc-6a4e-41bc-9c7f-5f47d7xxxxxx",
                        "Name": "2",
                        "NSID": "110108004913xxxxxxxx",
                        "Description": "",
                        "Shared": true,
                        "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: 3402003599132xxxxxx@device: 3402009899132xxxxxx",
                                    "Available": false
                                }
                            ],
                            "Available": false
                        }
                    }
                ],
                "Device": null
            }
        ],
        "Device": null
    }
}