文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 边缘节点管理/ 修改边缘节点

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

查看PDF

修改边缘节点

功能介绍

修改边缘节点

调试

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

URI

PUT /v2/{project_id}/edge-nodes/{edge_node_id}

表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

表3 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	边缘节点名称，只允许中、数字、英文大小写、中划线、下划线最小长度：1 最大长度：64
storage_period	否	Integer	节点的存储周期，默认0天，取值范围0~7天，0天则不存储。最小值：0 最大值：7
log_configs	否	Array of LogConfigDTO objects	边缘节点在IEF日志配置参数数组长度：0 - 10
ha_config	否	HaConfigDTO object	高可用配置参数
hardware_model	否	String	网关型号最小长度：0 最大长度：1024
npu_library_path	否	String	npu驱动动态库路径最小长度：0 最大长度：256
automatic_upgrade	否	String	自动升级系统应用的节点开关，默认为关闭：OFF，IMMEDIATE表示节点开关打开最小长度：0 最大长度：16
device_data_record	否	DeviceDataRecord object	边缘节点设备数据上报打印配置
metric_report	否	String	omagent监控运维工具是否上报指标最小长度：0 最大长度：16
offline_cache_configs	否	UpdateOfflineCacheConfigsDTO object	边缘节点离线缓存配置

表4 LogConfigDTO
参数	是否必选	参数类型	描述
size	否	Integer	应用日志文件大小限制，单位MB，默认50，取值范围10-1000 最小值：10 最大值：1000
level	否	String	应用日志级别，可选项：on/off/trace/debug/info/warn/error/fatal，当type为LTS时有效。当选择非on/off的选项时，将只采集大于等于指定级别的日志。
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 边缘设备上系统的日志

表5 HaConfigDTO
参数	是否必选	参数类型	描述
ha_type	否	String	节点高可用类型双活或者主备缺省值：ACTIVE_STANDBY
active_standby_config	否	ActiveStandbyConfigDTO object	主备详细配置

表6 ActiveStandbyConfigDTO
参数	是否必选	参数类型	描述
work_node	否	String	当前的工作节点，主节点还是备节点在工作，初始创建时工作节点为DEFAULT节点，(DEFAULT\|MASTER\|SLAVE) 缺省值：DEFAULT 最小长度：1 最大长度：64
master_interface_name	否	String	主节点网卡名称最小长度：1 最大长度：64
slave_interface_name	否	String	备节点网卡名称最小长度：1 最大长度：64
virtual_ip_address	否	String	网卡ip 最小长度：0 最大长度：64
virtual_ipv6_address	否	String	网卡ipv6地址最小长度：0 最大长度：64

表7 DeviceDataRecord
参数	是否必选	参数类型	描述
disk_quota	是	Integer	磁盘配额，单位MB，参考值，只能保证在这个值左右最小值：512 最大值：10240 缺省值：512
age	是	Integer	老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除最小值：1 最大值：7 缺省值：1
state	是	String	配置开关，true启用数据打印，false不启用数据打印最小长度：0 最大长度：16

表8 UpdateOfflineCacheConfigsDTO
参数	是否必选	参数类型	描述
capacity	否	Integer	节点离线缓存容量，单位MB，默认2048，取值范围500-65536 最小值：500 最大值：65536 缺省值：2048

响应参数

状态码： 200

