查询指定边缘节点下的外部实体
功能介绍
用户在指定边缘节点上查询外部实体列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/edge-nodes/{edge_node_id}/externals
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 |
|
edge_node_id |
是 |
String |
边缘节点ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
查询的起始位置，取值范围为非负整数，默认为0 |
|
limit |
否 |
Integer |
每页记录数，取值范围为非负整数，默认值为10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
externals |
Array of ExternalEntityRespDTO objects |
外部实体列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
node_id |
String |
节点ID |
|
space_id |
String |
资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. |
|
external_id |
String |
外部实体ID |
|
protocol |
String |
接入协议类型：MQTT，HTTP。 |
|
connection_type |
String |
连接类型(client和server) |
|
create_time |
String |
创建时间 |
|
last_modify_time |
String |
最后修改时间 |
请求示例
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 |
错误码
请参见错误码。
