查询空间平面组态

功能介绍

应用服务器可调用此接口查询给定空间平面的组态配置。

URI

GET /v1/iotfm/ba/zone-configurations/match/{zone_id}

表1 路径参数
参数	是否必选	参数类型	描述
zone_id	是	String	参数说明: 区域ID,用于唯一标识一个区域，在创建区域时获得。取值范围：长度不超过24，只允许字母、数字的组合。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
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

表3 响应Body参数
参数	参数类型	描述
zone_config_name	String	参数说明：空间平面组态名称。取值范围：长度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。
zone_id	String	参数说明：区域ID。取值范围：长度1-24，只允许大小写字母、数字的组合。
ba_config_url	String	组态图页面地址,以智能设施云平台 Console域名开头，长度不超过255。当display_mode为DIAGRAM类型时该字段必填。

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数说明：错误码。取值范围：长度8-36。
error_msg	String	参数说明：错误描述。取值范围：长度2-512。

请求示例

查询给定区域id的组态配置

GET https://{endpoint}/v1/iotfm/ba/zone-configurations/match/26087212bc75410c9ad77163

响应示例

状态码：200

查询空间平面组态响应体

{
  "zone_config_name" : "H区平面组态01",
  "create_time" : "2022-12-26T01:52:49.368Z",
  "update_time" : "2022-12-26T01:52:49.368Z",
  "zone_id" : "26087212bc75410c9ad77163",
  "ba_config_url" : "/bastudio/release/cZ9ruOQWTBgwTRq4yvx6w.html?systemId=18972188ae8b10fb06435985"
}