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

查询Edge列表

功能介绍

查询Edge列表

调试

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

URI

GET /v1/{project_id}/v2x-edges

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

status

否

String

参数说明：状态。

取值范围：

  • UNINSTALLED： 待部署

  • INSTALLED：部署中

  • OFFLINE：离线

  • ONLINE：在线：

  • UPGRADING：升级中

  • DELETING：删除中

请求参数

表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

参数说明：总数。

edges

Array of V2XEdgeListResponseDTO objects

参数说明：数据列表。
表5 V2XEdgeListResponseDTO

参数

参数类型

描述

v2x_edge_id

String

参数说明：Edge ID，用于唯一标识一个Edge。

name

String

参数说明：V2XEdge的名称

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

esn

String

参数说明：设备编码，全局唯一。

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

ip

String

参数说明：网络IP，例如127.0.0.1。

port

Integer

参数说明：ITS800，ATLAS 端口号。

position_description

String

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

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

location

Location object

经纬度坐标

status

String

参数说明：状态。

取值范围：

  • UNINSTALLED： 待部署

  • INSTALLED：部署中

  • OFFLINE：离线

  • ONLINE：在线：

  • UPGRADING：升级中

  • DELETING：删除中

channel_status

String

参数说明：业务通道状态。

created_time

String

参数说明：创建时间。

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

例如 2020-09-01T01:37:01Z。
表6 Location

参数

参数类型

描述

lat

Number

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

lon

Number

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

请求示例

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

响应示例

状态码： 200

OK

{
  "count" : 1,
  "edges" : [ {
    "v2x_edge_id" : "74297d76-6f99-4fe2-a435-1e27a524e4c8",
    "name" : "name",
    "esn" : "ESN0001123234",
    "ip" : "127.0.0.1",
    "port" : 30080,
    "position_description" : "test",
    "status" : "ONLINE",
    "channel_status" : "ONLINE",
    "created_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

错误码

请参见错误码。

父主题： Edge管理

相关文档