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

更新终端设备的边缘节点

功能介绍

该API用于更新终端设备的边缘节点。

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

URI

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

表1 Path参数

参数

是否必选

描述

project_id

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

device_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参数

名称

是否必选

参数类型

说明

nodes

表4 object

节点信息

表4 node

名称

是否必选

参数类型

说明

added

表5 object

要加入的节点详情

removed

Array of strings

要解绑的边缘节点ID

表5 added

名称

是否必选

参数类型

说明

relation

String

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

comment

String

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

node_ids

Array of strings

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

请求示例

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

响应消息

响应参数

表6 响应Body参数

名称

参数类型

说明

update_nodes

表7 object

节点信息

表7 update_nodes

名称

参数类型

说明

added

表8 object

要加入的节点详情

removed

Array of strings

要解绑的边缘节点ID

表8 added

名称

参数类型

说明

relation

String

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

comment

String

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

node_ids

Array of strings

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

响应示例

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

错误码

请参见错误码