# 查询边缘节点列表
#### 功能介绍
查询边缘节点列表
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/doc?api=ListEdgeNodes)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
GET /v2/{project_id}/edge-nodes
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                        |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。获取方法请参见 [获取项目ID](https://support.huaweicloud.com/api-iotedge/iotedge_api_0032.html)。 |
   
表2Query参数 
| 参数          | 是否必选 | 参数类型             | 描述                                                                              |
|:---|:---|:---|:---|
| name        | 否    | String           | 节点名称                                                                            |
| state       | 否    | String           | 节点状态,OFFLINE\|ONLINE\|UNINSTALLED\|INSTALLED\|DELETING\|UPGRADING\|FROZEN       |
| type        | 否    | String           | 节点所属资源类型，advanced\|standard                                                     |
| instance_id | 否    | String           | 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。                   |
| space_id    | 否    | String           | 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的设备列表，不携带该参数则会查询该用户下所有设备列表。 |
| node_ids    | 否    | Array of strings | 节点id列表,查询ID在给的节点ID列表内的节点信息                                                      |
| app_id      | 否    | String           | 应用ID，查询部署了该应用的节点列表。                                                             |
| offset      | 否    | Integer          | 查询的起始位置，取值范围为非负整数，默认为0                                                          |
| limit       | 否    | Integer          | 每页记录数，默认值为10，取值区间为1-1000                                                        |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务 [获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。简要的获取方法样例请参见 [Token认证](https://support.huaweicloud.com/api-iothub/iot_06_v5_0091.html#section0)。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                                                             | 描述   |
|:---|:---|:---|
| count     | Long                                                                                                             | 总记录数 |
| page_info | [PageInfoDTO] object           | 分页信息 |
| nodes     | Array of [EdgeNodeDTO] objects | 节点列表 |
   
 表5PageInfoDTO 
| 参数     | 参数类型    | 描述    |
|:---|:---|:---|
| offset | Integer | 页码    |
| limit  | Integer | 每页记录数 |
   
 表6EdgeNodeDTO 
| 参数                  | 参数类型             | 描述                                                                        |
|:---|:---|:---|
| edge_node_id        | String           | 边缘节点ID                                                                    |
| name                | String           | 边缘节点名称                                                                    |
| state               | String           | 边缘节点状态UNINSTALLED\|INSTALLED\|OFFLINE\|ONLINE\|DELETING\|FROZEN           |
| instance_id         | String           | 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。             |
| space_id            | String           | 资源空间id，对应IOTDA云服务接口参数中的app_id。                                            |
| type                | String           | 边缘节点类型：lite\|advanced\|standard。lite表示基础版边缘节点，advanced或standard表示专业版边缘节点。 |
| resource_ids        | Array of strings | 节点所购买的资源类型的列表                                                             |
| resource_spec_types | Array of strings | 节点所购买的资源类型的列表                                                             |
| ips                 | Array of strings | 边缘节点ip列表                                                                  |
| software_version    | String           | 节点软件版本                                                                    |
| create_time         | String           | 边缘节点创建时间                                                                  |
| node_group_id       | String           | 节点组ID                                                                     |
   
#### 请求示例
```
GET https://{endpoint}/v2/{project_id}/edge-nodes
```
#### 响应示例
**状态码：200**
Ok
```
{
  "count" : 1000000,
  "page_info" : {
    "offset" : 1000000,
    "limit" : 1000
  },
  "nodes" : [ {
    "edge_node_id" : "string",
    "name" : "string",
    "state" : "string",
    "instance_id" : "string",
    "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
    "type" : "string",
    "resource_ids" : [ "iotedge.campus.1000tps.10000device" ],
    "resource_spec_types" : [ "iotedge.campus.1000tps.10000device" ],
    "software_version" : "string",
    "ips" : [ "string" ],
    "create_time" : "2020-05-28T11:31:29.740Z"
  } ]
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 200 | Ok                    |
| 401 | Bad Request           |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-iotedge/ErrorCode.html)。