文档首页/ 智能边缘平台 IEF/ API参考/ API/ 终端设备管理/ 更新终端设备的边缘节点
更新时间:2023-11-29 GMT+08:00
分享

更新终端设备的边缘节点

功能介绍

该API用于更新终端设备的边缘节点。功能与更新边缘节点的终端设备相同,推荐使用更新边缘节点的终端设备。

调试

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

URI

PUT /v2/{project_id}/edgemgr/devices/{device_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

device_id

String

设备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参数

参数

是否必选

参数类型

描述

nodes

NodeUpdateByDevice object

边缘节点的终端设备信息

表4 NodeUpdateByDevice

参数

是否必选

参数类型

描述

added

NodeDeviceInfos object

要加入的节点详情

removed

Array of strings

要解绑的终端设备ID

表5 NodeDeviceInfos

参数

是否必选

参数类型

描述

relation

String

终端设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

comment

String

终端设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

node_ids

Array of strings

节点ID列表,一个设备只可以被绑定于一个边缘节点。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

update_nodes

NodeUpdateByDevice object

边缘节点的终端设备信息

表7 NodeUpdateByDevice

参数

参数类型

描述

added

NodeDeviceInfos object

要加入的节点详情

removed

Array of strings

要解绑的终端设备ID

表8 NodeDeviceInfos

参数

参数类型

描述

relation

String

终端设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

comment

String

终端设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

node_ids

Array of strings

节点ID列表,一个设备只可以被绑定于一个边缘节点。

请求示例

添加终端设备的边缘节点,指定节点ID。

{
  "nodes" : {
    "added" : {
      "node_ids" : [ "592ede18-d030-4cc1-afb8-34ac1bae47f6" ],
      "relation" : "abcd",
      "comment" : "hello world"
    },
    "removed" : [ ]
  }
}

响应示例

状态码: 200

更新成功

{
  "update_nodes" : {
    "removed" : [ ],
    "added" : {
      "comment" : "hello world",
      "relation" : "abcd",
      "node_ids" : [ "592ede18-d030-4cc1-afb8-34ac1bae47f6" ]
    }
  }
}

状态码

状态码

描述

200

更新成功

错误码

请参见错误码

相关文档