查询通道巡航路径--慢直播-火山引擎

文档中心

立即注册

导航

查询通道巡航路径

最近更新时间：2023.07.20 09:51:03首次发布时间：2023.07.20 09:51:03

查询指定通道巡航路径的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetCruiseTrack
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
DeviceNSID	Query	String	是	设备国标 ID	可通过调用 ListDevices 接口获取
ChannelID	Query	String	是	设备通道 ID	可通过调用 ListStreams 接口获取
TrackID	Query	Number	是	巡航组编号	取值范围：[1, 255]

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
DeviceNSID	String	设备国标 ID
ChannelID	String	设备通道 ID
TrackID	Number	巡航组编号
TrackList	Array of Objects	巡航路径预置位列表，参考以下 TrackList 结构说明
Speed	Numbe	巡航速度
StaySeconds	Number	预置位停留时间，单位：秒

TrackList 结构说明

字段	类型	说明
PresetID	Number	预置位编号
PresetName	String	预置位名称

示例

请求示例

GET https://open.volcengineapi.com?Action=GetCruiseTrack
&Version=2021-01-01
&DeviceNSID=34020047991180xxxxxx
&ChannelID=34020035991320xxxxxx
&TrackID=4
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022072914223101017424420209EE53C9",
        "Action": "GetCruiseTrack",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "DeviceNSID": "3402001599118xxxxxx",
        "ChannelID": "34020000001310xxxxxx",
        "TrackID": 4,
        "TrackList": [
            {
                "PresetID": 1,
                "PresetName": "预置位1"
            }
        ],
        "StaySeconds": 2,
        "Speed": 200
    }
}