查询Edge
功能介绍
查询Edge
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/v2x-edges/{v2x_edge_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 |
|
v2x_edge_id |
是 |
String |
参数说明：Edge ID，用于唯一标识一个Edge。 取值范围：长度36，只允许小写字母、数字、连接符（-）的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
v2x_edge_id |
String |
参数说明：Edge ID，用于唯一标识一个Edge。 |
|
name |
String |
参数说明：名称。 取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。 |
|
description |
String |
参数说明：Edge描述。 |
|
esn |
String |
参数说明：设备编码，全局唯一。 取值范围：长度不超过64，只允许字母、数字、以及_等字符的组合。 |
|
ip |
String |
参数说明：网络I，例如127.0.0.1。 |
|
port |
Integer |
ITS800,ATLAS 端口号 |
|
hardware_type |
String |
参数说明：硬件类型。 取值范围：ITS800 或者 ATLAS。 |
|
server_protocol_type |
String |
参数说明：v2xedge作为服务端的协议类型。 取值范围：http 或者 https |
|
server_cert |
String |
参数说明：v2xedge作为服务端，pem格式的证书。 |
|
position_description |
String |
参数说明：安装位置编码，由用户自定义。 取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。 |
|
location |
Location object |
参数说明：经纬度坐标。 |
|
cameras |
Array of CameraIdAndStatus objects |
参数说明：Edge关联的摄像头列表。 |
|
radars |
Array of RadarIdAndStatus objects |
参数说明：Edge关联的雷达列表。 |
|
local_rsus |
Array of RsuIdAndStatus objects |
参数说明：Edge关联的本地RSU列表。 |
|
local_segment_rsus |
Array of LocalSegmentRsu objects |
参数说明：Edge管理的分段所关联的本地RSU列表。 |
|
edge_general_config |
EdgeGeneralConfigInResponse object |
参数说明：Edge通用配置。 |
|
edge_advance_config |
Object |
参数说明：Edge高级配置，Json格式 |
|
status |
String |
参数说明：状态。 取值范围：
|
|
channel_status |
String |
参数说明：业务通道状态。 取值范围：
|
|
node_id |
String |
参数说明：边缘管理服务返回的node_id，用于关联EdgeManager的资源。 |
|
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。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
lat |
Number |
参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。 |
|
lon |
Number |
参数说明：定义经度数值。东经为正，西经为负。单位°，精度小数点后7位。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数说明：摄像头的ID。 |
|
status |
String |
参数说明：摄像头的状态。 取值范围：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数说明：雷达的esn。 |
|
status |
String |
参数说明：雷达的状态。 取值范围：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数说明：RSU的esn。 |
|
status |
String |
参数说明：RSU的状态。 取值范围：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
segment_id |
String |
参数说明：分段Id，填写雷达设备对应序号（sequence_no）。 取值范围：数字字符串。 |
|
rsu_esn |
String |
参数说明：RSU的设备序列号。 取值范围：只允许长度不小于1、最大为64，字母、数字、下划线（_）的组合。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
avp_enabled |
Boolean |
参数说明：AVP场景。 |
|
rsm_enabled |
Boolean |
参数说明：RSM上报：默认不上报。 |
|
time_compensate |
Boolean |
参数说明：时延补偿：是否启动Edge时延补偿功能。 |
|
rsi_positioning_enabled |
Boolean |
参数说明：RSI事件定位功能。 |
|
log_level |
String |
参数说明：应用日志级别 取值范围：on/off，默认关闭。 |
|
road_detection_length |
Double |
参数说明：道路检测长度，单位：米。 |
|
ramp_detection_length |
Double |
参数说明：匝道检测长度，单位：米。 |
|
gat1400_username |
String |
参数说明：edge作为服务端单用户鉴权的用户名。如需配置多套鉴权用户，请使用edge_authentications。不能和edge_authentications同时使用，建议使用edge_authentications。 取值范围：长度不小于8，不大于32，只允许数字字母下划线组合，且不能以数字下划线开头，不能有中文和特殊字符，gat1400用户名不能与gat1400密码相同。 |
|
edge_authentications |
Array of ResponseEdgeAuthentication objects |
参数说明：edge作为服务端的多用户鉴权信息，和gat1400_username（单个鉴权用户）不可同时使用，建议使用该字段。 |
|
user_name |
String |
参数说明：ITS800鉴权用的用户名。 取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 |
请求示例
GET https://{endpoint}/v1/{project_id}/v2x-edges/{v2x_edge_id}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********
响应示例
状态码： 200
OK
{
"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
},
"cameras" : [ "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0" ],
"radars" : [ "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0" ],
"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" : "ONLINE",
"node_id" : "536434354358674544874543587",
"created_time" : "2020-09-01T01:37:01Z",
"last_modified_time" : "2020-09-01T01:37:01Z"
}
状态码
|
状态码 |
描述 |
|---|---|
|
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 |
错误码
请参见错误码。
