更新时间:2024-08-21 06:55:35下载pdf
通过以下开放 API,查询产品相关信息。
请求方式 | API | 说明 |
---|---|---|
GET | /v1.0/cloud/illume/open/product/info | 获取产品信息 |
接口说明
根据产品 ID,获取产品基础信息和相关的功能点(DP)信息。
接口地址
GET /v1.0/cloud/illume/open/product/info
请求参数
参数名 | 类型 | 参数类型 | 说明 | 是否必需 |
---|---|---|---|---|
productId | string | Query | 产品 ID | 是 |
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码(详情见错误码章节),成功时为空 |
success | Boolean | 是否成功
|
msg | String | 请求失败的信息,成功时为空 |
t | Long | 返回 13 位时间戳 |
result | Object | 返回结果 |
result 参数说明
{
"category":"二级品类",
"categoryCode":"三级品类",
"dps":[
{
"desc":"描述",
"dpCode":"标识符",
"dpId":"DP ID",
"dpName":"功能点名称",
"dpSubType":"数据类型",
"property":"功能点属性,JSON 字符串"
}
],
"name":"产品名称",
"prodcutId":"产品 ID"
}
请求示例
GET:/v1.0/cloud/illume/open/product/info?productId=3aqockhk
响应示例
{
"category":"dlzmkz",
"categoryCode":"dlzmkz_4z_3",
"dps":[
{
"desc":"",
"dpCode":"switch_led",
"dpId":1,
"dpName":"开关",
"dpSubType":"bool",
"property":"{\"type\":\"bool\"}"
},
{
"desc":"",
"dpCode":"work_mode",
"dpId":2,
"dpName":"工作模式",
"dpSubType":"enum",
"property":"{\"range\":[\"white\",\"colour\",\"scene\",\"music\"],\"type\":\"enum\"}"
},
{
"desc":"",
"dpCode":"bright_value",
"dpId":3,
"dpName":"白光亮度",
"dpSubType":"value",
"property":"{\"min\":10,\"max\":1000,\"step\":1,\"unit\":null,\"scale\":0,\"type\":\"value\"}"
},
{
"desc":"用于设置断电再上电灯亮起的灯光状态",
"dpCode":"power_memory",
"dpId":33,
"dpName":"断电记忆",
"dpSubType":"raw",
"property":"{\"maxlen\":128,\"type\":\"raw\"}"
},
{
"desc":"",
"dpCode":"fault",
"dpId":58,
"dpName":"故障告警",
"dpSubType":"bitmap",
"dpType":"obj",
"property":"{\"maxlen\":7,\"label\":[\"power_fault\",\"current_fault\",\"voltage_fault\",\"pf_abnormal\",\"freq_abnormal\",\"open_circuit_alarm\",\"short_circuit_alarm\"],\"type\":\"bitmap\"}"
}
],
"name":"Street Light Controller",
"prodcutId":"3aqockhk"
}
错误码
以下为该接口常见的业务异常。更多的异常错误,参考 全局错误码。
错误码 | 说明 |
---|---|
500 | 系统错误 |
该内容对您有帮助吗?
是意见反馈该内容对您有帮助吗?
是意见反馈