文档首页> 路网数字化服务 DRIS> API参考> API> 应用侧API参考> Edge管理> 创建Edge

更新时间：2024-03-14 GMT+08:00

查看PDF

创建Edge

功能介绍

创建Edge

调试

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

URI

POST /v1/{project_id}/v2x-edges

表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认证”。最小长度：1 最大长度：20000

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	参数说明：名称。取值范围：长度不小于1不超过128，只允许中文、字母、数字、连接符（-）、下划线（_）的组合。
description	否	String	参数说明：Edge描述。取值范围：长度不超过255，只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。
esn	是	String	参数说明：设备编码，全局唯一。取值范围：长度不小于1不超过64，只允许字母、数字、下划线（_）的组合。
ip	否	String	参数说明：网络IP。例如127.0.0.1。
port	否	Integer	参数说明：ITS800,ATLAS 端口号。最小值：0 最大值：65535
hardware_type	否	String	参数说明：硬件类型。取值范围：ITS800 或者 ATLAS 缺省值：ITS800
server_protocol_type	否	String	参数说明：v2xedge作为服务端的协议类型。取值范围：http 或者 https 缺省值：http
server_cert	否	String	参数说明：v2xedge作为服务端，pem格式的的证书。当server_protocol_type为https时必须携带证书和私钥。最小长度：0 最大长度：4096
server_private_key	否	String	参数说明：v2xedge作为服务端，pem格式的私钥。当server_protocol_type为https时必须携带证书和私钥。最小长度：0 最大长度：4096
position_description	否	String	参数说明：安装位置编码，由用户自定义。取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。
location	否	Location object	参数说明：经纬度坐标。
local_rsus	否	Array of strings	参数说明：Edge关联的本地RSU列表。此参数与local_segment_rsus参数不可同时填写。最大长度：255 数组长度：0 - 32
local_segment_rsus	否	Array of LocalSegmentRsu objects	参数说明：Edge管理的分段所关联的本地RSU列表。此参数与local_rsus参数不可同时填写数组长度：0 - 32
edge_general_config	否	CreateEdgeGeneralConfig object	参数说明：Edge通用配置。
edge_advance_config	否	Object	参数说明：Edge高级配置（请谨慎修改，错误配置将导致edge不可用），Json格式；如果想要删除整个edge_advance_config可以填写空Object（例如:{}）。如果想移除某个配置项，直接从配置数据中移除相应的属性即可最大长度：4096

表4 Location
参数	是否必选	参数类型	描述
lat	否	Number	参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。最小值：-90 最大值：90
lon	否	Number	参数说明：定义经度数值。东经为正，西经为负。单位°，精度小数点后7位。最小值：-180 最大值：180

表5 LocalSegmentRsu
参数	是否必选	参数类型	描述
segment_id	是	String	参数说明：分段Id，填写雷达设备对应序号（sequence_no）。取值范围：数字字符串。最小长度：1 最大长度：4
rsu_esn	是	String	参数说明：RSU的设备序列号。取值范围：只允许长度不小于1、最大为64，字母、数字、下划线（_）的组合。最小长度：1 最大长度：64

