文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ 车辆管理/ 查询车辆列表
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

查询车辆列表

功能介绍

查询车辆列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/vehicles

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。

取值范围：仅支持数字，a到f的小写字母组合，长度32。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数说明：分页查询时的页码， offset大于等于0，默认取值为0。

limit

否

Integer

参数说明：分页查询时每页显示的记录数，默认值为10，取值范围为0-20的整数。

vehicle_id

否

String

参数说明：车辆唯一标识符。

取值范围：长度不超过128，只允许字母、数字、以及_-等字符的组合。

status

否

String

参数说明：设备状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

参数说明：实例ID。DRIS物理实例的唯一标识，获取方法请参见“API参考 > 附录 > 获取Instance-Id”。

取值范围：仅支持数字，小写字母和横杠（-）的组合，长度36。

X-Auth-Token

否

String

参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Long

参数说明：返回车辆的总体数量。

vehicles

Array of VehicleDTO objects

参数说明：数据列表。
表5 VehicleDTO

参数

参数类型

描述

vehicle_id

String

参数说明：车辆唯一标识符。

取值范围：长度不超过128，只允许字母、数字、以及_-等字符的组合。

plate_no

String

参数说明：车牌号。

取值范围：长度最小1最大64，支持中文、阿拉伯文、字母、数字、下划线（_）、横杠（-）的组合。

vin

String

参数说明：VIN码，车辆的17位VIN码。

取值范围：长度不超过17，只允许字母、数字字符的组合。

obu_id

String

"参数说明：车载OBU的唯一标识。

取值范围：长度不超过128，只允许字母、数字、以及_-等字符的组合。

imei

String

参数说明：IMEI，OBU上电子序列号。

取值范围：长度最小1最大255，支持纯数字的组合。

brand

String

参数说明：车辆品牌。

取值范围：长度最小1最大64，支持中文、字母、数字、下划线（_）、横杠（-）的组合。

model

String

参数说明：车牌型号。

取值范围：长度最小1最大64，支持字母、数字、下划线（_）、横杠（-）的组合。

style

String

参数说明：车辆年款。

取值范围：长度最小1最大64，支持纯数字的组合。

fuel_type

String

参数说明：定义车辆的燃料动力类。

取值范围：

  • unknownFuel：未知

  • gasoline：汽油

  • ethanol：乙醇

  • diesel：柴油

  • electric：电动

  • hybrid：混合燃料类型

  • hydrogen：氢气

  • natGasLiquid：液化天然气

  • natGasComp：压缩天然气

  • propane：丙烷

color

String

参数说明：车辆颜色。

取值范围：

  • black：黑色

  • white：白色

  • gray：灰色

  • red：红色

  • blue：蓝色

  • yellow：黄色

  • orange：橙色

  • brown：棕色

  • green：绿色

  • purple：紫色

  • cyan：青色

  • pink：粉红色

  • transparent：透明色

  • other：其他

plate_color

String

参数说明：车辆颜色。

取值范围：

  • black：黑色

  • white：白色

  • blue：蓝色

  • yellow：黄色

  • green：绿色

access_type

String

参数说明：车辆接入网络的方式。

取值范围：

  • 5g

  • 4g

  • 3g

  • 2g

  • pc5Only

  • pc5And5g

  • pc5And4g

  • pc5And3g

  • pc5And2g

description

String

参数说明：描述。

取值范围：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-空格等字符的组合。

last_modified_time

String

参数说明：最后修改的时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z

created_time

String

参数说明：创建的时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z

last_online_time

String

参数说明：最后的在线时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z

status

String

参数说明：设备状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化

请求示例

GET https://{endpoint}/v1/{project_id}/vehicles?limit={limit}&offset={offset}&status={status}&vehicle_id={vehicle_id}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

响应示例

状态码： 200

OK

{
  "count" : 1,
  "vehicles" : [ {
    "vehicle_id" : "12302463411926825917269660281057",
    "plate_no" : "Huawei",
    "vin" : "74512845126",
    "obu_id" : "OBU_007",
    "imei" : "987954asdfasdf",
    "brand" : "Huawei",
    "model" : "Huawei",
    "style" : "2022",
    "fuel_type" : "gasoline",
    "color" : "white",
    "plate_color" : "black",
    "access_type" : "5g",
    "description" : "description",
    "last_modified_time" : "2020-09-01T01:37:01Z",
    "created_time" : "2020-09-01T01:37:01Z",
    "last_online_time" : "2020-11-01T01:37:01Z",
    "status" : "OFFLINE"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

父主题： 车辆管理

相关文档