文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 数据流转配置管理/ 查询边缘路由列表
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

查询边缘路由列表

功能介绍

用户在指定边缘节点上查询边缘路由列表

调试

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

URI

GET /v2/{project_id}/edge-nodes/{edge_node_id}/routes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。

最小长度：1

最大长度：64

edge_node_id

是

String

边缘节点ID

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

parsed

否

Boolean

是否解析路由

缺省值：false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

最小长度：0

最大长度：20000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

routes

Array of RouterDetailRespDTO objects

路由列表

数组长度：0 - 1000

update_time

String

最后一次修改时间

最小长度：0

最大长度：256
表5 RouterDetailRespDTO

参数

参数类型

描述

route_id

String

路由ID，节点下唯一

最小长度：0

最大长度：96

input_module_id

String

输入点所在模块的模块ID

最小长度：0

最大长度：64

output_module_id

String

输出点所在模块的模块ID

最小长度：0

最大长度：64

input

String

输入点名称

最小长度：0

最大长度：64

output

String

输出点名称

最小长度：0

最大长度：64

sql

String

sql參數

最小长度：0

最大长度：64

available

Boolean

是否可用

type

String

路由类型：standard|customized

请求示例

GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/routes

响应示例

状态码： 200

Ok

{
  "routes" : [ {
    "route_id" : "string",
    "input_module_id" : "string",
    "output_module_id" : "string",
    "input" : "string",
    "output" : "string",
    "sql" : "string",
    "available" : true
  } ],
  "update_time" : "2020-05-28T11:31:29.740Z"
}

状态码

状态码

描述

200

Ok

401

Bad Request

500

Internal Server Error

错误码

请参见错误码。

相关文档