华为云用户手册

响应示例 状态码： 200 OK { "device_groups" : [ { "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc", "name" : "GroupA", "description" : "群组A", "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8", "group_type" : "STATIC" } ] }

URI POST /v5/iot/{project_id}/devices/{device_id}/list-device-group 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由 物联网平台 分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。

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

URI GET /v5/iot/{project_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 否 String 参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的规则列表，不携带该参数则会查询该用户下所有规则列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 rule_type 否 String 参数说明：规则类型。此参数为非必选参数，指定对应的规则类型结果进行返回，不携带该参数则会返回所有类型规则。 取值范围： DEVICE_LINKAGE：云端联动规则。 DEVICE_SIDE：端侧规则。 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

响应示例 状态码： 200 Successful response { "rules" : [ { "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "app_type" : "GLOBAL", "select" : "*", "rule_name" : "rulename", "subject" : { "resource" : "device", "event" : "create" }, "description" : "description", "active" : true, "where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "app_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0" } ], "count" : 10, "marker" : "5c90fa7d3c4e4405e8525079" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 rules Array of RoutingRule objects 规则条件信息列表。 count Integer 满足查询条件的记录总数。 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 表5 RoutingRule 参数 参数类型 描述 rule_id String 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由物联网平台分配获得。 rule_name String 用户自定义的规则名称。 最小长度：1 最大长度：256 description String 用户自定义的规则描述。 最小长度：1 最大长度：256 subject RoutingRuleSubject object 资源事件信息，即资源变化事件。 app_type String 租户规则的生效范围，取值如下： GLOBAL：生效范围为租户级 APP：生效范围为资源空间级。 app_id String 资源空间ID select String 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。 最小长度：0 最大长度：2500 where String 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。 最小长度：0 最大长度：2500 active Boolean 规则条件的状态是否为激活。 表6 RoutingRuleSubject 参数 参数类型 描述 resource String 参数说明：资源名称。 取值范围： device：设备。 device.property：设备属性。 device.message：设备消息。 device.message.status：设备消息状态。 device.status：设备状态。 batchtask：批量任务。 product：产品。 device.command.status：设备异步命令状态。 最小长度：1 最大长度：50 event String 参数说明：资源事件。 取值范围：与资源有关，不同的资源，事件不同。event需要与resource关联使用，具体的“resource：event”映射关系如下： device：create（设备添加） device：delete（设备删除） device：update（设备更新） device.status：update （设备状态变更） device.property：report（设备属性上报） device.message：report（设备消息上报） device.message.status：update（设备消息状态变更） batchtask：update （批量任务状态变更） product：create（产品添加） product：delete（产品删除） product：update（产品更新） device.command.status：update（设备异步命令状态更新） 最小长度：1 最大长度：50

URI GET /v5/iot/{project_id}/routing-rule/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 resource 否 String 参数说明：订阅的资源名称。 取值范围： device：设备。 device.property：设备属性。 device.message：设备消息。 device.message.status：设备消息状态。 device.status：设备状态。 batchtask：批量任务。 product：产品。 device.command.status：设备异步命令状态。 最小长度：1 最大长度：50 event 否 String 参数说明：订阅的资源事件。 取值范围：与资源有关，不同的资源，事件不同。 event需要与resource关联使用，具体的“resource：event”映射关系如下： device：create（设备添加） device：delete（设备删除） device：update（设备更新） device.status：update （设备状态变更） device.property：report（设备属性上报） device.message：report（设备消息上报） device.message.status：update（设备消息状态变更） batchtask：update （批量任务状态变更） product：create（产品添加） product：delete（产品删除） product：update（产品更新） device.command.status：update（设备异步命令状态更新）。 最小长度：1 最大长度：50 app_type 否 String 参数说明：租户规则的生效范围。 取值范围： GLOBAL：生效范围为租户级。 APP：生效范围为资源空间级。如果类型为APP，可携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询默认资源空间下的规则列表。 app_id 否 String 参数说明：资源空间ID。此参数为非必选参数，携带app_id查询指定资源空间下的规则动作列表，不携带app_id则查询默认资源空间下的规则动作列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 rule_name 否 String 参数说明：用户自定义的规则名称 最小长度：1 最大长度：256 active 否 Boolean 参数说明：规则条件的状态是否为激活。 limit 否 Integer 参数说明：分页查询时每页显示的记录数。默认每页10条记录，最大设定每页50条记录。 取值范围：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

示例 Topic: $oc/devices/{device_id}/sys/events/up 数据格式： { "object_device_id": "{object_device_id}", "services": [{ "service_id": "$file_manager", "event_type": "download_result_report", "event_time": "20151212T121212Z", "paras": { "object_name": "c6b39067b0325db34663d3ef421a42f6_12345678_a.jpg", "result_code": 0， "status_code": 200, "status_description": "download success" } }] }

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

示例 Topic: $oc/devices/{device_id}/sys/events/down 数据格式： { "object_device_id": "{object_device_id}", "services": [{ "service_id": "$sub_device_manager", "event_type": "add_sub_device_notify", "event_time": "20151212T121212Z", "paras": { "devices": [{ "parent_device_id": "c6b39067b0325db34663d3ef421a42f6_12345678", "node_id": "subdevice11", "device_id": "2bb4ddba-fb56-4566-8577-063ad2f5a6cc", "name": "subDevice11", "description": null, "manufacturer_id": "ofo", "model": "twx2", "product_id": "c6b39067b0325db34663d3ef421a42f6", "fw_version": null, "sw_version": null, "status": "ONLINE" }], "version": 1 } }] }

请求示例 设备异步命令状态变更通知： 设备异步命令状态变更通知 { "resource" : "device.command.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" : { "result" : { "key" : "value" }, "created_time" : "20151212T121212Z", "sent_time" : "20151212T121212Z", "command_id" : "id", "delivered_time" : "20151212T131212Z", "response_time" : "20151212T131212Z", "status" : "SUC CES SFUL" } } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource 是 String 参数说明：订阅的资源名称，取值为device.command.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字符串。如：2019-03-03T08:10:11.000Z。若需要显示本地时区，您需要自己进行时间转换。 request_id 否 String 参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。 notify_data 是 DeviceCommandStatusUpdateNotifyDataV5 object 参数说明：推送消息。 表2 DeviceCommandStatusUpdateNotifyDataV5 参数 是否必选 参数类型 描述 header 是 NotifyDataHeader object 参数说明：推送消息header。 body 是 DeviceCommandStatusUpdate 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 DeviceCommandStatusUpdate 参数 是否必选 参数类型 描述 command_id 是 String 参数说明：命令id，唯一标识一条命令。 created_time 否 String 参数说明：命令的创建时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 sent_time 否 String 参数说明：物联网平台发送命令的时间，如果命令是立即下发， 则该时间与命令创建时间一致， 如果是缓存命令， 则是命令实际下发的时间。"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 delivered_time 否 String 参数说明：物联网平台将命令送达到设备的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 response_time 否 String 参数说明：设备响应命令的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 status 否 String 参数说明：下发命令的状态。 PENDING表示未下发,在物联网平台缓存着 EXPIRED表示命令已经过期，即缓存的时间超过设定的expireTime SENT表示命令正在下发 DELIVERED表示命令已送达设备 SUCCESSFUL表示命令已经成功执行 FAILED表示命令执行失败 TIMEOUT表示命令下发之后，没有收到设备确认或者响应结果而超时。 result 否 Object 参数说明：设备命令执行的详细结果，由设备返回，Json格式。

设备发送数据到物联网平台 设备接入物联网平台后，便可与物联网平台进行通信。设备可通过以下方式发送数据到物联网平台： 设备消息上报：设备无法按照产品模型中定义的属性格式进行数据上报时，将设备的自定义数据通过设备消息上报接口上报给平台，平台将设备上报的消息转发给应用服务器或华为云其他云服务上进行存储和处理。 设备属性上报：用于设备按产品模型中定义的格式将属性数据上报给平台。 网关批量属性上报：用于网关设备将多个设备的属性数据一次性上报给平台。

应用服务器下发指令给设备 设备接入物联网平台后，应用服务器可通过以下方式发送指令到设备。 平台消息下发：用于平台下发自定义格式的数据给设备。 平台设置设备属性：设备的产品模型中定义了平台可向设备设置的属性，应用服务器可通过属性设置的方式修改指定设备的属性值。 平台查询设备属性：应用服务器通过属性查询的方式，实时查询指定设备的属性数据。 平台命令下发：应用服务器按产品模型中定义的命令格式下发控制命令给设备。

示例 Topic: $oc/devices/{device_id}/sys/events/up 数据格式： { "object_device_id": "{object_device_id}", "services": [{ "service_id": "$sub_device_manager", "event_type": "sub_device_update_status", "event_time": "20151212T121212Z", "paras": { "device_statuses": [{ "device_id": "bf40f0c4-4022-41c6-a201-c5133122054a", "status": "ONLINE" }, { "device_id": "4459c0f7-10bb-4718-9b07-7a82c2d508a5", "status": "ONLINE" } ] } }] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 设备属性更新ID，用于唯一标识一条属性更新，在下发更新属性时由物联网平台分配获得。 response Object 设备上报的属性执行结果。Json格式，具体格式需要应用和设备约定。 error_code String 属性更新异常错误码。 error_msg String 属性更新异常错误信息。

请求示例 下发设备属性，服务id为Temperature的属性为value，值为57，服务id为Batter的属性为level，值为80。 PUT https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/properties { "services" : [ { "service_id" : "Temperature", "properties" : { "value" : 57 } }, { "service_id" : "Battery", "properties" : { "level" : 80 } } ] }

URI PUT /v5/iot/{project_id}/devices/{device_id}/properties 表1 路径参数 参数 是否必选 参数类型 描述 device_id 是 String 参数说明：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 services 否 Object 参数说明：设备执行的属性，Json格式，里面是一个个键值对，如果serviceId不为空，每个键都是profile中属性的参数名（paraName）;如果serviceId为空则由用户自定义属性格式。设属性示例：[{"service_id": "Temperature","properties": {"value": 57}},{"service_id": "Battery","properties": {"level": 80}}]，具体格式需要应用和设备约定, 最大长度为256KB。 最大长度：262144

网桥管理 API 说明 创建网桥 应用服务器可调用此接口网桥。 查询网桥列表 应用服务器可调用此接口查询所有网桥。 删除网桥 应用服务器可调用此接口删除网桥。 重置网桥密钥 应用服务器可调用此接口重置网桥密码。 设备策略管理 API 说明 创建设备策略 应用服务器可调用此接口创建设备策略。 查询设备策略列表 应用服务器可调用此接口查询所有设备策略。 删除设备策略 应用服务器可调用此接口删除设备策略。 查询设备策略详情 应用服务器可调用此接口查询设备策略详情。 更新设备策略信息 应用服务器可调用此接口更新设备策略信息。 绑定设备策略 应用服务器可调用此接口绑定设备策略。 解绑设备策略 应用服务器可调用此接口解绑设备策略。 查询设备策略绑定的目标列表 应用服务器可调用此接口查询该设备策略绑定的目标列表。 预调配模板管理管理 API 说明 创建预调配模板 应用服务器可调用此接口创建创建预调配模板。 查询预调配模板列表 应用服务器可调用此接口查询所有创建预调配模板。 删除预调配模板 应用服务器可调用此接口删除预调配模板。 查询预调配模板详情 应用服务器可调用此接口查询创建预调配模板详情。 更新指定id的预调配模板信息 应用服务器可调用此接口更新指定id的预调配模板信息。 预调配模板管理管理 API 说明 创建自定义鉴权 应用服务器可调用此接口创建自定义鉴权。 查询自定义鉴权列表 应用服务器可调用此接口查询所有自定义鉴权。 删除自定义鉴权 应用服务器可调用此接口删除自定义鉴权。 查询自定义鉴权详情 应用服务器可调用此接口查询自定义鉴权详情。 更新指定id的自定义鉴权 应用服务器可调用此接口更新指定id的自定义鉴权。

批量任务 API 说明 查询批量任务列表 查询物联网平台中批量任务列表，每一个任务又包括具体的任务内容、任务状态、任务完成情况统计等。 创建批量任务 创建批量处理任务，对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息、批量配置设备影子和批量更新设备任务。 查询批量任务 查询物联网平台中指定批量任务的信息，包括任务内容、任务状态、任务完成情况统计以及子任务列表等。 删除批量任务 应用服务器可调用此接口删除物联网平台中已经完成（状态为成功，失败，部分成功，已停止）的批量任务。 重试批量任务 应用服务器可调用此接口重试批量任务，目前只支持task_type为firmwareUpgrade，softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中，则不可以调用该接口。 停止批量任务 应用服务器可调用此接口停止批量任务，目前只支持task_type为firmwareUpgrade，softwareUpgrade。如果task_id对应任务已经完成（成功、失败、部分成功，已经停止）或正在停止中，则不可以调用该接口。 查询批量任务文件列表 查询批量任务文件列表。 上传批量任务文件 上传批量任务文件，用于创建批量任务。当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备和批量更新设备任务的文件上传。 删除批量任务文件 删除批量任务文件。

资源空间管理 API 说明 查询资源空间列表 资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口查询资源空间列表。 创建资源空间 资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口创建资源空间。 查询资源空间 资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口查询指定资源空间详情。 删除资源空间 删除指定资源空间。删除资源空间属于高危操作，删除资源空间后，该空间下的产品、设备等资源将不可用，请谨慎操作！

数据流转规则管理 API 说明 查询规则条件列表 可调用此接口查询物联网平台中设置的规则条件列表。 创建规则触发条件 可调用此接口在物联网平台创建一条规则触发条件。 查询规则条件 可调用此接口查询物联网平台中指定规则条件的配置信息。 修改规则触发条件 可调用此接口修改物联网平台中指定规则条件的配置参数。 删除规则触发条件 可调用此接口删除物联网平台中的指定规则条件。 查询规则动作列表 可调用此接口查询物联网平台中设置的规则动作列表。 创建规则动作 可调用此接口在物联网平台创建一条规则动作。 查询规则动作 可调用此接口查询物联网平台中指定规则动作的配置信息。 修改规则动作 可调用此接口修改物联网平台中指定规则动作。 删除规则动作 可调用此接口删除物联网平台中的指定规则动作。

流转数据 API 说明 设备状态变更通知 应用服务器在物联网平台创建设备状态变更通知规则后，当物联网平台中的设备状态发生变更时，平台会向应用服务器推送通知消息。 设备属性上报通知 应用服务器在物联网平台创建了设备属性上报通知规则后，当设备上报属性数据时，平台会向应用服务器推送通知消息。 设备消息状态变更通知 应用服务器在物联网平台创建了消息状态变更通知规则后，当设备消息状态变更时，平台会向应用服务器推送通知消息。 批量任务状态变更通知 应用服务器在物联网平台创建了批量任务状态变更通知规则后，当批量任务状态变更时，平台会向应用服务器推送通知消息。 设备消息上报通知 应用服务器在物联网平台创建了设备消息上报通知规则后，当设备上报消息数据时，平台会向应用服务器推送通知消息。 设备添加通知 应用服务器在物联网平台创建了设备添加事件规则后，当物联网平台中的设备添加时，平台会向应用服务器推送通知消息。 设备更新通知 应用服务器在物联网平台创建了设备更新事件规则后，当物联网平台中的设备更新时，平台会向应用服务器推送通知消息。 设备删除通知 应用服务器在物联网平台创建了设备删除通知事件规则后，当物联网平台中的设备删除时，平台会向应用服务器推送通知消息。 产品添加通知 应用服务器在物联网平台创建了产品添加通知事件规则后，当物联网平台中的产品添加时，平台会向应用服务器推送通知消息。 产品更新通知 应用服务器在物联网平台创建了产品更新通知事件规则后，当物联网平台中的产品更新时，平台会向应用服务器推送通知消息。 产品删除通知 应用服务器在物联网平台创建了产品删除通知事件规则后，当物联网平台中的产品删除时，平台会向应用服务器推送通知消息。 设备异步命令状态变更通知 应用服务器在物联网平台创建了命令状态变更通知后，当命令状态变更时，平台会向应用服务器推送通知消息。

设备组管理 API 说明 查询设备组列表 查询物联网平台中的设备组信息列表。 添加设备组 新建设备组，一个华为云账号下最多可有1,000个分组，包括父分组和子分组。 查询设备组 查询设备组详情。 修改设备组 修改指定设备组。 删除设备组 删除指定设备组。 管理设备组中的设备 管理设备组中的设备，包括添加设备到设备组和从设备组删除设备。单个设备组内最多添加20,000个设备。一个设备最多可以被添加到10个设备组中。 查询设备组设备列表 查询指定设备组下的设备列表。

产品管理 API 说明 查询产品列表 查询已导入物联网平台的产品模型信息列表，了解产品模型的概要信息。 创建产品 创建产品。此接口仅创建了产品，没有创建和安装插件，如果需要对数据进行编解码，还需要在平台开发和安装插件。 查询产品 查询已导入物联网平台的指定产品模型详细信息，包括产品模型的服务、属性、命令等。 修改产品 修改已导入物联网平台的指定产品模型，包括产品模型的服务、属性、命令等。此接口仅修改了产品，未修改和安装插件，如果修改了产品中的service定义，且在平台中有对应的插件，请修改并重新安装插件。 删除产品 删除已导入物联网平台的指定产品模型。

设备管理 API 说明 查询设备列表 查询物联网平台中的设备信息列表。 创建设备 在物联网平台注册一个设备，仅在注册后设备才可以接入物联网平台。 查询设备 查询物联网平台中指定设备的详细信息。 修改设备 修改物联网平台中指定设备的基本信息。 删除设备 在物联网平台上删除指定设备。若设备下连接了非直连设备，则必须把设备下的非直连设备都删除后，才能删除该设备。 重置设备密钥 重置设备密钥，携带指定密钥时平台将设备密钥重置为指定的密钥，不携带密钥时平台将自动生成一个新的随机密钥返回。 冻结设备 冻结设备，设备冻结后不能再连接上线，可以通过解冻设备接口解除设备冻结。注意，当前仅支持冻结与平台直连的设备。 解冻设备 解冻设备，解除冻结后，设备可以连接上线。 重置设备指纹 应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值；不携带时将之置空。 灵活搜索设备列表 应用服务器使用SQL语句调用该接口，灵活的搜索所需要的设备资源列表。 查询指定设备加入的设备组列表 应用服务器调用该接口查询设备加入的设备组列表。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_type 是 String 参数说明：要绑定标签的资源类型。 取值范围： device：设备。 resource_id 是 String 参数说明：要绑定标签的资源id。例如，资源类型为device，那么对应的资源id就是device_id。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 tags 是 Array of TagV5DTO objects 参数说明：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。 表4 TagV5DTO 参数 是否必选 参数类型 描述 tag_key 是 String 参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 取值范围：长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合。 tag_value 否 String 参数说明：标签值。 取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。

请求示例 资源绑定标签，将标签绑定到设备id为d4922d8a的设备上。 POST https://{endpoint}/v5/iot/{project_id}/tags/bind-resource { "resource_type" : "device", "resource_id" : "d4922d8a", "tags" : [ { "tag_key" : "testTagName", "tag_value" : "testTagValue" } ] }