表6 CreateEdgeGeneralConfig
参数	是否必选	参数类型	描述
avp_enabled	否	Boolean	参数说明：AVP场景。
rsm_enabled	否	Boolean	参数说明：RSM上报：默认不上报。
time_compensate	否	Boolean	参数说明：时延补偿：是否启动Edge时延补偿功能。
rsi_positioning_enabled	否	Boolean	参数说明：RSI事件定位功能。
log_level	否	String	参数说明：应用日志级别，可选项：on/off，默认关闭。缺省值：off
road_detection_length	否	Double	参数说明：道路检测长度，单位：米。最小值：1 最大值：1000
ramp_detection_length	否	Double	参数说明：匝道检测长度，单位：米。最小值：1 最大值：1000
gat1400_username	否	String	参数说明：edge作为服务端单用户鉴权的用户名。如需配置多套鉴权用户，请使用edge_authentications。不能和edge_authentications同时使用，建议使用edge_authentications。取值范围：长度不小于8，不大于32，只允许数字字母下划线组合，且不能以数字下划线开头，不能有中文和特殊字符，gat1400用户名不能与gat1400密码相同。
gat1400_password	否	String	参数说明：edge作为服务端单用户鉴权的密码。如需配置多套鉴权用户，请使用edge_authentications。不能和edge_authentications同时使用，建议使用edge_authentications。取值范围： 1.密码必须包含如下至少两种字符的组合: －一个小写字母；－一个大写字母；－一个数字；－一个特殊字符：`~!@#$%^&()-_=+\|[{}];:'",<.>/? 和空格 2.gat1400密码不能与gat1400用户名相同最小长度：8 最大长度：255*
edge_authentications	否	Array of CreateEdgeAuthentication objects	参数说明：edge作为服务端的多用户鉴权信息，和gat1400_username（单个鉴权用户）不可同时使用，建议使用该字段。数组长度：0 - 10
user_name	否	String	参数说明：ITS800鉴权用的用户名。取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。
password	否	String	参数说明：ITS800鉴权用的密码。取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

表7 CreateEdgeAuthentication
参数	是否必选	参数类型	描述
user_name	是	String	参数说明：edge接口鉴权用户名。取值范围：长度不小于8，不大于32，只允许数字字母下划线组合，且不能以数字下划线开头，不能有中文和特殊字符，用户名不能与密码相同。
password	是	String	参数说明：edge接口鉴权密码。取值范围： 1.密码必须包含如下至少两种字符的组合: －一个小写字母；－一个大写字母；－一个数字；－一个特殊字符：`~!@#$%^&()-_=+\|[{}];:'",<.>/? 和空格 2.用户名和密码不能相同最小长度：8 最大长度：255*

响应参数

状态码： 201

表8 响应Body参数
参数	参数类型	描述
v2x_edge_id	String	参数说明：Edge ID，用于唯一标识一个Edge 最小长度：0 最大长度：255
name	String	参数说明：名称。取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、连接符（-）的组合。
description	String	参数说明：Edge描述。取值范围：长度不超过255，只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。最小长度：0 最大长度：255
esn	String	参数说明：设备编码，全局唯一。取值范围：长度不超过64，只允许字母、数字、以及_等字符的组合。
ip	String	参数说明：网络IP，例如127.0.0.1。
port	Integer	ITS800,ATLAS 端口号最小值：0 最大值：65535
hardware_type	String	参数说明：硬件类型。取值范围：ITS800 或者 ATLAS
server_protocol_type	String	参数说明：v2xedge作为服务端的协议类型。取值范围：http 或者 https 缺省值：http
server_cert	String	参数说明：v2xedge作为服务端，pem格式的证书。最小长度：0 最大长度：4096
position_description	String	参数说明：安装位置编码，由用户自定义。取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。
location	Location object	参数说明：经纬度坐标。
local_rsus	Array of strings	参数说明：Edge关联的本地RSU列表。最大长度：255 数组长度：0 - 32
local_segment_rsus	Array of LocalSegmentRsu objects	参数说明：Edge管理的分段所关联的本地RSU列表。数组长度：0 - 32
edge_general_config	EdgeGeneralConfigInResponse object	Edge通用配置。
edge_advance_config	Object	Edge高级配置，Json格式最大长度：4096
status	String	"参数说明：状态。取值范围： UNINSTALLED：待部署 INSTALLED：部署中 OFFLINE：离线 ONLINE：在线： UPGRADING：升级中 DELETING：删除中
node_id	String	边缘管理服务返回的node_id，用于关联EdgeManager的资源最小长度：0 最大长度：255
created_time	String	参数说明：创建时间。格式：yyyy-MM-dd''T''HH:mm:ss''Z''。例如 2020-09-01T01:37:01Z。
last_modified_time	String	参数说明：创建时间。格式：yyyy-MM-dd''T''HH:mm:ss''Z''。例如 2020-09-01T01:37:01Z。

表9 Location
参数	参数类型	描述
lat	Number	参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。最小值：-90 最大值：90
lon	Number	参数说明：定义经度数值。东经为正，西经为负。单位°，精度小数点后7位。最小值：-180 最大值：180

**表10** LocalSegmentRsu
参数	参数类型	描述
segment_id	String	参数说明：分段Id，填写雷达设备对应序号（sequence_no）。取值范围：数字字符串。最小长度：1 最大长度：4
rsu_esn	String	参数说明：RSU的设备序列号。取值范围：只允许长度不小于1、最大为64，字母、数字、下划线（_）的组合。最小长度：1 最大长度：64

