添加对象信息--慢直播-火山引擎

文档中心

立即注册

导航

添加对象信息

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

在指定对象库中添加对象信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateLibInfo
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
LibID	Query	String	是	对象库 ID	可通过调用 ListLib 接口获取
Type	Query	String	是	对象类型	可选枚举值： Vehicle（车辆）

Body 参数

字段	类型	必填	说明
Cover	String	否	车辆照片 URL
VehicleOwner	String	是	车辆所有人
VehicleNumber	String	是	车牌号码
PlateColor	String	是	车牌颜色
VehicleColor	String	是	车辆颜色
VehicleType	String	是	车辆类型，可选枚举值： coupe（跑车） suv（越野车） largevehicle（大型车辆） sedan（轿车） truck（卡车） van（面包车）
PhoneNumber	String	否	联系电话
RegisterLocation	String	否	注册地址，1-50个字符
Description	String	否	车辆描述，1-100个字符

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	添加完成的对象 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateLibInfo
&Version=2021-01-01
&LibID=0-1642754961198599-1579
&Type=Vehicle
&<公共请求参数>
{
   "Cover": "https://xxx.com/xxx/c5b56a6cbcef432eaf99f2351ae4ebee.jpeg",
   "VehicleOwner": "Lucy",            
   "VehicleNumber": "沪A61D18",
   "PlateColor": "#093edc",
   "VehicleColor": "#e30d0d",
   "VehicleType": "suv",
   "PhoneNumber": "123456789",
   "RegisterLocation": "上海市",
   "Description": "家用车"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022012614350001021206303221006600",
        "Action": "CreateLibInfo",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "Vehicle-1643178900906475-8096"
    }
}