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

创建信号机

功能介绍

创建信号机

调试

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

URI

POST /v1/{project_id}/traffic-controllers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

请求参数

表2 请求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认证”。
表3 请求Body参数

参数

是否必选

参数类型

描述

traffic_controller_id

是

String

参数说明：信号机设备ID，全局唯一。

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

esn

是

String

参数说明：序列号。

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

name

否

String

参数说明：名称。

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

description

否

String

参数说明：描述。

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

lat

否

Number

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

lon

否

Number

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

ele

否

Number

参数说明：定义海拔高程，可选，单位为分米。

pos_description

否

String

参数说明：位置说明。

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

installation_mode

否

String

参数说明：架设方式。

取值范围：

  • columnar：柱式

  • road-side-attach：路侧附着式

  • cantilever：悬臂式

  • gantry：门架式

  • lane-above-attach：车行道上方附着式

road_name

否

String

参数说明：所属道路名称，比如高速名称。

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

link_id

否

String

参数说明：信号机设备所属路段ID。

取值范围：长度等于30，只允许大写字母、数字。

secret

是

String

参数说明：第三方信号机设备密钥，输入信号机型号ID后方可填写该字段以设置方信号机设备密码。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

traffic_controller_id

String

参数说明：信号机设备ID，全局唯一。

esn

String

参数说明：序列号。

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

name

String

参数说明：名称。

description

String

参数说明：描述。

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

lat

Number

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

lon

Number

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

ele

Number

参数说明：定义海拔高程，可选，单位为分米。

pos_description

String

参数说明：位置说明。

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

installation_mode

String

参数说明：架设方式。

取值范围：

  • columnar：柱式

  • road-side-attach：路侧附着式

  • cantilever：悬臂式

  • gantry：门架式

  • lane-above-attach：车行道上方附着式

road_name

String

参数说明：所属道路名称，比如高速名称。

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

link_id

String

参数说明：信号机设备所属路段ID。

取值范围：长度等于30，只允许大写字母、数字。

status

String

参数说明：设备状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化

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

请求示例

POST https://{endpoint}/v1/{project_id}/traffic-controllers
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

{
  "traffic_controller_id" : "13229397084005974033576909202199",
  "esn" : "17598448011929637214623971962555",
  "name" : "TrafficController001",
  "description" : "test001",
  "lat" : 40.1234567,
  "lon" : 116.1234567,
  "ele" : 116.741,
  "pos_description" : "K08",
  "installation_mode" : "columnar",
  "road_name" : "road1",
  "link_id" : "12345676",
  "secret" : "secret123456"
}

响应示例

状态码： 201

Created

{
  "traffic_controller_id" : "13229397084005974033576909202199",
  "esn" : "17598448011929637214623971962555",
  "name" : "TrafficController001",
  "description" : "test001",
  "lat" : 40.1234567,
  "lon" : 116.1234567,
  "ele" : 116.741,
  "pos_description" : "K08",
  "installation_mode" : "columnar",
  "road_name" : "road1",
  "link_id" : "12345676",
  "status" : "INITIAL",
  "last_modified_time" : "2022-01-06T09:30:24Z",
  "created_time" : "2022-01-06T09:30:24Z",
  "last_online_time" : null
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

父主题： 信号机管理

相关文档