查询视图数据列表--慢直播-火山引擎

文档中心

立即注册

导航

查询视图数据列表

最近更新时间：2023.05.22 16:56:26首次发布时间：2022.11.01 17:47:38

查询视图数据列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListStructuredViewData
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
ViewID	Query	String	否	筛选条件，视图接入 ID	可通过调用 ListStructuredViews 接口获取
ViewDataType	Query	String	否	筛选条件，视图数据类型	可选项： face person motorVehicles nonMotorVehicles
StartTs	String	Integer	是	查询起始时间	Unix 时间戳，单位：ms
EndTs	String	Integer	是	查询结束时间	Unix 时间戳，单位：ms
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
DataList	Array of objects	查询到的视图数据列表，参考以下 `List<DataList>` 数据结构说明

List<DataList> 数据结构说明

字段	类型	说明
ID	String	视图数据 ID
ViewDataType	String	视图接入数据类型： face person motorVehicles nonMotorVehicles
Timestamp	Integer	数据时间戳
Url	String

示例

请求示例

GET https://open.volcengineapi.com?Action=ListStructuredViewData
&Version=2021-01-01
&ViewID=v_rznll23mtuxxxxxx
&ViewDataType=person
&StartTs=1666420227000
&EndTs=1666593027000
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202210211535210101742491480305D847",
        "Action": "ListStructuredViewData",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "DataList": [
            {
                "ID": "xxxxxx",
                "ViewDataType": "person",
                "Timestamp": 1666593027000,
                "Url": "",

            },
            {
                "ID": "xxxxxx",
                "ViewDataType": "person",
                "Timestamp": 1666593027000,
                "Url": ""
            }
        ]
    }
}