华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • URI POST /v5/iot/{project_id}/devices/{device_id}/freeze 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由 物联网平台 分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • URI DELETE /v5/iot/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • 示例 Topic: $oc/devices/{device_id}/sys/events/up 数据格式: { "object_device_id": "{object_device_id}", "services": [ { "service_id": "$sub_device_manager", "event_type": "add_sub_device_request", "event_time": "20151212T121212Z", "event_id": "40cc9ab1-3579-488c-95c6-c18941c99eb4", "paras": { "devices": [ { "name": "subdevice11", "node_id": "subdevice11", "product_id": "c6b39067b0325db34663d3ef421a42f6", "description": "subdevice11" }, { "name": "subdevice12", "node_id": "subdevice12", "product_id": "c6b39067b0325db34663d3ef421a42f6", "description": "subdevice12" } ] } } ] }
  • 响应示例 状态码: 200 OK { "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "response" : { "result_code" : 0, "response_name" : "COMMAND_RESPONSE", "paras" : { "result" : "success" } } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 command_id String 设备命令ID,用于唯一标识一条命令,在下发设备命令时由物联网平台分配获得。 response Object 设备上报的命令执行结果。Json格式,具体格式需要应用和设备约定。 error_code String 命令下发异常错误码。 error_msg String 命令下发异常错误信息。
  • URI POST /v5/iot/{project_id}/devices/{device_id}/commands 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:下发消息的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 功能介绍 设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向指定设备下发命令,以实现对设备的同步控制。平台负责将命令以同步方式发送给设备,并将设备执行命令结果同步返回, 如果设备没有响应,平台会返回给应用服务器超时,平台超时时间是20秒。如果命令下发需要超过20秒,建议采用消息下发。 注意: 此接口适用于MQTT设备同步命令下发,暂不支持NB-IoT设备命令下发。 此接口仅支持单个设备同步命令下发,如需多个设备同步命令下发,请参见 创建批量任务。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 否 String 参数说明:设备命令所属的设备服务ID,在设备关联的产品模型中定义。 取值范围:长度不超过64的字符串。 最大长度:64 command_name 否 String 参数说明:设备命令名称,在设备关联的产品模型中定义。 取值范围:长度不超过128的字符串。 最大长度:128 paras 是 Object 参数说明:设备执行的命令,Json格式,里面是一个个键值对,如果serviceId不为空,每个键都是profile中命令的参数名(paraName);如果serviceId为空则由用户自定义命令格式。设备命令示例:{"value":"1"},具体格式需要应用和设备约定。此参数仅支持Json格式,暂不支持字符串。 最大长度:261952
  • 请求示例 假设value为c4 0d 5a 6e 96 0b c3 0e 2b 30 37,则上报样例如下: NON-2.05 MID=48590, Token=2cb6a673cba24c04, OptionSet={"Observe":22, "Content-Format":"application/octet-stream"}, c4 0d 5a 6e 96 0b c3 0e 2b 30 37
  • LwM2M对象资源 设备向物联网平台上报数据,设备携带物联网平台下发/19/0/0订阅时的token进行属性上报。 Operation CoAP Method URI Success Failure Notify Asynchronous Response 不涉及 2.05 Content with {value} 不涉及 设备通过LwM2M协议上报的数据都是二进制报文数据,一般都需要通过编解码插件进行解析,参考编解码插件开发。
  • 下行响应示例 Topic:$oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id} 数据格式: { "object_device_id": "40fe3542-f4cc-4b6a-98c3-61a49ba1acd4", "shadow": [ { "service_id": "WaterMeter", "desired": { "properties": { "temperature": "60" }, "event_time": "20151212T121212Z" }, "reported": { "properties": { "temperature": "60" }, "event_time": "20151212T121212Z" }, "version": 1 } ] }
  • Topic 上行: $oc/devices/{device_id}/sys/shadow/get/request_id={request_id} 下行: $oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id} {request_id}用于唯一标识这次请求。设备侧发起的消息带该参数时,需要保证设备侧该参数值的唯一性,可以用递增的数字或者UUID来实现。 设备侧上行请求参数中携带唯一标识,该唯一标识会在下行topic中request_id携带给设备以标记唯一请求链。 订阅下行Topic时建议使用通配符“#”来替代“request_id={request_id}”即为:$oc/devices/{device_id}/sys/shadow/get/response/#。
  • 功能介绍 用于设备向平台获取设备影子数据。用户可以通过应用服务器或物联网控制台配置设备影子预期数据,设备上线时订阅该topic,可以获取到平台设备影子数据,以此来同步设备属性期望值,从而完成设备属性值的修改。 简单交互逻辑介绍如下: ① 应用调用“配置设备影子预期数据”接口或在控制台配置设备影子数据; ② 设备侧(已完成关联Topic订阅)主动上报请求,获取平台的设备影子数据; ③ 平台响应设备请求,返回设备影子数据; ④ 设备侧解析属性期望值,并完成设备属性值修改。
  • URI DELETE /v5/iot/{project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID 最小长度:0 最大长度:32 app_id 是 String 参数说明:资源空间ID,唯一标识一个资源空间,由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务获取。 最小长度:0 最大长度:1024000 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:0 最大长度:36
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 group_id String 设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。 name String 设备组名称,单个资源空间下不可重复。 description String 设备组描述。 super_group_id String 父设备组ID,该设备组的父设备组ID。 group_type String 设备组类型,分为动态设备组和静态设备组两种 dynamic_group_rule String 动态设备组规则
  • 请求示例 创建静态设备组,设备组名为GroupA。 POST https://{endpoint}/v5/iot/{project_id}/device-group { "name" : "GroupA", "description" : "群组A", "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "group_type" : "STATIC" } 创建动态设备组,设备组名为GroupA。 POST https://{endpoint}/v5/iot/{project_id}/device-group { "name" : "GroupA", "description" : "群组A", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "dynamic_group_rule" : "product_id = '63fef97897bacf7a56438cba'", "group_type" : "DYNAMIC" }
  • 响应示例 状态码: 201 Created { "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc", "name" : "GroupA", "description" : "群组A", "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8", "group_type" : "STATIC", "dynamic_group_rule" : null }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数说明:设备组名称,单个资源空间下不可重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 最小长度:1 最大长度:64 description 否 String 参数说明:设备组描述。 取值范围:长度不超过64,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 最小长度:1 最大长度:64 super_group_id 否 String 参数说明:父设备组ID,携带该参数时表示在该设备组下创建一个子设备组,动态群组不支持该参数。 取值范围:长度不超过36,十六进制字符串和连接符(-)的组合。 app_id 否 String 参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的设备组归属到哪个资源空间下,否则创建的设备组将会归属到默认资源空间下。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 group_type 否 String 参数说明:设备组类型,默认为静态设备组;当设备组类型为动态设备组时,需要填写动态设备组组规则 dynamic_group_rule 否 String 参数说明:动态设备组规则语法和高级搜索保持一致,只需要填写where 子句内容,其余子句无需填写,todo补充说明
  • 请求示例 产品添加通知示例: 产品添加通知 { "resource" : "product", "event" : "create", "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 参数说明:订阅的资源事件,取值为create。 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 参数说明:参数的描述。
  • 示例 Topic: $oc/devices/{device_id}/sys/events/up 数据格式: { "object_device_id": "{object_device_id}", "services": [ { "service_id": "$sub_device_manager", "event_type": "delete_sub_device_request", "event_time": "20151212T121212Z", "event_id": "40cc9ab1-3579-488c-95c6-c18941c99eb4", "paras": { "devices": [ "c6b39067b0325db34663d3ef421a42f6_subdevice11", "c6b39067b0325db34663d3ef421a42f6_subdevice12" ] } } ] }
  • 错误码 HTTP状态码 HTTP状态码描述 错误码 错误码描述 错误码中文描述 400 Bad Request IOTDA.000006 Invalid input data. 请求参数不合法 401 Unauthorized IOTDA.000002 The request is unauthorized. 鉴权失败 403 Forbidden IOTDA.021101 Request reached the maximum rate limit. 请求已经达到限制速率 IOTDA.021102 The request rate has reached the upper limit of the tenant, limit %s. 请求已经达到租户的限制速率
  • 请求示例 POST https://{endpoint}/v5/device-auth Content-Type: application/json { "device_id" : "60a87ffebaccd902c2f1abbb_0001", "sign_type" : 0, "timestamp" : "2019120219", "password" : "******" }
  • 接口说明 设备鉴权接口,鉴权通过后建立设备与平台间才能处理业务连接。鉴权成功后平台返回access_token。调用属性上报、消息上报等其他接口时,都需要携带access_token信息。如果access_token超期,需要重新认证设备获取access_token。如果access_token未超期重复获取access_token,老的access_token在未超期前保留30s,30s之后失效。
  • 请求参数 名称 必选 类型 位置 说明 device_id 是 String Body 参数说明: 设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。由物联网平台分配时,生成规则为"product_id" + "_" + "node_id"拼接而成。 取值范围: 长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。 取值范围: 长度1-128 sign_type 是 Integer Body 参数说明: 密码校验方式: 0 代表HMA CS HA256校验时间戳时不会校验消息时间戳与平台时间是否一致,仅判断密码是否正确; 1 代表HMACSHA256校验时间戳时会先校验消息时间戳与平台时间是否一致,再判断密码是否正确。 取值范围: 大小0~1 timestamp 是 String Body 参数说明: 时间戳:为设备连接平台时的UTC时间,格式为YYYYMMDDHH,如UTC 时间2018/7/24 17:56:20 则应表示为2018072417。 取值范围: 固定长度10 password 是 String Body 参数说明: password的值为使用“HMACSHA256”算法以时间戳为密钥,对secret进行加密后的值。secret为注册设备时平台返回的secret。 取值范围: 固定长度64
  • 响应示例 状态码: 200 OK { "devices" : [ { "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "app_name" : "testAPP01", "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "fw_version" : "1.1.0", "sw_version" : "1.1.0", "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "product_name" : "Thermometer", "status" : "INACTIVE", "tags" : [ { "tag_key" : "testTagName", "tag_value" : "testTagValue" } ] } ], "page" : { "count" : 100, "marker" : "5c8f3d2d3df1f10d803adbda" } }
  • URI GET /v5/iot/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 参数说明:设备关联的产品ID,用于唯一标识一个产品模型,创建产品后获得。方法请参见 创建产品。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 gateway_id 否 String 参数说明:网关ID,用于标识设备所属的父设备,即父设备的设备ID。携带该参数时,表示查询该设备下的子设备,默认查询下一级子设备,如果需要查询该设备下所有各级子设备,请同时携带is_cascade_query参数为true;不携带该参数时,表示查询用户下所有设备。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。 is_cascade_query 否 Boolean 参数说明:是否级联查询,该参数仅在同时携带gateway_id时生效。默认值为false。 取值范围: true:表示查询设备ID等于gateway_id参数的设备下的所有各级子设备。 false:表示查询设备ID等于gateway_id参数的设备下的一级子设备。 缺省值:false node_id 否 String 参数说明:设备标识码,通常使用IMEI、MAC地址或Serial No作为node_id。 取值范围:长度不超过64,只允许字母、数字、下划线(_)、连接符(-)的组合。 device_name 否 String 参数说明:设备名称,资源空间下唯一,用于资源空间下唯一标识一个设备。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 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 start_time 否 String 参数说明:查询设备注册时间在startTime之后的记录,格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 end_time 否 String 参数说明:查询设备注册时间在endTime之前的记录,格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 app_id 否 String 参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的设备列表,不携带该参数则会查询该用户下所有设备列表。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。
共100000条