**表11** EdgeGeneralConfigInResponse
参数	参数类型	描述
avp_enabled	Boolean	参数说明：AVP场景。
rsm_enabled	Boolean	参数说明：RSM上报：默认不上报。
time_compensate	Boolean	参数说明：时延补偿：是否启动Edge时延补偿功能。
rsi_positioning_enabled	Boolean	参数说明：RSI事件定位功能。
log_level	String	参数说明：应用日志级别取值范围：on/off，默认关闭。缺省值：off
road_detection_length	Double	参数说明：道路检测长度，单位：米。最小值：1 最大值：1000
ramp_detection_length	Double	参数说明：匝道检测长度，单位：米。最小值：1 最大值：1000
gat1400_username	String	参数说明：edge作为服务端单用户鉴权的用户名。如需配置多套鉴权用户，请使用edge_authentications。不能和edge_authentications同时使用，建议使用edge_authentications。取值范围：长度不小于8，不大于32，只允许数字字母下划线组合，且不能以数字下划线开头，不能有中文和特殊字符，gat1400用户名不能与gat1400密码相同。
edge_authentications	Array of ResponseEdgeAuthentication objects	参数说明：edge作为服务端的多用户鉴权信息，和gat1400_username（单个鉴权用户）不可同时使用，建议使用该字段。数组长度：0 - 10
user_name	String	参数说明：ITS800鉴权用的用户名。取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

**表12** ResponseEdgeAuthentication
参数	参数类型	描述
user_name	String	参数说明：edge接口鉴权用户名。取值范围：长度不小于8，不大于32，只允许数字字母下划线组合，且不能以数字下划线开头，不能有中文和特殊字符，用户名不能与密码相同。

请求示例

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

{
  "name" : "v2xedgeName",
  "description" : "v2xedge01",
  "esn" : "ESN01234567",
  "ip" : "127.0.0.1",
  "port" : "8880",
  "hardware_type" : "ATLAS",
  "position_description" : "position01",
  "local_rsus" : [ "rsu_test_01" ],
  "local_segment_rsus" : [ {
    "segment_id" : "1",
    "rsu_esn" : "13518098671442480164720973683901"
  }, {
    "segment_id" : "2",
    "rsu_esn" : "13518098671442480164720973683901"
  }, {
    "segment_id" : "3",
    "rsu_esn" : "98238558220689235608785517764662"
  } ]
}

响应示例

状态码： 201

Created

{
  "v2x_edge_id" : "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0",
  "name" : "name",
  "description" : "test",
  "esn" : "ESN01234567",
  "ip" : "127.0.0.1",
  "port" : "8880",
  "hardware_type" : "ATLAS",
  "server_protocol_type" : "http",
  "server_cert" : null,
  "position_description" : "testtest",
  "location" : {
    "lat" : 22.4,
    "lon" : 124
  },
  "local_rsus" : [ "rsu_test_01" ],
  "local_segment_rsus" : [ {
    "segment_id" : "1",
    "rsu_esn" : "13518098671442480164720973683901"
  }, {
    "segment_id" : "2",
    "rsu_esn" : "13518098671442480164720973683901"
  }, {
    "segment_id" : "3",
    "rsu_esn" : "98238558220689235608785517764662"
  } ],
  "edge_general_config" : {
    "avp_enabled" : true,
    "rsm_enabled" : true,
    "time_compensate" : true,
    "log_level" : false,
    "road_detection_length" : 10,
    "ramp_detection_length" : 10,
    "edge_authentications" : [ {
      "user_name" : "dris_user"
    } ],
    "gat1400_username" : null,
    "user_name" : "dris_user"
  },
  "edge_advance_config" : {
    "testKey" : "testValue"
  },
  "status" : "INSTALLED",
  "node_id" : "536434354358674544874543587",
  "created_time" : "2020-09-01T01:37:01Z",
  "last_modified_time" : "2020-09-01T01:37:01Z"
}

状态码

状态码	描述
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

错误码

请参见错误码。

父主题： Edge管理

上一篇：查询Edge列表

下一篇：删除Edge

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建Edge

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线