- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 开发指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
- 概念相关
-
节点管理
- 安装专业版节点异常如何处理?
- 安装专业版节点,执行安装命令时失败,一直提示“edgedaemon not found"?
- 安装专业版节点失败,提示“edge_core has existed”,该如何处理?
- 专业版节点所在机器断网/断电一段时间后恢复,节点模块一直处于“部署中”怎么处理?
- 专业版节点欠费充值后,部署、升级模块仍然报错?
- MQTT设备无法接入边缘节点如何处理?专业版节点所在机器断网/断电一段时间后恢复,节点模块一直处于“部署中”怎么处理?
- 误删除IoTDA上的edge_node/modbus_server产品后,在边缘服务创建节点/添加Modbus设备失败,该怎么处理?
- 边缘节点离线排查指南
- 修改专业版(Docker)或基础版节点的云端日志级别,但没有生效?
- ubuntu系统下节点shell命令兼容性导致的安装失败
- 子设备管理
- 应用管理
- 账号与权限
- Module-SDK
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询指定边缘节点下的外部实体
功能介绍
用户在指定边缘节点上查询外部实体列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/edge-nodes/{edge_node_id}/externals
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 |
edge_node_id |
是 |
String |
边缘节点ID 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:0 缺省值:0 |
limit |
否 |
Integer |
每页记录数,取值范围为非负整数,默认值为10 最小值:10 最大值:10 缺省值:10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
externals |
Array of ExternalEntityRespDTO objects |
外部实体列表 数组长度:0 - 10 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
错误码
请参见错误码。