查询单个设备组态
功能介绍
应用服务器可调用此接口查询单个设备的组态配置。
URI
GET /v1/iotfm/ba/device-configurations/match/{device_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
device_id |
是 |
String |
参数说明: 设备ID，用于唯一标识一个设备，在注册设备时获得。 取值范围: 长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
|
X-Instance-Id |
是 |
String |
参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。 |
|
X-Root-Zone-Id |
否 |
String |
参数说明：项目ID。 取值范围：长度不超过24，只允许字母、数字的组合。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
device_config_name |
String |
参数说明：设备组态名称。 取值范围：长度1-36，只允许中文，大小写字母、数字及特殊字符（_?'#().,&%@!-）的组合。 |
|
device_config_id |
String |
参数说明：设备组态ID，用于标识实例下唯一的设备组态配置。 取值范围：长度1-36，只允许大小写字母、数字及下划线（_）中划线（-）的组合。 |
|
create_time |
String |
参数说明：创建时间，格式为：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 取值范围：大小为0-20。 |
|
update_time |
String |
参数说明：最后一次修改时间，格式为：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 取值范围：大小为0-20。 |
|
devices_id |
Array of strings |
参数说明：设备ID列表。 取值范围：列表大小最少1个元素，最多100个元素。 |
|
product_id |
String |
参数说明：产品ID。 取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。 |
|
zone_id |
String |
参数说明：区域ID。 取值范围：长度不超过24，只允许字母、数字的组合。 |
|
zone_name |
String |
参数说明：区域名称。 取值范围：长度不超过64。 |
|
ba_config_url |
String |
组态图页面地址,以智能设施云平台 Console域名开头，长度不超过255。当display_mode为DIAGRAM类型时该字段必填。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数说明：错误码。 取值范围：长度8-36。 |
|
error_msg |
String |
参数说明：错误描述。 取值范围：长度2-512。 |
请求示例
查询单个设备组态
GET https://{endpoint}/v1/iotfm/ba/device-configurations/match/16087212bc75410c9ad77163b4cf6aba
响应示例
状态码：200
查询单个设备组态信息成功
{
"device_config_name" : "空调机组设备组态01",
"device_config_id" : "b640f4c203b7910fc3cbd446ed437cbd",
"create_time" : "2022-12-26T01:52:49.368Z",
"update_time" : "2022-12-26T01:52:49.368Z",
"devices_id" : [ "16087212bc75410c9ad77163b4cf6aba" ],
"product_id" : "b640f4c203b7910fc3cbd446ed437cbd",
"zone_id" : "26087212bc75410c9ad77163",
"zone_name" : "天安云谷旗舰店",
"ba_config_url" : "https://100.93.18.230/bastudio/release/cZ9ruOQWTBgwTRq4yvx6w.html?systemId=18972188ae8b10fb06435985"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询单个设备组态信息成功 |
|
400 |
错误请求 |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
