获取对象列表--慢直播-火山引擎

文档中心

立即注册

导航

获取对象列表

最近更新时间：2022.02.08 14:18:44首次发布时间：2022.01.30 15:24:41

查询指定对象库中已注册的对象列表（目前支持查询车辆库中注册的车辆列表）。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListLibInfo
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
LibID	Query	String	是	筛选条件，对象库 ID	可通过调用 ListLib 接口获取
Type	Query	String	是	筛选条件，对象库类型	可选枚举值： Vehicle（车辆库）
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

Body 参数

字段	类型	必填	说明
VehicleNumber	String	否	筛选条件，车牌号码
VehicleOwner	String	否	筛选条件，车辆所有人
PhoneNumber	String	否	筛选条件，联系电话
VehicleType	String	否	筛选条件，车辆类型，可选枚举值： coupe（跑车） suv（越野车） largevehicle（大型车辆） sedan（轿车） truck（卡车） van（面包车）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
Type	String	对象库类型： Vehicle（车辆库）
Details	Array of objects	查询到的对象信息列表，参考以下 `List<Details>` 结构说明

字段

类型

说明

Type

String

对象库类型：

Vehicle（车辆库）

Details Array of objects 查询到的对象信息列表，参考以下 List<Details> 结构说明

List<Details> 结构说明

字段	类型	说明
ItemID	String	对象 ID
Cover	String	对象照片 URL
VehicleOwner	String	车辆所有人
VehicleNumber	String	车牌号码
PlateColor	String	车牌颜色
VehicleColor	String	车辆颜色
VehicleType	String	车辆类型： coupe（跑车） suv（越野车） largevehicle（大型车辆） sedan（轿车） truck（卡车） van（面包车）
PhoneNumber	String	联系电话
RegisterLocation	String	注册地址
Description	String	对象描述
CreateAt	String	创建时间
UpdateAt	String	更新时间

示例

请求示例

POST https://open.volcengineapi.com?Action=ListLibInfo
&Version=2021-01-01
&LibID=0-1642754961198599-1579
&Type=Vehicle
&<公共请求参数>
{
    "VehicleNumber": ""
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201271446430102020900171000AAF2",
        "Action": "ListLibInfo",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 3,
        "Type": "Vehicle",
        "Details": [
            {
                "ItemID": "Vehicle-1643188071426008-9864",
                "Cover": "https://xxx.com/xxx/c5b56a6cbcef432eaf99f2351ae4ebee.jpeg",
                "VehicleOwner": "Habiis",
                "VehicleNumber": "沪D78943",
                "PlateColor": "#8d5858",
                "VehicleColor": "#8b5b5b",
                "VehicleType": "coupe",
                "PhoneNumber": "",
                "RegisterLocation": "",
                "Description": "",
                "CreateAt": "2022-01-26T17:07:51+08:00",
                "UpdateAt": "2022-01-26T17:07:51+08:00"
            },
            {
                "ItemID": "Vehicle-1642756971328515-1869",
                "Cover": "https://xxx.com/xxx/c5b56a6cbcef432eaf99f2351ae4ebee.jpeg",
                "VehicleOwner": "Michael",
                "VehicleNumber": "浙AT2791",
                "PlateColor": "#093edc",
                "VehicleColor": "",
                "VehicleType": "coupe",
                "PhoneNumber": "12312312313",
                "RegisterLocation": "北京",
                "Description": "",
                "CreateAt": "2022-01-21T17:22:51+08:00",
                "UpdateAt": "2022-01-26T14:14:57+08:00"
            },
            {
                "ItemID": "Vehicle-1642756376998744-6141",
                "Cover": "https://xxx.com/xxx/c5b56a6cbcef432eaf99f2351ae4ebee.jpeg",
                "VehicleOwner": "Peter",
                "VehicleNumber": "浙AP3096",
                "PlateColor": "#0166e9",
                "VehicleColor": "#e30d0d",
                "VehicleType": "coupe",
                "PhoneNumber": "11012010086",
                "RegisterLocation": "浙江",
                "Description": "",
                "CreateAt": "2022-01-21T17:12:56+08:00",
                "UpdateAt": "2022-01-26T14:15:09+08:00"
            }
        ]
    }
}