设备接入 IOTDA-查询产品:响应参数

时间:2024-06-28 09:24:55

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

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, OPC-UA,OPC-DA,Other。

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。

表5 ServiceCapability

参数

参数类型

描述

service_id

String

参数说明:设备的服务ID。注:产品内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

service_type

String

参数说明:设备的服务类型。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

properties

Array of ServiceProperty objects

参数说明:设备服务支持的属性列表。 取值范围:数组长度大小不超过500。

commands

Array of ServiceCommand objects

参数说明:设备服务支持的命令列表。 取值范围:数组长度大小不超过500。

events

Array of ServiceEvent objects

参数说明:设备服务支持的事件列表。目前暂未支持自定义事件,创建/修改产品时无需定义该字段。 取值范围:数组长度大小不超过500。

description

String

参数说明:设备服务的描述信息。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。¥$!【】’‘“”()?…~/等字符的组合。

option

String

参数说明:指定设备服务是否必选。目前本字段为非功能性字段,仅起到标识作用。 取值范围

  • Master:主服务

  • Mandatory:必选服务

  • Optional:可选服务 默认值为Optional。

缺省值:Optional

表6 ServiceProperty

参数

参数类型

描述

property_name

String

参数说明:设备属性名称。注:设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符:点(.)、dollar符号($)、空char(十六进制的ASCII码为00),如果包含了以上特殊字符则无法正常刷新影子文档。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:设备属性的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:设备属性是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:设备属性的枚举值列表。

min

String

参数说明:设备属性的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:设备属性的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:设备属性的最大长度。

step

Double

参数说明:设备属性的步长。

unit

String

参数说明:设备属性的单位。 取值范围:长度不超过16。

最大长度:16

method

String

参数说明:设备属性的访问模式。 取值范围:RWE,RW,RE,WE,E,W,R。

  • R:属性值可读

  • W:属性值可写

  • E:属性值可订阅,即属性值变化时上报事件

description

String

参数说明:设备属性的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。¥$!【】’‘“”()?…~/等字符的组合。

default_value

Object

参数说明:设备属性的默认值。如果设置了默认值,使用该产品创建设备时,会将该属性的默认值写入到该设备的设备影子预期数据中,待设备上线时将该属性默认值下发给设备。

表7 ServiceCommand

参数

参数类型

描述

command_name

String

参数说明:设备命令名称。注:设备服务内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令的参数列表。

responses

Array of ServiceCommandResponse objects

参数说明:设备命令的响应列表。

表8 ServiceCommandResponse

参数

参数类型

描述

response_name

String

参数说明:设备命令响应名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令响应的参数列表。

表9 ServiceEvent

参数

参数类型

描述

event_type

String

参数说明:设备事件类型。注:设备服务内不允许重复。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备事件的参数列表。

表10 ServiceCommandPara

参数

参数类型

描述

para_name

String

参数说明:参数的名称。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:参数的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:参数是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:参数的枚举值列表。

min

String

参数说明:参数的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:参数的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:参数的最大长度。

step

Double

参数说明:参数的步长。

unit

String

参数说明:参数的单位。 取值范围:长度不超过16。

最大长度:16

description

String

参数说明:参数的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。¥$!【】’‘“”()?…~/等字符的组合。

support.huaweicloud.com/api-iothub/iot_06_v5_0052.html