文档首页/ 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}/externals

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：1

最大长度：64

edge_node_id

是

String

边缘节点ID

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的起始位置，取值范围为非负整数，默认为0

最小值：0

最大值：0

缺省值：0

limit

否

Integer

每页记录数，取值范围为非负整数，默认值为10

最小值：10

最大值：10

缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：20000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

externals

Array of ExternalEntityRespDTO objects

外部实体列表

数组长度：0 - 10
表5 ExternalEntityRespDTO

参数

参数类型

描述

node_id

String

节点ID

最小长度：1

最大长度：64

space_id

String

资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id.

最小长度：1

最大长度：36

external_id

String

外部实体ID

最小长度：1

最大长度：64

protocol

String

接入协议类型：MQTT，HTTP。

connection_type

String

连接类型(client和server)

create_time

String

创建时间

最小长度：0

最大长度：256

last_modify_time

String

最后修改时间

最小长度：0

最大长度：256

请求示例

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

响应示例

状态码： 200

Ok

{
  "externals" : [ {
    "node_id" : "string",
    "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
    "external_id" : "string",
    "protocol" : "string",
    "connection_type" : "string",
    "create_time" : "string",
    "last_modify_time" : "string"
  } ]
}

状态码

状态码

描述

200

Ok

401

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 外部实体管理

相关文档