更新边缘节点的终端设备
功能介绍
该API用于添加或删除边缘节点的终端设备。
URI
PUT /v2/{project_id}/edgemgr/nodes/{node_id}/devices
参数 |
是否必选 |
描述 |
---|---|---|
project_id |
是 |
项目ID,获取方法请参见获取项目ID。 |
node_id |
是 |
节点ID |
请求消息
参数 |
是否必选 |
类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) 推荐您使用默认值application/json。 |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
ief-instance-id |
否 |
String |
铂金版实例ID,专业版实例为空值 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
devices |
是 |
表4 object |
终端设备信息 |
请求示例
{ "devices":{ "added":{ "relation":"This_is_a_test_relation", "comment":"This is a test comment", "device_ids": [ "c59d8205-e786-4455-8883-12578a34ae90" ] } } }
响应消息
响应参数
名称 |
参数类型 |
说明 |
---|---|---|
delete_connector |
Boolean |
工业终端设备预留字段 |
deploy_connector |
Array of strings |
工业终端设备预留字段 |
deployment_id |
String |
工业终端设备预留字段 |
update_devices |
表7 object |
终端设备操作详情 |
名称 |
参数类型 |
说明 |
---|---|---|
relation |
String |
终端设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 |
comment |
String |
终端设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \ |
device_ids |
Array of strings |
终端设备ID列表 |
响应示例
{ "delete_connector": false, "deploy_connector": false, "deployment_id": "", "update_devices": { "added": { "comment": "This is a test comment", "device_ids": [ "114a9718-052d-4152-a4f5-cd7ab84e6fad" ], "relation": "This_is_a_test_relation" } } }
错误码
请参见错误码。