表9 响应Body参数
参数	参数类型	描述
log_configs	Array of LogConfigDTO objects	边缘节点在IEF的日志配置数组长度：0 - 10
ha_config	HaConfigDTO object	节点根目录配置
edge_node_id	String	边缘节点Id 最小长度：1 最大长度：64
instance_id	String	实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。最小长度：1 最大长度：36
product_id	String	边缘节点关联的产品ID，用于唯一标识一个产品模型。最小长度：1 最大长度：36
product_name	String	边缘节点关联的产品名称。最小长度：1 最大长度：64
space_id	String	资源空间id，对应IOTDA云服务接口参数中的app_id。最小长度：1 最大长度：64
resource_spec_types	Array of strings	节点所购买的资源类型的列表最小长度：4 最大长度：16
resource_ids	Array of strings	资源id列表，创建节点时需绑定已购买的资源包，可以叠加节点功能。最小长度：1 最大长度：64
ips	Array of strings	边缘节点主机ip 数组长度：0 - 10
name	String	边缘节点名称最小长度：1 最大长度：64
state	String	边缘节点状态最小长度：4 最大长度：32
software_version	String	边缘应用id，只允许数字、英文小写、中划线，且必须以字母或数字结尾最小长度：0 最大长度：32
create_time	String	边缘节点创建时间最小长度：0 最大长度：256
update_time	String	边缘节点更新时间最小长度：0 最大长度：256
os_name	String	边缘节点操作系统。例如：Ubuntu 20.04；CentOS 7.9。不同于os_type边缘节点系统类型。最小长度：1 最大长度：64
arch	String	边缘节点系统架构。包括：arm64，arm32，x86_64。最小长度：4 最大长度：16
host_name	String	边缘节点主机名最小长度：1 最大长度：256
nics	Array of Nic objects	边缘节点网络网卡信息数组长度：0 - 10
specification	String	网络规格，如4 cores \| 3867 MB 最小长度：0 最大长度：64
ai_card_type	String	AI加速卡类型，如昇腾AI加速卡NPU、图像处理加速卡GPU。最小长度：0 最大长度：16
npu_library_path	String	npu驱动动态库路径最小长度：0 最大长度：256
container_version	String	容器运行时版本最小长度：0 最大长度：64
type	String	边缘节点类型：lite\|advanced\|standard。lite表示基础版边缘节点，advanced或standard表示专业版边缘节点。最小长度：4 最大长度：16
security_level	String	节点的安全等级，MEDIUM边缘节数据上报不进行加密，HIGH对数据上报进行加密。最小长度：1 最大长度：64
reliability_level	String	节点的可靠性等级，LOW表示中级别，MEDIUM表示高级别。详细功能请参考“用户指南>管理边缘节点>注册节点”。缺省值：LOW 最小长度：1 最大长度：64
storage_period	Integer	节点的存储周期，默认0天，取值范围0~7天，0天则不存储。最小值：0 最大值：7
base_path	BasePathDTO object	节点根目录配置
hardware_model	String	注册节点网关配置最小长度：0 最大长度：1024
offline_cache_configs	OfflineCacheConfigsDTO object	边缘节点离线缓存配置
device_auth_info	DeviceAuthInfoDisplayDTO object	边缘节点设备认证方式
device_data_format	String	节点使用的数据格式，默认为iotda物模型1.0格式，可以选择属性平铺数据格式flat_json 最小长度：0 最大长度：16
automatic_upgrade	String	自动升级系统应用的节点开关，默认为关闭：OFF，IMMEDIATE表示节点开关打开最小长度：0 最大长度：16
device_data_record	DeviceDataRecord object	边缘节点设备数据上报打印配置
metric_report	String	omagent监控运维工具是否上报指标最小长度：0 最大长度：16
iotda_south_access	String	iotda南向接入地址最小长度：0 最大长度：128
tpm_info	TPMInfoDTO object	TPM芯片信息
runtime_info	RuntimeInfoDTO object	边缘软件运行时信息
os_type	String	边缘节点系统类型。包括：generalLinux通用系统，openHarmony鸿蒙系统。缺省值：generalLinux 最小长度：2 最大长度：32

**表10** LogConfigDTO
参数	参数类型	描述
size	Integer	应用日志文件大小限制，单位MB，默认50，取值范围10-1000 最小值：10 最大值：1000
level	String	应用日志级别，可选项：on/off/trace/debug/info/warn/error/fatal，当type为LTS时有效。当选择非on/off的选项时，将只采集大于等于指定级别的日志。
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 边缘设备上系统的日志

**表11** HaConfigDTO
参数	参数类型	描述
ha_type	String	节点高可用类型双活或者主备缺省值：ACTIVE_STANDBY
active_standby_config	ActiveStandbyConfigDTO object	主备详细配置

