获取共享节点信息--慢直播-火山引擎

文档中心

立即注册

导航

获取共享节点信息

最近更新时间：2022.11.01 17:47:37首次发布时间：2022.11.01 17:47:37

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

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetGroupNodesByCascadeTask
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
TaskID	Query	String	是	级联任务 ID	可通过调用 ListCascadeTask 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	节点唯一标识
Name	String	节点名称
NSID	String	分配的国标 ID
Description	String	节点描述
Shared	Boolean	节点是否属于级联任务共享节点
SpaceID	String	空间 ID
SpaceName	String	空间名称
Region	String	接入地点
ParentID	String	父节点 ID，根节点为空
Nodes	Array of objects	子节点列表
Device	Objects	节点绑定的设备信息，参考以下设备信息结构说明

设备信息结构说明

字段	类型	说明
ID	String	设备唯一标识
Type	String	设备类型： IPC NVR Platform
DeviceName	String	设备名称
Description	String	设备描述
Status	String	设备状态
DeviceNSID	String	设备国标 ID
Protocol	String	设备协议类型
Vendor	String	设备厂商
Channels	Array of objects	设备通道信息列表，参考以下 `List<Channels>` 数据结构说明
Available	Boolean	是否可以添加

List<Channels> 数据结构说明

字段	类型	说明
ID	String	通道唯一标识
SipID	String	通道 Sip ID
StreamName	String	通道名称
DeviceID	String	设备 ID
Status	String	通道状态
Description	String	通道描述
Available	Boolean	是否可以添加

示例

请求示例

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
    }
}