更新时间:2021-12-27 GMT+08:00
分享

查询边缘节点列表

功能介绍

该API用于查询边缘节点。

  • 如果不携带任何检索参数,将返回该租户的所有边缘节点信息。

  • app_name和tags不支持复合查询,如果同时存在则返回tags查询结果,可以同时携带多个其他检索参数,可同时生效。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/edgemgr/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

ief-instance-id

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

nodes

Array of EdgeNodeResp objects

边缘节点列表

count

Integer

满足条件的边缘节点个数

表5 EdgeNodeResp

参数

参数类型

描述

id

String

边缘节点ID

name

String

边缘节点名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 Name为必填字段,且本帐号中唯一。

description

String

边缘节点描述,最大长度255,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

created_at

String

创建时间

updated_at

String

更新时间

project_id

String

项目ID

private_key

String

私钥

certificate

String

证书

ca

String

根证书

state

String

边缘节点状态

  • UNCONNECTED(未注册)

  • RUNNING(运行中)

  • FAIL(故障)

  • STOPPED(停用)

  • UPGRADING(升级中)

  • FREEZE(冻结)

package

String

将证书文件certificate/ca/private_key打成.tar.gz包后用base64编码的字符串。 使用时请使用base64解码成.tar.gz包。

master_addr

String

云端服务URL

cpu

Integer

边缘节点CPU核心数

memory

Integer

边缘节点内存大小,单位M

os_name

String

边缘节点操作系统名称

os_version

String

边缘节点操作系统版本

pause_docker_image

String

pause容器镜像URL

arch

String

边缘节点架构

os_type

String

边缘节点操作系统类型

deployment_num

Integer

部署在该边缘节点上的应用实例个数

enable_gpu

Boolean

边缘节点是否开启GPU,默认为false

log_configs

Array of LogConfigs objects

边缘节点日志配置

device_infos

Array of DeviceInfos objects

关联设备信息

edged_version

String

edged版本

gpu_num

Integer

gpu个数

host_ips

Array of strings

主机IP,默认返回eth0网卡的IP。

relation

String

与device绑定关系名称(通过device id查询node时有值)

comment

String

与device绑定关系描述(通过device id查询node时有值)

gpu_info

Array of GpuInfo objects

gpu型号和gpu memory大小

device_num

Integer

关联设备数量

enable_npu

Boolean

边缘节点是否开启NPU,true表示开启,false表示不开启,默认为false

npu_type

String

npu类型,支持D310类型和D910类型。

  • D310表示D310类型。

  • D910表示D910类型。

  • 不填表示为D310类型。

nics

Array of Nics objects

节点网卡和对应IP地址信息

host_name

String

边缘节点主机名

ief_node_version

String

边缘节点版本

upgrade_flag

Boolean

是否能升级的标志

  • true:需要升级

  • false:不需要升级

product_id

String

产品ID(通过产品证书方式纳管)

group_ids

Array of strings

节点组ID(一个节点属于多个节点组)

upgrade_history

Array of UpgradeHistory objects

节点安装或升级记录

attributes

Array of Attributes objects

边缘节点属性,关联属性个数最多为32个

docker_enable

Boolean

节点是否开启Docker

mqtt_mode

String

mqtt集成模式

  • internal:edgecore内置mqtt

  • external:外置开源mqtt

mqtt_external

String

外置开源mqtt地址

mqtt_internal

String

edgecore内置的mqtt地址

node_type

String

节点类型,默认为空,非空时为小站节点

ntp_configs

NtpConfigs object

ntp配置

error_reason

String

节点故障原因

tags

Array of ResourceTag objects

边缘节点标签,标签个数最多为20个

npu_num

Integer

NPU数量

npu_info

Array of NpuInfo objects

NPU型号和NPU Memory大小

container_runtime_version

String

容器运行时版本

表6 LogConfigs

参数

参数类型

描述

id

String

数据库保存的主键,不需要关注此字段。

size

Integer

应用日志文件大小限制,单位MB,默认50,取值范围10-1000。

level

String

  • 当type为LTS时,应用级日志可配置为On或Off;系统级日志可配置为Off/Error/Warning/Info/Debug;

  • 当type为local时,无需配置level。

rotate_num

Integer

应用日志rotate个数,默认5,取值范围1-10。

rotate_period

String

应用日志rotate周期,可选项:

  • daily

  • monthly

  • weekly

  • yearly

type

String

  • LTS:将日志发送到AOM

  • local:本地日志

component

String

  • app:部署到边缘节点上的应用的日志

  • system:边缘节点上系统的日志

表7 DeviceInfos

参数

参数类型

描述

relation

String

设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

comment

String

设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

device_ids

Array of strings

设备ID列表

表8 GpuInfo

参数

参数类型

描述

name

String

GPU名称

type

String

GPU类型

capacity

String

GPU memory大小,单位MB

表9 Nics

参数

参数类型

描述

interface

String

边缘节点网卡名称

ip

String

上述网卡对应的IPv4地址

表10 UpgradeHistory

参数

参数类型

描述

id

Integer

节点升级或安装历史版本id

from_version

String

节点升级前节点上edgecore版本号,形式如2.1.0,其中每一位都是整数

to_version

String

节点升级或安装后节点行edgecore版本号,形式如2.1.0,其中每一位都是整数

upgrade_time

Integer

节点升级或安装的十位时间戳

result

String

节点升级或安装状态,包含

  • install_success:边缘节点安装成功

  • upgrade_success:边缘节点升级成功

  • install_failed:边缘节点安装失败

  • upgrade_failed:边缘节点升级失败

  • upgrade_failed_rollback_success:边缘节点升级失败回滚成功

  • upgrade_failed_rollback_failed:边缘节点升级失败回滚失败

dur_time

Integer

节点升级所消耗的时间

表11 Attributes

参数

参数类型

描述

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

表12 NtpConfigs

参数

参数类型

描述

ntp_enabled

Boolean

ntp服务是否开启

ntpservers

Array of strings

ntp server地址

表13 ResourceTag

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

value

String

值。每个值最大长度43个unicode字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

表14 NpuInfo

参数

参数类型

描述

name

String

NPU名称

type

String

NPU类型

capacity

String

NPU memory大小

driver_version

String

NPU驱动版本

请求示例

响应示例

状态码: 200

响应参数

{
  "count" : 1,
  "nodes" : [ {
    "comment" : null,
    "enable_npu" : false,
    "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,
    "npu_type" : "",
    "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" : [ ]
  } ]
}

状态码

状态码

描述

200

响应参数

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读