创建表计
功能介绍
创建表计
URI
POST /v1/iotfm/energy-eff/meters
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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,只允许字母、数字的组合。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
meter_name |
是 |
String |
表计名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
meter_description |
否 |
String |
表计描述。长度不超过256,只允许中文、字母、数字、以及_-等字符的组合。 |
meter_type |
是 |
String |
表计类型。电量表-ElectricQuantity; 水量表-WaterQuantity; 供冷量表-CoolingCapacity; 供热量表-HeatCapacity;用气量表-AirFlowQuantity |
device_id |
是 |
String |
设备ID,用于唯一标识一个设备。 |
property_path |
是 |
String |
位路径。源设备内唯一。 |
measuring_config |
是 |
MeasuringConfig object |
测量配置。 |
boundaries |
是 |
Array of BoundaryItem objects |
绑定的边界。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
meter_id |
String |
表计ID。长度不超过36,只允许字母、数字、以及_-等字符的组合。 |
meter_name |
String |
表计名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
meter_description |
String |
表计描述。长度不超过256,只允许中文、字母、数字、以及_-等字符的组合。 |
meter_type |
String |
表计类型。电量表-ElectricQuantity; 水量表-WaterQuantity; 供冷量表-CoolingCapacity; 供热量表-HeatCapacity;用气量表-AirFlowQuantity |
device_id |
String |
设备ID,用于唯一标识一个设备。 |
device_name |
String |
设备名称 |
property_path |
String |
位路径。源设备内唯一。 |
measuring_config |
MeasuringConfig object |
测量配置。 |
create_time |
String |
创建时间,格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
update_time |
String |
更新时间,格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
boundaries |
Array of BoundaryItem objects |
绑定的边界。 |
参数 |
参数类型 |
描述 |
---|---|---|
magnification |
Number |
参数说明:放大倍率。统计的上报值=实际值/放大倍率。 取值范围:只允许0到1000000范围的小数(但不包含0)。比如填写0.1情况下,统计到的上报值就会比实际值放大10倍。填写10情况下,统计到的上报值就会比实际值缩小10倍。 |
measuring_range |
Long |
量程。 |
参数 |
参数类型 |
描述 |
---|---|---|
boundary_id |
String |
边界ID。长度不超过36,只允许字母、数字、以及_-等字符的组合。 |
boundary_name |
String |
边界名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
share_percentage |
Integer |
分摊比例。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数说明:错误码。 取值范围:长度8-36。 |
error_msg |
String |
参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
创建表计
POST https://{endpoint}/v1/iotfm/energy-eff/meters { "meter_name" : "A栋水表", "meter_description" : "龙山基地-A厂房", "meter_type" : "WaterQuantity", "device_id" : "testWater", "property_path" : "InfoService/accumulatedWater", "measuring_config" : { "magnification" : 1, "measuring_range" : 9999 }, "boundaries" : [ { "boundary_id" : "190c87f728d3a4ac1a409ccb", "share_percentage" : 100 } ] }
响应示例
无
状态码
状态码 |
描述 |
---|---|
201 |
创建表计成功 |
400 |
Error response |