文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 边缘节点管理/ 查询边缘节点下的主机详情
更新时间:2024-09-04 GMT+08:00
分享

查询边缘节点下的主机详情

功能介绍

查询边缘节点下的主机详情

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/edge-nodes/{edge_node_id}/hosts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

hosts

Array of HostInfoDTO objects

节点主机信息详情

数组长度:0 - 10

表4 HostInfoDTO

参数

参数类型

描述

host_tag

String

主机标签DEFAULT|MASTER|SLAVE

最小长度:0

最大长度:64

host_status

String

主机工作状态(ONLINE|OFFLINE)

最小长度:0

最大长度:64

os_name

String

边缘节点操作系统。例如:Ubuntu 20.04;CentOS 7.9。不同于os_type边缘节点系统类型。

最小长度:1

最大长度:64

host_name

String

边缘节点主机名

最小长度:1

最大长度:256

container_version

String

容器运行时版本

最小长度:0

最大长度:64

nics

Array of Nic objects

边缘节点网络网卡信息

数组长度:0 - 10

specification

String

网络规格,如4 cores | 3867 MB

最小长度:0

最大长度:64

npu_details

Array of NPUDetailsDTO objects

NPU设备详细信息,包括硬件信息和使用情况。

数组长度:0 - 64

表5 Nic

参数

参数类型

描述

eth

String

网卡信息,如eth0,eth1

最小长度:0

最大长度:32

ip

String

网卡ip

最小长度:0

最大长度:64

mask_len

Integer

子网掩码的位数

最小值:0

最大值:32

表6 NPUDetailsDTO

参数

参数类型

描述

device_id

String

昇腾设备ID

最小长度:1

最大长度:64

npu_type

String

AI加速卡型号,如D310推理卡、D310P推理卡、D910训练卡。

最小长度:0

最大长度:16

product_name

String

昇腾设备产品类型

最小长度:0

最大长度:64

ai_core

Integer

AI加速卡包含ai核个数

最小值:0

最大值:64

health

String

昇腾设备健康状态

最小长度:0

最大长度:64

error_msg

String

昇腾设备故障信息

最小长度:0

最大长度:256

used_info

Array of NpuUsedInfoDTO objects

NPU使用信息

数组长度:0 - 64

表7 NpuUsedInfoDTO

参数

参数类型

描述

module_id

String

模块名称

最小长度:1

最大长度:64

used_ai_core_num

Integer

模块使用AI核的个数

最小值:1

最大值:64

used_cpu_core_num

Integer

模块使用NPU芯片中的cpu核数

最小值:0

最大值:64

请求示例

GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/hosts

响应示例

状态码

状态码

描述

200

Ok

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档