创建WarRoom
功能介绍
应用服务器可调用此接口创建WarRoom。
WarRoom中通过指定产品、设备和属性等信息,用于对特定点位提权,将相关点位的采集周期设定为5秒。
URI
POST /v1/iotfm/datahouse/warrooms
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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,只允许字母、数字的组合。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| warroom_id | 是 | String | 参数说明:WarRoom ID。 取值范围:长度不超过48,只允许字母、数字、以及_.-字符的组合。 |
| groups | 是 | Array of CreateWarRoomGroup objects | 参数说明:分组信息。 取值范围:长度不超过50。 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| warroom_id | String | 参数说明:WarRoom ID。 取值范围:长度不超过48,只允许字母、数字、以及_.-字符的组合。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数说明:错误码。 取值范围:长度8-36。 |
| error_msg | String | 参数说明:错误描述。 取值范围:长度2-512。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数说明:错误码。 取值范围:长度8-36。 |
| error_msg | String | 参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
新建warroom
POST https://{endpoint}/v1/iotfm/datahouse/warrooms
{
"warroom_id" : "UPS-warroom-001",
"groups" : [ {
"product_id" : "CDU",
"device_ids" : [ "ucb33icdhw11" ],
"property_paths" : [ "InfoService/PriFilterInletPressure", "InfoService/CDUSecDiffPressureActualValue", "InfoService/CDUSecDiffPressureTarget" ]
}, {
"product_id" : "CoolingWaterPump",
"device_ids" : [ "ucb241upuwl01", "ucb241upuwl02" ],
"property_paths" : [ "InfoService/ActivePower", "InfoService/Frequency" ]
} ]
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 500 | Internal Server Error |