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

查询RSU列表

功能介绍

查询RSU列表

调试

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

URI

GET /v1/{project_id}/rsus

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

参数

是否必选

参数类型

描述

offset

否

Integer

参数说明：分页查询时的页码。

limit

否

Integer

参数说明：分页查询时每页显示的记录数。

rsu_id

否

String

参数说明：RSU的唯一标识符，在平台创建RSU时由平台生成。

取值范围：长度36，只允许小写字母、数字、连接符（-）的组合。

esn

否

String

参数说明：RSU的设备序列号。

取值范围：长度不低于1不超过64，只允许字母、数字、下划线（_）的组合。

status

否

String

参数说明：设备状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化

  • UNKNOWN：未知

rsu_model_id

否

String

参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得，获取方法可参见 “创建RSU型号”接口。

取值范围：长度不低于1不超过36，只允许字母、数字、连接符（-）的组合。

请求参数

表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

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

rsus

Array of RsuDTO objects

参数说明：RSU数据列表。
表5 RsuDTO

参数

参数类型

描述

rsu_id

String

参数说明：RSU的唯一标识符，在平台创建RSU时由平台生成。

name

String

参数说明：RSU的名字。

取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、连接符（-）的组合。

description

String

参数说明：RSU的描述。

取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文分号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）、空格的组合。

esn

String

参数说明：RSU的设备序列号。

取值范围：只允许字母、数字、下划线（_）的组合。

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

ip

String

参数说明：RSU的IP。满足IP的格式，例如127.0.0.1。

position_description

String

参数说明：安装位置编码，由用户自定义。

取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。

location

RsuLocation object

参数说明：RSU的位置信息。

status

String

参数说明：RSU设备状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化

  • UNKNOWN：未知

rsu_model_id

String

参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得，获取方法可参见 “创建RSU型号”接口。

取值范围：长度不低于1不超过36，只允许字母、数字、连接符（-）的组合。

intersection_id

String

参数说明：在地图中，rsu所在区域对应的路口ID，也即区域ID拼接路口ID，格式为：region-node_id。其中路网最基本的构成即节点和节点之间连接的路段。节点可以是路口，也可以是一条 路的端点。一个节点的ID在同一个区域内是唯一的。

related_edge_num

Integer

参数说明：RSU可关联的Edge的数量。

software_version

String

参数说明：RSU的软件版本，由RSU上报其软件版本。
表6 RsuLocation

参数

参数类型

描述

lat

Number

参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。

lon

Number

参数说明：定义经度数值。东经为正，西经为负，单位°，精度小数点后7位。

请求示例

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

响应示例

状态码： 200

OK

{
  "count" : 1,
  "rsus" : [ {
    "rsu_id" : "b58efc27-a6e5-4bca-9d12-c76ecfe3f102",
    "name" : "RSU001",
    "description" : "TEST",
    "esn" : "13518098671442480164720973683901",
    "last_modified_time" : "2020-09-01T01:37:01Z",
    "created_time" : "2020-09-01T01:37:01Z",
    "last_online_time" : "2020-09-01T01:37:01Z",
    "ip" : "127.0.0.1",
    "position_description" : "K08",
    "location" : {
      "lat" : 40.1234567,
      "lon" : 116.1234567
    },
    "status" : "ONLINE",
    "rsu_model_id" : "27652459499824704332521974743806",
    "intersection_id" : "1-301",
    "related_edge_num" : 0,
    "software_version" : "V100X00XX00X325"
  } ]
}

状态码

状态码

描述

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

错误码

请参见错误码。

父主题： RSU管理

相关文档