You need to enable JavaScript to run this app.
导航
查询轮播任务列表
最近更新时间:2023.05.22 16:16:31首次发布时间:2023.05.22 16:16:31

查询已创建的轮播任务列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明

Action

Query

String

公共参数,OpenAPI 接口名称

ListStreamPollingTasks

Version

Query

String

公共参数,OpenAPI 接口版本

2021-01-01

TaskIDQueryString筛选条件,轮播任务 ID支持模糊搜索

TaskName

Query

String

筛选条件,轮播任务名称

支持模糊搜索

Order

Query

Integer

查询结果排序方式

可选枚举值:

  • 1(正序)

  • -1(倒序,默认)

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
StreamsArray of tasks查询到的轮播任务列表,参考以下 轮播任务数据结构说明

轮播任务数据结构说明

字段
类型
说明
TaskIDString轮播任务 ID
TaskNameString轮播任务名称
TimeIntervalInt轮播时间间隔
WindowCountInt分屏窗口数量
CreateAtString轮播任务创建时间
UpdateAtString轮播任务更新时间
StreamsArray of streams轮播任务绑定通道,参考以下 通道信息结构说明

通道信息结构说明

字段
类型
说明
StreamNameString视频流名称
StreamIDString视频流 ID
SpaceNameString视频流所属空间名称
SpaceIDString视频流所属空间 ID
SpaceTypeString视频流所属空间类型
DeviceIDString视频流所属设备 ID
DeviceNameString视频流所属设备名称
DeviceNSIDString视频流所属设备国标 ID
ChannelIDString通道 ID
StatusString视频流状态

示例

请求示例

GET https://open.volcengineapi.com?Action=ListStreamPollingTasks
&Version=2021-01-01
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305181042347771954969EB320F1B5A",
        "Action": "ListStreamPollingTasks",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "Streams": [
            {
                "TaskID": "0674745f-acbe-473a-9245-8cdcefxxxxxx",
                "TaskName": "even6",
                "TimeInterval": 30,
                "WindowCount": 1,
                "CreateAt": "2023-05-17T17:59:57+08:00",
                "UpdateAt": "2023-05-17T18:00:52+08:00",
                "Streams": [
                    {
                        "StreamName": "34020024991320xxxxxx_98880000001xxxxxxxxx",
                        "StreamID": "13edb5df-aeb5-4bc9-a98a-9a3c5exxxxxx",
                        "SpaceName": "zh",
                        "SpaceID": "bea0430a-6c58-4a4c-bc4c-ad2d21xxxxxx",
                        "SpaceType": "gb28181",
                        "DeviceID": "6a31012f-ad68-4fbc-a43c-aa5fbaxxxxxx",
                        "DeviceName": "record-xxxx-device2-0",
                        "DeviceNSID": "34020024991320xxxxxx",
                        "ChannelID": "98880000001xxxxxxxxx",
                        "Status": "online"
                    },
                    {
                        "StreamName": "34020019991320xxxxxx_98880000001xxxxxxxxx",
                        "StreamID": "e10ff636-04d7-4a89-95aa-c94af5xxxxxx",
                        "SpaceName": "even-gb",
                        "SpaceID": "c3e19f72-8b9a-4c8c-a821-ae9b9fxxxxxx",
                        "SpaceType": "gb28181",
                        "DeviceID": "81026690-b2a1-4d1e-b2bc-e8e24dxxxxxx",
                        "DeviceName": "snapshot-xxxx",
                        "DeviceNSID": "34020019991320xxxxxx",
                        "ChannelID": "98880000001xxxxxxxxx",
                        "Status": "online"
                    }
                ]
            },
            {
                "TaskID": "30b2e5fe-3b02-4c9e-a9e2-d58405xxxxxx",
                "TaskName": "轮巡任务",
                "TimeInterval": 30,
                "WindowCount": 1,
                "CreateAt": "2023-04-11T19:43:44+08:00",
                "UpdateAt": "2023-04-17T11:11:29+08:00",
                "Streams": [
                    {
                        "StreamName": "34020084991320xxxxxx_98880000001xxxxxxxxx",
                        "StreamID": "e703da23-c463-44ae-bdad-ac5edfxxxxxx",
                        "SpaceName": "my-xxxx-space",
                        "SpaceID": "762da236-91dc-49cd-b63b-da3xxxxxx",
                        "SpaceType": "gb28181",
                        "DeviceID": "211a1ed7-f4a7-4a1c-9138-c5896bxxxxxx",
                        "DeviceName": "d20",
                        "DeviceNSID": "34020084991320xxxxxx",
                        "ChannelID": "98880000001xxxxxxxxx",
                        "Status": "no_forward"
                    },
                    {
                        "StreamName": "34020022991320xxxxxx_98880000001xxxxxxxxx",
                        "StreamID": "8ddc6257-ffa5-453b-9a5a-91b5b1xxxxxx",
                        "SpaceName": "my-xxxx-space",
                        "SpaceID": "762da236-91dc-49cd-b63b-da3727xxxxxx",
                        "SpaceType": "gb28181",
                        "DeviceID": "e15e6a69-9a73-435d-91e8-89b6c6xxxxxx",
                        "DeviceName": "d19",
                        "DeviceNSID": "34020022991320xxxxxx",
                        "ChannelID": "98880000001xxxxxxxx",
                        "Status": "no_forward"
                    }
                ]
            }
        ]
    }
}