更新时间:2025-08-19 GMT+08:00
分享

修改WarRoom

功能介绍

应用服务器可调用此接口修改WarRoom。

WarRoom中通过指定产品、设备和属性等信息,用于对特定点位提权,实现相关点位的采集周期设定为5秒。

打开WarRoom,将使WarRoom中的点位采集周期设定为5秒;关闭WarRoom,将恢复WarRoom中的点位采集周期。

URI

PUT /v1/iotfm/datahouse/warrooms/{warroom_id}

表1 路径参数

参数

是否必选

参数类型

描述

warroom_id

String

参数说明:WarRoom ID。

取值范围:长度不超过48,只允许字母、数字、以及_.-字符的组合。

请求参数

表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,只允许字母、数字的组合。

表3 请求Body参数

参数

是否必选

参数类型

描述

status

String

参数说明:WarRoom状态。

取值范围:OPEN、CLOSE。

响应参数

状态码:204

表4 响应Body参数

参数

参数类型

描述

-

String

-

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数说明:错误码。

取值范围:长度8-36。

error_msg

String

参数说明:错误描述。

取值范围:长度2-512。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数说明:错误码。

取值范围:长度8-36。

error_msg

String

参数说明:错误描述。

取值范围:长度2-512。

请求示例

  • 打开warroom

    PUT https://{endpoint}/v1/iotfm/datahouse/warrooms/{warroom_id}
    
    {
      "status" : "OPEN"
    }
  • 关闭warroom

    PUT https://{endpoint}/v1/iotfm/datahouse/warrooms/{warroom_id}
    
    {
      "status" : "CLOSE"
    }

响应示例

状态码

状态码

描述

204

No Content

400

Bad Request

500

Internal Server Error

相关文档