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

文档中心

立即注册

导航

查询通道巡航路径V3

最近更新时间：2025.02.14 16:29:36首次发布时间：2025.02.14 16:29:36

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

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetCruiseTrack&Version=2023-10-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCruiseTrack`	接口名称。当前 API 的名称为 `GetCruiseTrack`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。
StreamID	String	是	`23355851-2d31-461c-9e44-968a0afb72f2`	视频流 ID，可通过调用 ListStreams 接口获取
TrackID	Float	是	`4`	巡航组编号，取值范围：[1, 255]

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
DeviceNSID	String	`3402001599118xxxxxx`	设备国标 ID
ChannelID	String	`34020000001310xxxxxx`	设备通道 ID
TrackID	Float	`4`	巡航组编号
TrackList	Object of TrackList	`-`	巡航路径预置位列表，参考以下 TrackList 结构说明
Speed	Float	`200`	巡航速度
StaySeconds	Float	`2`	预置位停留时间，单位：秒

TrackList

参数	类型	示例值	描述
PresetID	Float	`1`	预置位编号
PresetName	String	`预置位1`	预置位名称

请求示例

GET https://open.volcengineapi.com?Action=GetCruiseTrack&Version=2023-10-01&StreamID=23355851-2d31-461c-9e44-968a0afb72f2&TrackID=4

返回示例

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

错误码

您可访问公共错误码，获取更多错误码信息。