更新时间:2022-05-05 GMT+08:00
分享

创建边缘节点

功能介绍

创建边缘节点

调试

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

URI

POST /v2/{project_id}/edge-nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

name

String

边缘节点名称,只允许中、数字、英文大小写、中划线、下划线

最小长度:1

最大长度:64

type

String

节点所属资源类型:advanced|standard

最小长度:4

最大长度:16

verify_code

String

边缘节点注册使用的验证码,如果不输入则平台随机生成。

最小长度:1

最大长度:36

time_out

Integer

验证码的有效时间单位秒,默认1800秒,范围为1~864000,过期后平台会随机生成。

最小值:1

最大值:864000

缺省值:1800

arch

String

系统架构。包括:arm64,arm32,x86_64。

最小长度:4

最大长度:16

instance_id

String

实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

最小长度:1

最大长度:36

space_id

String

资源空间id,对应IOTDA云服务接口参数中的app_id。

最小长度:1

最大长度:64

resource_ids

Array of strings

资源id列表,创建节点时需绑定已购买的资源包,资源可叠加。

最小长度:1

最大长度:64

security_level

String

节点的安全等级,MEDIUM表示本地明文存储,HIGH表示本地加密存储。

缺省值:MEDIUM

最小长度:1

最大长度:64

storage_period

Integer

节点的存储周期,默认0天,取值范围0~7天,0天则不存储。

最小值:0

最大值:7

缺省值:0

ai_card_type

String

华为AI加速卡类型,如NPU、GPU。

缺省值:UNEQUIPPED

最小长度:0

最大长度:16

base_path

BasePathDTO object

节点根目录。

log_configs

Array of LogConfigDTO objects

边缘节点在IEF日志配置参数,仅高级版支持。

apps

Array of EdgeAppInstanceDTO objects

用户预置第三方边缘应用

hardware_model

String

网关型号

最小长度:0

最大长度:1024

表4 BasePathDTO

参数

是否必选

参数类型

描述

log_base_path

String

节点日志根目录

最小长度:1

最大长度:64

config_base_path

String

节点配置根目录

最小长度:1

最大长度:64

db_base_path

String

节点数据存储根目录

最小长度:1

最大长度:64

表5 LogConfigDTO

参数

是否必选

参数类型

描述

size

Integer

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

最小值:10

最大值:1000

level

String

应用日志级别,可选项:on/off,当type为LTS时有效

rotate_num

Integer

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

最小值:1

最大值:10

rotate_period

String

应用日志rotate周期,可选项: daily/monthly/weekly/yearly

type

String

LTS:将日志发送到LTS, local 本地日志

缺省值:LTS

component

String

app:部署到边缘设备上的应用的日志, system 边缘设备上系统的日志

表6 EdgeAppInstanceDTO

参数

是否必选

参数类型

描述

edge_app_id

String

边缘应用id,只允许数字、英文小写、中划线,切必须以字母或数字结尾

最小长度:4

最大长度:32

app_version

String

边缘应用版本,只允许数字、英文小写、中划线,切必须以字母或数字结尾

最小长度:0

最大长度:64

响应参数

状态码: 201

表7 响应Body参数

参数

参数类型

描述

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

name

String

边缘节点名称

最小长度:1

最大长度:64

instance_id

String

实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

最小长度:1

最大长度:36

space_id

String

资源空间id,对应IOTDA云服务接口参数中的app_id。

最小长度:1

最大长度:64

product_id

String

边缘节点关联的产品ID,用于唯一标识一个产品模型。

最小长度:1

最大长度:36

product_name

String

边缘节点关联的产品名称。

最小长度:1

最大长度:64

state

String

边缘节点状态UNINSTALLED|INSTALLED|OFFLINE|ONLINE|DELETING|FROZEN

最小长度:4

最大长度:32

type

String

节点所属资源类型:advanced|standard

最小长度:4

最大长度:16

installer_version

String

安装文件版本

最小长度:1

最大长度:64

base_path

BasePathDTO object

节点根目录配置

resource_ids

Array of strings

资源id列表,创建节点时需绑定已购买的资源包,可以叠加节点功能。

最小长度:1

最大长度:64

ips

Array of strings

边缘节点ip列表

create_time

String

边缘节点创建时间

最小长度:0

最大长度:256

hardware_model

String

注册节点网关配置

最小长度:0

最大长度:1024

表8 BasePathDTO

参数

参数类型

描述

log_base_path

String

节点日志根目录

最小长度:1

最大长度:64

config_base_path

String

节点配置根目录

最小长度:1

最大长度:64

db_base_path

String

节点数据存储根目录

最小长度:1

最大长度:64

请求示例

POST https://{endpoint}/v2/{project_id}/edge-nodes

响应示例

状态码

状态码

描述

201

Created

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读