**表12** ActiveStandbyConfigDTO
参数	参数类型	描述
work_node	String	当前的工作节点，主节点还是备节点在工作，初始创建时工作节点为DEFAULT节点，(DEFAULT\|MASTER\|SLAVE) 缺省值：DEFAULT 最小长度：1 最大长度：64
master_interface_name	String	主节点网卡名称最小长度：1 最大长度：64
slave_interface_name	String	备节点网卡名称最小长度：1 最大长度：64
virtual_ip_address	String	网卡ip 最小长度：0 最大长度：64
virtual_ipv6_address	String	网卡ipv6地址最小长度：0 最大长度：64

**表13** Nic
参数	参数类型	描述
eth	String	网卡信息，如eth0,eth1 最小长度：0 最大长度：32
ip	String	网卡ip 最小长度：0 最大长度：64
mask_len	Integer	子网掩码的位数最小值：0 最大值：32

**表14** BasePathDTO
参数	参数类型	描述
log_base_path	String	节点日志根目录最小长度：1 最大长度：64
config_base_path	String	节点配置根目录最小长度：1 最大长度：64
db_base_path	String	节点数据存储根目录最小长度：1 最大长度：64

**表15** OfflineCacheConfigsDTO
参数	参数类型	描述
publish_order	String	数据上报优先级，可选项：realtime_first实时数据优先 sequential按时序上报，默认realtime_first 缺省值：realtime_first
period	Integer	节点离线缓存数据的储存天数，默认7，取值范围-1~14，-1表示存储天数没有限制最小值：-1 最大值：14 缺省值：7
capacity	Integer	节点离线缓存容量，单位MB，默认2048，取值范围500-65536 最小值：500 最大值：65536 缺省值：2048
channel_cache_state	String	路由转发开启离线缓存最小长度：2 最大长度：3

**表16** DeviceAuthInfoDisplayDTO
参数	参数类型	描述
auth_type	String	边缘节点认证方式。缺省值：SECRET
local_path	CertificateLocalPathDTO object	证书文件的本地存储路径

**表17** CertificateLocalPathDTO
参数	参数类型	描述
cert_path	String	节点数字证书的本地存储路径。最小长度：1 最大长度：2048
key_path	String	证书私钥的本地存储路径。最小长度：1 最大长度：2048

**表18** DeviceDataRecord
参数	参数类型	描述
disk_quota	Integer	磁盘配额，单位MB，参考值，只能保证在这个值左右最小值：512 最大值：10240 缺省值：512
age	Integer	老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除最小值：1 最大值：7 缺省值：1
state	String	配置开关，true启用数据打印，false不启用数据打印最小长度：0 最大长度：16

**表19** TPMInfoDTO
参数	参数类型	描述
manufacture_id	String	厂商信息最小长度：0 最大长度：64
spec_version	String	协议版本最小长度：0 最大长度：64

**表20** RuntimeInfoDTO
参数	参数类型	描述
enable_tpm	Boolean	是否启用TPM 缺省值：false

请求示例

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

{
  "name" : "test-node",
  "storage_period" : 0,
  "log_configs" : [ {
    "size" : 1000,
    "level" : "string",
    "rotate_num" : 10,
    "rotate_period" : "string",
    "type" : "LTS",
    "component" : "string"
  } ],
  "ha_config" : {
    "ha_type" : "ACTIVE_STANDBY",
    "active_standby_config" : null,
    "work_node" : "DEFAULT",
    "master_interface_name" : "eth0",
    "slave_interface_name" : "eth0",
    "virtual_ip_address" : "127.0.0.1",
    "virtual_ipv6_address" : "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789"
  },
  "hardware_model" : "string",
  "npu_library_path" : "/usr/local/Ascend/driver/lib64/",
  "automatic_upgrade" : "OFF",
  "device_data_record" : {
    "disk_quota" : 512,
    "age" : 7,
    "state" : "off"
  },
  "metric_report" : "on",
  "offline_cache_configs" : {
    "publish_order" : "realtime_first",
    "period" : 7,
    "capacity" : 2048
  }
}

响应示例

无

状态码

状态码	描述
200	Ok
401	Bad Request
500	Internal Server Error

错误码

请参见错误码。

父主题： 边缘节点管理

上一篇：查询边缘节点列表

下一篇：查询边缘节点详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

修改边缘节点

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线