文档首页> 智能边缘平台 IEF> API参考> API> 终端设备管理> 更新终端设备孪生
更新时间：2024-04-22 GMT+08:00
查看PDF

更新终端设备孪生

功能介绍

该API用于更新终端设备孪生。

URI

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

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

名称

是否必选

参数类型

说明

twin

否

Object

终端设备动态属性，最多64个键值。

key为属性名称，value格式请参见表7，示例如下。

"twin": {
            "devicestate": {
                "optional": true,
                "expected": {
                    "value": "running"
                },
                "metadata": {
                    "type": "string"
                }
            }
        }

property_visitors

否

表25 object

孪生属性配置，与access_protocol关联。

请求示例

{
    "twin": {
        "devicestate": {
            "expected": {
                "value": "running"
            }
        }
    },
    "property_visitors": {}
}

响应消息

响应参数
表4 响应Body参数

名称

参数类型

说明

twin

Object

终端设备动态属性，最多64个键值。

key为属性名称，value格式请参见表21，示例如下。

"devicestate":{ 
                      "expected":{ 
                           "value":"running", 
                           "metadata":{ 
                                "timestamp":1536822119463 
                                } 
                           }, 
                     "optional":true, 
                     "metadata":{ "type":"string" } 
                     }

property_visitors

表25 object

孪生属性配置，与access_protocol关联。

响应示例

{
    "twin": {
        "devicestate": {
            "expected": {
                "value": "running",
                "metadata": {
                    "timestamp": 1523514289
                }
            },
            "actual": {
                "value": "stop",
                "metadata": {
                    "timestamp": 1523514289
                }
            },
            "optional": true,
            "metadata": {
                "type": "string"
            }
        }
    }，
    "property_visitors": {}
}

错误码

请参见错误码。

父主题： 终端设备管理