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

注册边缘节点

功能介绍

该API用于注册一个边缘节点。

接口调用成功后,您可以将响应消息体中node.package字段使用base64解码成tar.gz文件,并在控制台下载边缘核心软件,然后纳管边缘节点。

URI

POST /v2/{project_id}/edgemgr/nodes
表1 Path参数

名称

是否必选

描述

project_id

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

请求消息

请求参数

表2 请求Header参数

参数

是否必选

类型

描述

Content-Type

String

消息体的类型(格式)

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

X-Auth-Token

String

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

ief-instance-id

String

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

表3 请求Body参数

参数

是否必选

类型

描述

node

表4 object

边缘节点参数

表4 node

参数

是否必选

类型

描述

name

String

边缘节点名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

name为必填字段,且本账号中唯一。

description

String

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

enable_gpu

Boolean

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

log_configs

Array of 表2 object

边缘节点日志配置

device_infos

Array of 表3 object

关联终端设备信息

enable_npu

Boolean

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

npu_type

String

npu类型,支持D310类型。

  • D310表示D310类型。
  • 不填表示为D310类型。

attributes

Array of 表26 object

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

enable_docker

Boolean

边缘节点启用Docker,默认为true

tags

Array of 表27 object

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

mqtt_config

表38 object

MQTT配置

请求示例

{
    "node": {
        "name": "node_test",
        "description": "This is a test node",
        "enable_gpu": false,
        "log_configs": [
            {
                "component": "app",
                "type": "local",
                "level": "debug",
                "size": 100,
                "rotate_num": 5,
                "rotate_period": "daily"
            }
        ]
    }
}

响应消息

响应参数
表5 响应Body参数

参数

类型

描述

node

表1 object

边缘节点详细信息

响应示例

{
    "node": {
        "id": "86715318-a5a7-4507-a289-7238d53d5fed",
        "project_id": "05041fffa40025702f6dc009cc6f8f33",
        "name": "node_test",
        "description": "This is a test node",
        "created_at": "2020-08-11T01:23:55.527805447Z",
        "updated_at": "",
        "state": "UNCONNECTED",
        "master_addr": "https://ief2-placement.cn-north-4.myhuaweicloud.com:443",
        "arch": "",
        "enable_gpu": false,
        "gpu_info": [],
        "gpu_num": 0,
        "memory": 0,
        "os_version": "",
        "os_name": "",
        "device_infos": [],
        "os_type": "",
        "pause_docker_image": "swr.cn-north-4.myhuaweicloud.com/huawei-ief-internal-app/pause",
        "host_name": "",
        "cpu": 0,
        "log_configs": [
            {
                "level": "",
                "rotate_num": 5,
                "component": "app",
                "rotate_period": "daily",
                "type": "local",
                "id": "9b795f5e-01b7-47e8-b1ae-6dc59b9c0005",
                "size": 100
            },
            {
                "level": "false",
                "rotate_num": 5,
                "component": "app",
                "rotate_period": "daily",
                "type": "LTS",
                "id": "e419ab7f-17ea-4757-b62e-311fc777af69",
                "size": 50
            },
            {
                "level": "",
                "rotate_num": 5,
                "component": "system",
                "rotate_period": "daily",
                "type": "local",
                "id": "56dabbb7-4fb1-46cc-85df-dc80a2bd24f8",
                "size": 50
            },
            {
                "level": "false",
                "rotate_num": 5,
                "component": "system",
                "rotate_period": "daily",
                "type": "LTS",
                "id": "0f6935c1-e59d-4b0d-a0db-1ba07b2ac8d1",
                "size": 50
            }
        ],
        "host_ips": [],
        "edged_version": "",
        "deployment_num": 0,
        "device_num": 0,
        "upgrade_history": [],
        "ief_node_version": "",
        "comment": "",
        "ca": "",
        "relation": "",
        "certificate": "",
        "private_key": "",
        "attributes": [],
        "package": "",
        "tags": null,
        "product_id": "",
        "mqtt_mode": "internal",
        "mqtt_internal": "tls://docker0:8883,tls://127.0.0.1:8883",
        "mqtt_external": "",
        "enable_npu": false,
        "docker_enable": true,
        "npu_num": 0,
        "npu_info": [],
        "node_type": "",
        "ntp_configs": null,
        "nics": [],
        "error_reason": "",
        "container_runtime_version": ""
    }
}

错误码

请参见错误码