调用该接口查询用户小组件设备的属性列表。

路径 /iotx/ilop/queryComponentProperty
版本号 1.0.3
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
productKey String 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。
query Struct 查询条件。
iotId String 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应的结果。

productKey String

产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

propertyName String

属性的名称。

propertyIdentifier String

属性的标识。

dataType String

属性的数据类型。

added_component Boolean

是否添加至小组件。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.3",
		"iotToken": "token"
	},
	"params":{
		"productKey": "value0",
		"query": "value1",
		"iotId": "value2"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": [{
      "propertyIdentifier":"xxx",
      "propertyName":"xxx",
      "propertyValue":"xxx",
      "propertyDataType":"xxx",
      "added_component":false
     }]
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}