华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。

URI DELETE /v5/iot/{project_id}/amqp-queues/{queue_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 queue_id 是 String 参数说明：队列ID，用于唯一标识一个队列。 取值范围：长度36位，只允许字母、数字、下划线（_）、连接符（-）的组合。

URI PUT /v5/iot/{project_id}/routing-rule/flowcontrol-policy/{policy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 policy_id 是 String 参数说明：数据流转流控策略id，用于唯一标识一个数据流转流控策略，在创建数据流转流控策略时由 物联网平台 分配获得。

响应示例 状态码： 200 Ok { "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34", "policy_name" : "policyName", "description" : "description", "scope" : "CHANNEL", "scope_value" : "HTTP_FORWARDING", "limit" : 10 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_name 否 String 参数说明：数据流转流控策略名称。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 description 否 String 参数说明：用户自定义的数据流转流控策略描述。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 limit 否 Integer 参数说明：数据转发流控大小。单位为tps，取值范围为1~1000的整数，默认为1000. 最小值：1 最大值：1000 缺省值：1000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policy_id String 参数说明：数据流转流控策略id，用于唯一标识一个数据流转流控策略，在创建数据流转流控策略时由物联网平台分配获得。 policy_name String 参数说明：数据流转流控策略名称。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 description String 参数说明：用户自定义的数据流转流控策略描述。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 scope String 参数说明：流控策略作用域. 取值范围： USER：租户级流控策略。 CHANNEL：转发通道级流控策略。 RULE：转发规则级流控策略。 ACTION：转发动作级流控策略。 scope_value String 参数说明：流控策略作用域附加值。 scope取值为USER时，可不携带该字段，表示租户级流控。 scope取值为CHANNEL时，取值范围：HTTP_FORWARDING、DIS_FORWARDING、OBS_FORWARDING、AMQP_FORWARDING、DMS_KAFKA_FORWARDING。 scope取值为RULE时，该字段为对应的ruleId。 scope取值为ACTION时，该字段为对应的actionId。 limit Integer 参数说明：数据转发流控大小。单位为tps，取值范围为1~1000的整数，默认为1000. 最小值：1 最大值：1000 缺省值：1000

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 表4 请求Body参数 参数 是否必选 参数类型 描述 secret 否 String 参数说明：设备密钥，设置该字段时平台将设备密钥重置为指定值，若不设置则由平台自动生成。 取值范围：长度不低于8不超过32，只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：8 最大长度：32 force_disconnect 否 Boolean 参数说明：是否强制断开设备的连接，当前仅限长连接。默认值false。 缺省值：false secret_type 否 String 参数说明：重置设备密钥的的类型。 取值范围： PRIMARY：重置主密钥。设备密钥鉴权优先使用的密钥，当设备接入物联网平台时，平台将优先使用主密钥进行校验。 SECONDARY：重置辅密钥。设备的备用密钥，当主密钥校验不通过时，会启用辅密钥校验，辅密钥与主密钥有相同的效力；辅密钥对coap协议接入的设备不生效。 缺省值：PRIMARY

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。 最大长度：256 secret String 设备密钥。 最小长度：8 最大长度：32 secret_type String 参数说明：重置设备密钥的的类型。 取值范围： PRIMARY：重置主密钥。设备密钥鉴权优先使用的密钥，当设备接入物联网平台时，平台将优先使用主密钥进行校验。 SECONDARY：重置辅密钥。设备的备用密钥，当主密钥校验不通过时，会启用辅密钥校验，辅密钥与主密钥有相同的效力；辅密钥对coap协议接入的设备不生效。 缺省值：PRIMARY

URI POST /v5/iot/{project_id}/devices/{device_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 表2 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 参数说明：对设备执行的操作。 取值范围： resetSecret: 重置密钥。注意：NB设备密钥由于协议特殊性，只支持十六进制密钥接入。

响应示例 状态码： 200 OK { "certificates" : [ { "certificate_id" : "string", "cn_name" : "string", "owner" : "string", "status" : true, "verify_code" : "string", "create_date" : "20191212T121212Z", "effective_date" : "20191212T121212Z", "expiry_date" : "20221212T121212Z", "provision_enable" : true, "template_id" : "61c970ce2d63eb6ee655dbf0" } ], "page" : { "count" : 100, "marker" : "5c8f3d2d3df1f10d803adbda" } }

URI GET /v5/iot/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 否 String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的证书列表，不携带该参数则会查询该用户下所有证书列表。 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：ffffffffffffffffffffffffffffffffffff offset 否 Integer 表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 最小值：0 最大值：500 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 certificates Array of CertificatesRspDTO objects 证书列表。 page Page object 查询结果的分页信息。 表5 CertificatesRspDTO 参数 参数类型 描述 certificate_id String CA证书ID，在上传CA证书时由平台分配的唯一标识。 cn_name String CA证书CN名称。 owner String CA证书所有者。 status Boolean CA证书验证状态。true代表证书已通过验证，可进行设备证书认证接入。false代表证书未通过验证。 verify_code String CA证书验证码。 provision_enable Boolean 是否开启自注册能力，当为true时该功能必须配合预调配功能使用，true：是，false：否。 template_id String 绑定的预调配模板ID。 create_date String 创建证书日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 effective_date String CA证书生效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 expiry_date String CA证书失效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 表6 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数。 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。。 Instance-Id 否 String 实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。

AT+HMPKS 该指令用于设置服务器或者客户端证书。 指令 参数 参数缺省处理 AT响应结果 使用示例 AT+HMPKS =type, para1,[para2] type=0，表示平台证书，证书在para1中。 type=1，表示设备公钥证书，证书在para1中。 type=2，表示设备私钥证书，证书在para1中，密码在para2中。 para1用于存放证书，当为空时表示清除证书。 para2用于存放私钥证书的密码，只有当设置私钥证书时有效，并且证书以字符串格式传输PEM。 自定义 +HMPKS OK when success +HMPKS ERR when failed AT+HMPKS = 0,"SERVER_CA" 证书中不要包含“"” 父主题： 模组AT指令参考

功能介绍 用于平台设置设备属性。设备的产品模型中定义了平台可向设备设置的属性，平台可调用此修改设备属性接口设置指定设备的属性数据。设备收到属性设置请求后，需要将执行结果返回给平台，如果设备没回响应平台会认为属性设置请求执行超时。 低配置且资源受限或者对网络流量有要求的设备，不适合直接构造JSON数据与物联网平台通信时，可将原始二进制数据透传到物联网平台。通过开发编解码插件实现二进制数据到平台定义JSON格式的转换。

Topic 下行: $oc/devices/{device_id}/sys/properties/set/request_id={request_id} 上行: $oc/devices/{device_id}/sys/properties/set/response/request_id={request_id} 应用修改设备属性时，平台会生成唯一ID用于标识该请求。同时该唯一标识会通过平台设置设备属性下行Topic中的requst_id携带给设备。 设备无法提前感知该request_id，在订阅该Topic时请使用通配符“#”来替代“request_id={request_id}”即为：$oc/devices/{device_id}/sys/properties/set/#。

下行请求示例 Topic: $oc/devices/{device_id}/sys/properties/set/request_id={request_id} 数据格式： { "services": [{ "service_id": "Temperature", "properties": { "value": 57, "value2": 60 } }, { "service_id": "Battery", "properties": { "level": 80, "level2": 90 } } ] }

请求示例 设备更新通知示例： 设备更新通知 { "resource" : "device", "event" : "update", "event_time" : "20151212T121212Z", "event_time_ms" : "2015-12-12T12:12:12.000Z", "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776", "notify_data" : { "body" : { "device_sdk_version" : "C_v0.5.0", "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "create_time" : "20190303T081011Z", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secure_access" : true, "timeout" : 300 }, "product_name" : "Thermometer", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "sw_version" : "1.1.0", "tags" : [ { "tag_value" : "testTagValue", "tag_key" : "testTagName" } ], "extension_info" : { "aaa" : "xxx", "bbb" : 0 }, "app_name" : "testAPP01", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "fw_version" : "1.1.0", "node_id" : "ABC123456789", "status" : "INACTIVE" } } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource 是 String 参数说明：订阅的资源名称，取值为device。 event 是 String 参数说明：订阅的资源事件，取值为update。 event_time 是 String 参数说明：资源事件生成时间,格式：yyyyMMdd'T'HHmmss'Z' UTC字符串，如：20151212T121212Z。若需要显示本地时区，您需要自己进行时间转换。 event_time_ms 否 String 参数说明：资源事件生成时间,格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' UTC字符串，如：2015-12-12T12:12:12.000Z。若需要显示本地时区，您需要自己进行时间转换。 request_id 否 String 参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。 notify_data 是 DeviceCreateOrUpdateNotifyData object 参数说明：推送消息。 表2 DeviceCreateOrUpdateNotifyData 参数 是否必选 参数类型 描述 body 是 QueryDeviceBase object 参数说明：推送消息内容。 表3 QueryDeviceBase 参数 是否必选 参数类型 描述 app_id 否 String 参数说明：资源空间ID。 最大长度：36 app_name 否 String 参数说明：资源空间名称。 device_id 否 String 参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。 最大长度：256 node_id 否 String 参数说明：设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最大长度：64 gateway_id 否 String 参数说明：网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。 最大长度：256 device_name 否 String 参数说明：设备名称。 最大长度：256 node_type 否 String 参数说明：设备节点类型。 ENDPOINT：非直连设备。 GATEWAY：直连设备或网关。 UNKNOWN：未知。 description 否 String 参数说明：设备的描述信息。 最大长度：2048 fw_version 否 String 参数说明：设备的固件版本。 最大长度：256 sw_version 否 String 参数说明：设备的软件版本。 最大长度：256 device_sdk_version 否 String 参数说明：设备的SDK版本。 最大长度：256 auth_info 否 AuthInfo object 参数说明：设备的接入认证信息。 product_id 否 String 参数说明：设备关联的产品ID，用于唯一标识一个产品模型。 product_name 否 String 参数说明：设备关联的产品名称。 status 否 String 参数说明：设备的状态。 ONLINE：设备在线。 OFFLINE：设备离线。 ABNORMAL：设备异常。 INACTIVE：设备未激活。 FREEZED：设备冻结。 create_time 否 String 参数说明：在物联网平台注册设备的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 tags 否 Array of TagV5DTO objects 参数说明：设备的标签列表。 extension_info 否 Object 参数说明：设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。 表4 AuthInfo 参数 是否必选 参数类型 描述 auth_type 否 String 参数说明：鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写secret字段，使用证书认证接入方式(CERTIFICATES)填写fingerprint字段，不填写auth_type默认为密钥认证接入方式(SECRET) secure_access 否 Boolean 参数说明：指设备是否通过安全协议方式接入，默认值为true。 true：通过安全协议方式接入。 false：通过非安全协议方式接入。 缺省值：true timeout 否 Integer 参数说明：设备验证码的有效时间，单位：秒，默认值：0。若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。注意：只有注册设备接口或者修改设备接口修改timeout时返回该参数。 最小值：0 最大值：2147483647 缺省值：0 表5 TagV5DTO 参数 是否必选 参数类型 描述 tag_key 是 String 参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 tag_value 否 String 参数说明：标签值。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。

响应示例 状态码： 200 OK { "batchtask" : { "task_id" : "5c8ba99030344005c02316ad", "task_name" : "testname", "task_type" : "softwareUpgrade", "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ], "targets_filter" : { "group_ids" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ] }, "document" : { "package_id" : "32822e5744a45ede319d2c50" }, "task_policy" : { "schedule_time" : "20151212T121212Z", "retry_count" : 5, "retry_interval" : 60 }, "status" : "Success", "status_desc" : "string", "task_progress" : { "total" : 0, "processing" : 0, "success" : 0, "fail" : 0, "waitting" : 0, "fail_wait_retry" : 0, "stopped" : 0 }, "create_time" : "20151212T121212Z" }, "task_details" : [ { "target" : "e495cf17-ff79-4294-8f64-4d367919d665", "status" : "Success", "output" : "success", "error" : { "error_code" : "IOTDA.000002", "error_msg" : "The request is unauthorized." } } ], "page" : { "count" : 10, "marker" : "5c90fa7d3c4e4405e8525079" } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 最小长度：1 最大长度：36

URI GET /v5/iot/{project_id}/batchtasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数说明：批量任务ID，创建批量任务时由物联网平台分配获得。 取值范围：长度不超过24，只允许小写字母a到f、数字的组合。 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 task_detail_status 否 String 参数说明：子任务的执行状态，可选参数。 取值范围： Success: 成功。 Fail: 失败。 Processing: 执行中。 FailWaitRetry: 失败重试。 Stopped: 已停止。 Waitting: 等待执行。 Removed: 已移除。 target 否 String 参数说明：执行批量任务的目标，当task_type为firmwareUpgrade，softwareUpgrade，deleteDevices，freezeDevices，unfreezeDevices，createCommands，createAsyncCommands，createMessages，updateDeviceShadows，此处填写device_id 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 limit 否 Integer 参数说明：分页查询时每页显示的记录数。 取值范围：1-50的整数，默认值为10。 最小值：1 最大值：50 缺省值：10 marker 否 String 参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。 缺省值：ffffffffffffffffffffffff offset 否 Integer 参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。 最小值：0 最大值：500 缺省值：0

请求示例 产品更新通知示例： 产品更新通知 { "resource" : "product", "event" : "update", "event_time" : "20151212T121212Z", "event_time_ms" : "2015-12-12T12:12:12.000Z", "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776", "notify_data" : { "body" : { "app_name" : "testAPP01", "protocol_type" : "CoAP", "data_format" : "binary", "service_capabilities" : [ { "service_type" : "temperature", "service_id" : "temperature", "description" : "temperature", "properties" : [ { "unit" : "centigrade", "min" : "1", "method" : "R", "max" : "100", "data_type" : "decimal", "description" : "force", "step" : 0.1, "default_value" : { "color" : "red", "size" : 1 }, "enum_list" : [ "string" ], "required" : true, "property_name" : "temperature", "max_length" : 100 } ], "commands" : [ { "command_name" : "reboot", "responses" : [ { "response_name" : "ACK", "paras" : [ { "unit" : "km/h", "min" : "1", "max" : "100", "para_name" : "force", "data_type" : "string", "description" : "force", "step" : 0.1, "enum_list" : [ "string" ], "required" : false, "max_length" : 100 } ] } ], "paras" : [ { "unit" : "km/h", "min" : "1", "max" : "100", "para_name" : "force", "data_type" : "string", "description" : "force", "step" : 0.1, "enum_list" : [ "string" ], "required" : false, "max_length" : 100 } ] } ], "events" : [ { "event_type" : "reboot", "paras" : [ { "unit" : "km/h", "min" : "1", "max" : "100", "para_name" : "force", "data_type" : "string", "description" : "force", "step" : 0.1, "enum_list" : [ "string" ], "required" : false, "max_length" : 100 } ] } ], "option" : "Mandatory" } ], "create_time" : "20190303T081011Z", "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "description" : "this is a thermometer produced by Huawei", "device_type" : "Thermometer", "industry" : "smartCity", "manufacturer_name" : "ABC", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka" } } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource 是 String 参数说明：订阅的资源名称，取值为product。 event 是 String 参数说明：订阅的资源事件，取值为update。 event_time 是 String 参数说明：资源事件生成时间,格式：yyyyMMdd'T'HHmmss'Z' UTC字符串，如：20151212T121212Z。若需要显示本地时区，您需要自己进行时间转换。 event_time_ms 否 String 参数说明：资源事件生成时间,格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' UTC字符串，如：2015-12-12T12:12:12.000Z。若需要显示本地时区，您需要自己进行时间转换。 request_id 否 String 参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。 notify_data 是 ProductUpdateNotifyData object 参数说明：推送消息。 表2 ProductUpdateNotifyData 参数 是否必选 参数类型 描述 body 是 Product object 参数说明：推送消息内容。 表3 Product 参数 是否必选 参数类型 描述 app_id 否 String 参数说明：资源空间ID。 app_name 否 String 参数说明：资源空间名称。 product_id 否 String 参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 name 否 String 参数说明：产品名称。 device_type 否 String 参数说明：设备类型。 protocol_type 否 String 参数说明：设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF。 data_format 否 String 参数说明：设备上报数据的格式，取值范围：json，binary。 manufacturer_name 否 String 参数说明：厂商名称。 industry 否 String 参数说明：设备所属行业。 description 否 String 参数说明：产品的描述信息。 service_capabilities 否 Array of ServiceCapability objects 参数说明：设备的服务能力列表。 create_time 否 String 参数说明：在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 表4 ServiceCapability 参数 是否必选 参数类型 描述 service_id 是 String 参数说明：设备的服务ID。 service_type 是 String 参数说明：设备的服务类型。 properties 否 Array of ServiceProperty objects 参数说明：设备服务支持的属性列表。 commands 否 Array of ServiceCommand objects 参数说明：设备服务支持的命令列表。 events 否 Array of ServiceEvent objects 参数说明：设备服务支持的事件列表。 description 否 String 参数说明：设备服务的描述信息。 option 否 String 参数说明：指定设备服务是否必选。Master（主服务）, Mandatory（必选服务）, Optional（可选服务），目前本字段为非功能性字段，仅起到标识作用。默认为Optional（可选服务）。 缺省值：Optional 表5 ServiceProperty 参数 是否必选 参数类型 描述 property_name 是 String 参数说明：设备属性名称。 required 否 Boolean 参数说明：设备属性是否必选。默认为false。 缺省值：false data_type 是 String 参数说明：设备属性的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 enum_list 否 Array of strings 参数说明：设备属性的枚举值列表。 min 否 String 参数说明：设备属性的最小值。 最小长度：1 最大长度：16 max 否 String 参数说明：设备属性的最大值。 最小长度：1 最大长度：16 max_length 否 Integer 参数说明：设备属性的最大长度。 step 否 Double 参数说明：设备属性的步长。 unit 否 String 参数说明：设备属性的单位。 最大长度：16 method 是 String 参数说明：设备属性的访问模式。取值范围：RWE，RW，RE，WE，E，W，R。 R：属性值可读 W：属性值可写 E：属性值可订阅，即属性值变化时上报事件。 description 否 String 参数说明：设备属性的描述。 default_value 否 Object 参数说明：设备属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。 表6 ServiceCommand 参数 是否必选 参数类型 描述 command_name 是 String 参数说明：设备命令名称。 paras 否 Array of ServiceCommandPara objects 参数说明：设备命令的参数列表。 responses 否 Array of ServiceCommandResponse objects 参数说明：设备命令的响应列表。 表7 ServiceCommandResponse 参数 是否必选 参数类型 描述 paras 否 Array of ServiceCommandPara objects 参数说明：设备命令响应的参数列表。 response_name 是 String 参数说明：设备命令响应名称。 表8 ServiceEvent 参数 是否必选 参数类型 描述 event_type 是 String 参数说明：设备事件类型。 paras 否 Array of ServiceCommandPara objects 参数说明：设备事件的参数列表。 表9 ServiceCommandPara 参数 是否必选 参数类型 描述 para_name 是 String 参数说明：参数的名称。 required 否 Boolean 参数说明：参数是否必选。默认为false。 缺省值：false data_type 是 String 参数说明：参数的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 enum_list 否 Array of strings 参数说明：参数的枚举值列表。 min 否 String 参数说明：参数的最小值。 最小长度：1 最大长度：16 max 否 String 参数说明：参数的最大值。 最小长度：1 最大长度：16 max_length 否 Integer 参数说明：参数的最大长度。 step 否 Double 参数说明：参数的步长。 unit 否 String 参数说明：参数的单位。 最大长度：16 description 否 String 参数说明：参数的描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 bridge_name 是 String 网桥名称。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：64 bridge_id 否 String 网桥ID。取值范围：长度不超过36，只允许字母、数字、_-字符的组合。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 bridge_id String 网桥ID，用于唯一标识一个网桥。在注册网桥时直接指定，或者由物联网平台分配获得。 bridge_name String 网桥名称。 auth_info BridgeAuthInfo object 网桥鉴权信息 create_time String 在物联网平台注册网桥的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 表5 BridgeAuthInfo 参数 参数类型 描述 auth_type String 鉴权类型。当前支持密钥认证接入(SECRET)。使用密钥认证接入方式(SECRET)填写secret字段，不填写auth_type默认为密钥认证接入方式(SECRET)。 secret String 网桥密钥，认证类型使用密钥认证接入(SECRET)可填写该字段。

请求示例 设备状态变更通知示例： 设备状态变更通知 { "resource" : "device.status", "event" : "update", "event_time" : "20151212T121212Z", "event_time_ms" : "2015-12-12T12:12:12.000Z", "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776", "notify_data" : { "header" : { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "product_id" : "ABC123456789", "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "tags" : [ { "tag_value" : "testTagValue", "tag_key" : "testTagName" } ] } }, "body" : { "last_online_time" : "20151212T121212Z", "status" : "ONLINE", "status_update_time" : "2015-12-12T12:12:12.815Z" } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource 是 String 参数说明：订阅的资源名称，取值为device.status。 event 是 String 参数说明：订阅的资源事件，取值为update。 event_time 是 String 参数说明：资源事件生成时间,格式：yyyyMMdd'T'HHmmss'Z' UTC字符串，如：20151212T121212Z。若需要显示本地时区，您需要自己进行时间转换。 event_time_ms 否 String 参数说明：资源事件生成时间,格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' UTC字符串，如：2015-12-12T12:12:12.000Z。若需要显示本地时区，您需要自己进行时间转换。 request_id 否 String 参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。 notify_data 是 DeviceStatusUpdateNotifyDataV5 object 参数说明：推送消息。 表2 DeviceStatusUpdateNotifyDataV5 参数 是否必选 参数类型 描述 header 是 NotifyDataHeader object 参数说明：推送消息header。 body 是 DeviceStatusUpdate object 参数说明：推送消息body。 表3 NotifyDataHeader 参数 是否必选 参数类型 描述 app_id 否 String 参数说明：应用ID。 最大长度：256 device_id 否 String 参数说明：设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 最大长度：256 node_id 否 String 参数说明：设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最大长度：256 product_id 否 String 参数说明：产品ID，用于唯一标识一个产品，在注册产品时由物联网平台分配获得。 最大长度：256 gateway_id 否 String 参数说明：网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最大长度：256 tags 否 Array of TagV5DTO objects 参数说明：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。 表4 TagV5DTO 参数 是否必选 参数类型 描述 tag_key 是 String 参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 tag_value 否 String 参数说明：标签值。 表5 DeviceStatusUpdate 参数 是否必选 参数类型 描述 status 是 String 参数说明：设备当前的状态。 ONLINE：设备在线 OFFLINE：设备离线 ABNORMAL：设备异常 last_online_time 是 String 参数说明：最近一次上线时间。 status_update_time 是 String 参数说明：设备更新到当前状态的时间。

请求示例 假设最终通过编解码插件编码后的二进制value为c4 0d 5a 6e 96 0b c3 0e 2b 30 37，则下发样例如下： CON-PUT MID=48587, Token=2d82e7f54b, OptionSet={"Uri-Path":["19","1","0"], "Content-Format":"application/octet-stream"}, c4 0d 5a 6e 96 0b c3 0e 2b 30 37