文档首页/ 路网数字化服务 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}/rsu-models

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

参数

是否必选

参数类型

描述

limit

否

Integer

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

manufacturer_name

否

String

参数说明: RSU的厂商名称。

取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

offset

否

Integer

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

请求参数

表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_models

Array of RsuModelSummary objects

参数说明：RSU型号信息列表。
表5 RsuModelSummary

参数

参数类型

描述

rsu_model_id

String

参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得。

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

name

String

参数说明: RSU型号名称。

取值范围：长度不低于1不超过64，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

manufacturer_name

String

参数说明: RSU的厂商名称。

取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

description

String

参数说明: RSU型号的描述信息。

取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

last_modified_time

String

参数说明: RSU型号更新的时间。

格式：yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2020-12-07T01:32:17Z

created_time

String

参数说明: 在平台创建RSU型号的时间。

格式：yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2020-12-07T01:32:17Z

请求示例

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

响应示例

状态码： 200

OK

{
  "count" : 1,
  "rsu_models" : [ {
    "rsu_model_id" : "5ba24f5ebbe8f56f5a14f605",
    "name" : "RSU001",
    "manufacturer_name" : "ABC",
    "description" : "test",
    "last_modified_time" : "2020-12-07T01:32:17Z",
    "created_time" : "2020-12-07T01:32:17Z"
  } ]
}

状态码

状态码

描述

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型号管理

相关文档