更新时间:2023-04-24 GMT+08:00
分享

查询设备详情

功能介绍

支持查询HiLens专业版控制台上的设备详情。

URI

GET /v3/{project_id}/ai-mgr/nodes/{node_id}

表1 路径参数

参数

是否必选

参数类型

描述

node_id

String

设备ID,从专业版HiLens控制台设备管理查询设备列表获取

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token。获取方法请参见获取Token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

设备ID

arch

String

设备架构

memory

Long

设备内存

name

String

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

description

String

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

created_at

String

产生时间,如2021-10-15 14:45:22 GMT+08:00

updated_at

String

更新时间,如2021-10-15 14:45:22 GMT+08:00

user_name

String

IAM用户名

cluster_id

String

当该设备处于集群时,显示设备所属的集群ID

cluster_node_state

String

设备所处集群状态,集群创建(cluster_create)、集群删除(cluster_delete)、添加集群工作节点设备(cluster_add_nodes)、删除集群工作节点设备(cluster_delete_node)、集群节点设备状态更新(cluster_node_state_update)

cluster_node_type

String

当该设备处于集群时,显示所属的集群设备类型。

  • cluster_controller 控制设备

  • cluster_worker 工作设备

firmware_name

String

固件名称。可包含大小写字母、数字、下划线、中划线,长度不超过60字符。必须以字母开头,字母或数字结尾

firmware_version

String

固件版本。支持X.Y.Z格式。每一个子版本号不超过三位且为非负整数,禁止在数字前补0

upgrade_firmware_version

String

固件正在升级的版本

firmware_status

String

固件升级状态,1、2、3分别代表升级中,升级失败,升级成

firmware_upgrade_record

Array of FirmwareUpdateRecord objects

该设备上升级过的固件记录

state

String

设备状态:UNCONNECTED(未注册)、RUNNING(运行中)、FAIL(故障)、STOPPED(停用)、UPGRADING(升级中)、FREEZE(冻结)

type

String

设备类型

active_status

String

设备激活状态,未激活(INACTIVE)和已激活(ACTIVATED)

cpu

Integer

设备CPU个数

gpu_num

Integer

设备GPU个数

npu_num

Integer

设备NPU个数

npu_type

String

设备NPU类型

os_name

String

设备操作系统名称

os_type

String

设备操作系统类型

os_version

String

设备操作系统版本

enable_container

Boolean

是否启用容器

enable_gpu

Boolean

是否启用GPU

enable_npu

Boolean

是否启用NPU

host_ips

Array of strings

主机IP列表

tags

tags object

设备标签对列表

npu_info

Object

NPU信息

active_content

Array of strings

激活订单号列表

log_configs

Array of LogConfig objects

设备日志配置

event_validity_period

Integer

事件有效时间(单位:分钟)

表4 FirmwareUpdateRecord

参数

参数类型

描述

firmware_name

String

固件名称

firmware_version

String

固件版本

firmware_size

Integer

固件大小

firmware_upgrade_time

String

固件升级时间

status

Integer

固件升级状态

表5 tags

参数

参数类型

描述

key

String

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

value

String

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

表6 LogConfig

参数

参数类型

描述

component

String

app:应用日志。 system:系统的日志

level

String

系统级日志可配置为/error/warning/info/debug ; 不传会默认为info。

rotate_num

Integer

日志rotate个数,默认5,hilens取值范围1-30,ief取值范围1-10

rotate_period

String

日志rotate周期,可选项,只支持ief:daily monthly weekly yearly.

size

Integer

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

type

String

  • LTS 将日志发送到云日志服务(Log Tank Service,简称LTS)

  • local 本地日志

请求示例

支持查询HiLens专业版控制台上的某个设备详情。

GET https://{endpoint}/v3/{project_id}/ai-mgr/nodes/{node_id}

Request Header:  Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码: 200

请求成功

{
  "memory" : 15880352,
  "user_name" : "chace",
  "created_at" : "2022-02-16 11:01:23 GMT+08:00",
  "firmware_version" : "2.0.0",
  "type" : "General ARM Device",
  "host_ips" : [ "10.90.47.209" ],
  "firmware_name" : "HiLens_Device_Agent",
  "npu_num" : 1,
  "updated_at" : "2022-02-17 15:55:50 GMT+08:00",
  "id" : "hilens-989c34eeaeda4a5380b7d9f2b101f7f1",
  "state" : "FAIL",
  "active_content" : [ "fed6966c29e94bd18cd65debf25e9992", "466b3f957a8448f99a390531d615ee5c" ],
  "os_version" : "#1 SMP Mon Mar 16 00:02:15 UTC 2020",
  "cpu" : 16,
  "enable_npu" : false,
  "log_configs" : [ {
    "size" : 50,
    "type" : "LTS",
    "component" : "app",
    "rotate_num" : 5
  } ],
  "enable_gpu" : false,
  "gpu_num" : 0,
  "tags" : { },
  "enable_container" : true,
  "active_status" : "ACTIVATED",
  "npu_info" : { },
  "os_type" : "Linux",
  "name" : "hilens-209",
  "os_name" : "linux",
  "arch" : "aarch64"
}

状态码

状态码

描述

200

请求成功

401

认证不通过

403

拒绝执行请求

404

请求的资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档