更新时间:2024-04-22 GMT+08:00

查询边缘节点列表

功能介绍

该API用于查询边缘节点。

URI

GET /v2/{project_id}/edgemgr/nodes?{name=xxx,limit=xxx,app_name=xxx,tags=xxx.xxx,device_id=xxx,device_name=xxx}

表1 Path参数

参数

是否必选

描述

project_id

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

表2 查询参数

参数

是否必选

类型

描述

name

String

边缘节点名称,模糊匹配

limit

String

每页显示的条目数量,取值范围1~1000,默认为500

offset

String

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

device_id

String

按终端设备ID查找

device_name

String

按绑定终端设备名称查找

app_name

String

按应用名称查找

tags

String

标签的key和value通过点连接,多个标签通过逗号连接,如:tags=key1.value1,key2.value2

  • 如果不携带任何检索参数,将返回该租户的所有边缘节点信息。
  • app_name和tags不支持复合查询,如果同时存在则返回tags查询结果,可以同时携带多个其他检索参数,可同时生效。

请求消息

表3 请求Header参数

参数

是否必选

类型

描述

Content-Type

String

消息体的类型(格式)

推荐您使用默认值application/json。

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

ief-instance-id

String

铂金版实例ID,专业版实例为空值

响应消息

响应参数
表4 响应Body参数

参数

类型

描述

nodes

Array of 表1 object

边缘节点列表

count

Integer

满足条件的边缘节点个数

响应示例

{
    "count": 1,
    "nodes": [
        {
            "comment": null,
            "enable_npu": null,
            "edged_version": "2.6.0",
            "mqtt_internal": "tls://0.0.0.0:8883",
            "ca": null,
            "updated_at": "2019-07-24T03:52:53.545185+08:00",
            "node_type": null,
            "docker_enable": true,
            "device_infos": [],
            "upgrade_history": [
                {
                    "to_version": "2.3.0",
                    "upgrade_time": 1557987888,
                    "result": "install_success",
                    "id": 0
                },
                {
                    "from_version": "2.3.0",
                    "to_version": "2.3.0",
                    "result": "install_success",
                    "dur_time": 2248264,
                    "upgrade_time": 1560236152,
                    "id": 1
                },
                {
                    "from_version": "2.3.0",
                    "to_version": "2.3.0",
                    "result": "install_success",
                    "dur_time": 87129,
                    "upgrade_time": 1560323281,
                    "id": 2
                },
                {
                    "from_version": "2.3.0",
                    "to_version": "2.3.0",
                    "result": "install_success",
                    "dur_time": 158246,
                    "upgrade_time": 1560481527,
                    "id": 3
                },
                {
                    "from_version": "2.3.0",
                    "to_version": "2.5.0",
                    "result": "install_success",
                    "dur_time": 1466742,
                    "upgrade_time": 1561948269,
                    "id": 4
                },
                {
                    "from_version": "2.5.0",
                    "to_version": "2.5.0",
                    "result": "install_success",
                    "dur_time": 884941,
                    "upgrade_time": 1562833210,
                    "id": 5
                },
                {
                    "from_version": "2.5.0",
                    "to_version": "2.6.0",
                    "result": "install_success",
                    "dur_time": 1106868,
                    "upgrade_time": 1563940078,
                    "id": 6
                }
            ],
            "pause_docker_image": null,
            "ntp_configs": {
                "ntp_servers": [
                    "10.127.1.0",
                    "ntp.myhuaweicloud.com"
                ],
                "ntp_enabled": true
            },
            "ief_node_version": "2.6.0",
            "id": "699de693-8493-4912-89dc-882134c5bf13",
            "device_num": 0,
            "certificate": null,
            "nics": [
                {
                    "interface": "eth0",
                    "ip": "10.0.0.41"
                }
            ],
            "gpu_num": 0,
            "os_version": "3.10.0-957.21.3.el7.x86_64",
            "state": "RUNNING",
            "error_reason": null,
            "memory": 990,
            "mqtt_mode": "internal",
            "project_id": "",
            "private_key": null,
            "os_name": "CentOS Linux 7 (Core)",
            "description": "",
            "gpu_info": [],
            "attributes": [],
            "mqtt_external": null,
            "arch": "x86_64",
            "host_ips": [
                "10.0.0.41"
            ],
            "enable_gpu": false,
            "enable_npu": false,
  
            "name": "ief-node",
            "deployment_num": 0,
            "package": null,
            "container_runtime_version": "docker://19.03.0",
            "created_at": "2019-05-16T06:19:10.303502+08:00",
            "cpu": 1,
            "product_id": null,
            "host_name": "iefnode",
            "relation": null,
            "os_type": "linux",
            "log_configs": []
        }
    ]
}

错误码

请参见错误码