文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 模块影子管理/ 更新模块影子
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

更新模块影子

功能介绍

更新模块影子信息

调试

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

URI

PUT /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/shadow

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

edge_node_id

是

String

边缘节点ID

最小长度：1

最大长度：64

module_id

是

String

边缘模块ID

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

最小长度：0

最大长度：20000
表3 请求Body参数

参数

是否必选

参数类型

描述

properties

否

Object

应用配置内容

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

properties

Object

应用配置内容

properties_update_time

Object

应用配置更新时间

请求示例

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

{
  "properties" : {
    "connect_info" : {
      "endpoint" : "string",
      "user_name" : "string",
      "password" : "string"
    },
    "channels" : [ {
      "device_id" : "string",
      "peer_session_name" : "string",
      "pin_code" : "string",
      "role_type" : "string"
    } ]
  }
}

响应示例

状态码： 200

模块影子详细信息

{
  "properties" : {
    "connect_info" : {
      "endpoint" : "string",
      "user_name" : "string",
      "password" : "string"
    },
    "channels" : [ {
      "device_id" : "string",
      "peer_session_name" : "string",
      "pin_code" : "string",
      "role_type" : "string"
    } ]
  },
  "properties_update_time" : {
    "connection_info" : 1676883583449,
    "channels" : 1676883583449,
    "default_values" : 1676883583449
  }
}

状态码

状态码

描述

200

模块影子详细信息

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 模块影子管理

相关文档