# 查询warroom信息 - ListWarRoom #### 功能介绍 查询warroom信息列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListWarRoom)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:warroom:list | List | - | - | - | - | #### URI POST /v1/external/warrooms/list #### 请求参数 表1请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Long | limit 最小值：**0** 最大值：**1000** 缺省值：**0** | | offset | 否 | Long | 查询数量 最小值0 最大值1000 最小值：**0** 最大值：**9223372036854775807** 缺省值：**10** | | current_users | 否 | Array of strings | 用户id 最小长度：**0** 最大长度：**200** 数组长度：**0 - 1000** | | war_room_nums | 否 | Array of strings | war Room 单号，当有这个筛选条件时，其他筛选条件忽略 最小长度：**0** 最大长度：**255** 数组长度：**0 - 1000** | | incident_num | 否 | String | 事件单号 精确查询 最小长度：**0** 最大长度：**64** | | title | 否 | String | warroom名称 模糊查询 最小长度：**0** 最大长度：**1000** | | region_code_list | 否 | Array of strings | 区域 多选 最小长度：**0** 最大长度：**200** 数组长度：**0 - 1000** | | incident_levels | 否 | Array of strings | 事件级别 多选 最小长度：**0** 最大长度：**32** 数组长度：**0 - 1000** | | impacted_application_ids | 否 | Array of strings | 影响应用id 最小长度：**0** 最大长度：**200** 数组长度：**0 - 1000** | | admin | 否 | Array of strings | warroom管理员 最小长度：**0** 最大长度：**200** 数组长度：**0 - 1000** | | status | 否 | Array of strings | warroom状态 最小长度：**0** 最大长度：**10** 数组长度：**0 - 100** | | triggered_start_time | 否 | Long | 拉起开始时间 默认前30天 最小值：**0** 最大值：**9223372036854775807** | | triggered_end_time | 否 | Long | 拉起结束时间 默认当前时间 最小值：**0** 最大值：**9223372036854775807** | | occur_start_time | 否 | Long | 发生开始时间 最小值：**0** 最大值：**9223372036854775807** | | occur_end_time | 否 | Long | 发生结束时间 最小值：**0** 最大值：**9223372036854775807** | | recover_start_time | 否 | Long | 恢复开始时间 最小值：**0** 最大值：**9223372036854775807** | | recover_end_time | 否 | Long | 恢复结束时间 最小值：**0** 最大值：**9223372036854775807** | | notification_level | 否 | Array of strings | 通报级别 最小长度：**0** 最大长度：**32** 数组长度：**0 - 1000** | | enterprise_project_ids | 否 | Array of strings | 企业项目id 最小长度：**0** 最大长度：**64** 数组长度：**0 - 500** | | war_room_num | 否 | String | war Room 单号 前端使用 最小长度：**0** 最大长度：**255** | | statistic_flag | 否 | Boolean | 是否统计,false 返回基本信息;true接口只返回统计结果：total_num,running_num,closed_num 缺省值：**false** | #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider_code | String | 服务标识 缺省值：**4** 最小长度：**3** 最大长度：**3** | | error_code | String | 请求响应代码，范围：0000\~9999，正常时取值：0 最小长度：**1** 最大长度：**20** | | error_msg | String | 请求响应描述 最小长度：**0** 最大长度：**10240** | | data | [data] object | 响应数据 | 表3data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | list | Array of [WarRoomTenantInfo] objects | warroom信息 数组长度：**0 - 1000** | | total | Long | 总数 最小值：**0** 最大值：**9223372036854775807** | | running_num | Long | 进行中warroom总数 最小值：**0** 最大值：**9223372036854775807** | | closed_num | Long | 已关闭warroom总数 最小值：**0** 最大值：**9223372036854775807** | | total_num | Long | warroom总数 最小值：**0** 最大值：**9223372036854775807** | 表4WarRoomTenantInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 主键 最小长度：**0** 最大长度：**100** | | title | String | 标题 最小长度：**0** 最大长度：**255** | | admin | String | Warroom管理员 最小长度：**0** 最大长度：**255** | | recover_member | Array of strings | 恢复成员 最小长度：**0** 最大长度：**255** 数组长度：**0 - 1000** | | recover_leader | Array of strings | 主恢复责任人 最小长度：**0** 最大长度：**255** 数组长度：**0 - 1000** | | incident | [WarRoomIncident] object | 事件 | | source | String | 事件来源 最小长度：**0** 最大长度：**255** | | regions | Array of [regions] objects | 影响的Region 数组长度：**0 - 1000** | | change_num | String | 变更单号 最小长度：**0** 最大长度：**255** | | occur_time | Long | 开始时间 最小值：**0** 最大值：**9223372036854775807** | | recover_time | Long | 故障恢复时间 最小值：**0** 最大值：**9223372036854775807** | | fault_cause | String | 故障原因 最小长度：**0** 最大长度：**255** | | create_time | Long | 添加时间 最小值：**0** 最大值：**9223372036854775807** | | first_report_time | Long | 首次通报时间 最小值：**0** 最大值：**9223372036854775807** | | recovery_notification_time | Long | 恢复通报时间 最小值：**0** 最大值：**9223372036854775807** | | fault_impact | String | 故障影响 最小长度：**0** 最大长度：**255** | | description | String | warRoom描述 最小长度：**0** 最大长度：**255** | | circular_level | String | 通报级别 租户区同事件级别 最小长度：**0** 最大长度：**32** | | war_room_status | [WarRoomEnumeration] object | warroom 状态 | | impacted_application | Array of [impacted_application] objects | 影响应用 数组长度：**0 - 1000** | | processing_duration | Long | 处理时长(分钟) 最小值：**0** 最大值：**9223372036854775807** | | restoration_duration | Long | 恢复时长(分钟) 最小值：**0** 最大值：**9223372036854775807** | | war_room_num | String | warroom 单号 最小长度：**0** 最大长度：**255** | | enterprise_project_id | String | 企业项目id 最小长度：**0** 最大长度：**64** | 表5WarRoomIncident | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 主键 最小长度：**0** 最大长度：**100** | | incident_id | String | 事件id 最小长度：**0** 最大长度：**32** | | alarm_id | String | 告警id 最小长度：**0** 最大长度：**64** | | is_change_event | Boolean | 是否变更事件 | | source_id | Long | 源id 最小值：**0** 最大值：**9223372036854775807** | | failure_level | String | 事件级别 最小长度：**0** 最大长度：**32** | | incident_url | String | 事件单号链接 最小长度：**0** 最大长度：**20000** | 表6regions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 主键 最小长度：**0** 最大长度：**100** | | name | String | 名称 最小长度：**0** 最大长度：**255** | 表7WarRoomEnumeration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** WarRoom状态枚举值id。 **约束限制：** 字符串 0 - 255字符 **取值范围：** 枚举值 - 1：启动WarRoom - 3：故障定界 - 7：故障已恢复 - 20：WarRoom关闭 **默认取值：** 不涉及 最小长度：**0** 最大长度：**255** | | name_zh | String | **参数解释：** WarRoom状态中文名称。 **约束限制：** 字符串 0 - 255字符 **取值范围：** 枚举值 - 启动WarRoom - 故障定界 - 故障已恢复 - WarRoom关闭 **默认取值：** 不涉及 最小长度：**0** 最大长度：**255** | | name_en | String | **参数解释：** WarRoom状态英文名称。 **约束限制：** 字符串 0 - 255字符 **取值范围：** 枚举值 - Start WarRoom：启动WarRoom - Fault Demarcation：故障定界 - Fault Rectified：故障已恢复 - WarRoom Shut Down：WarRoom关闭 **默认取值：** 不涉及 最小长度：**0** 最大长度：**255** | | type | String | **参数解释：** 枚举类型。 **约束限制：** 字符串 0 - 255字符 **取值范围：** 枚举值 - WAR_ROOM_STATUS：WarRoom状态 **默认取值：** 不涉及 最小长度：**0** 最大长度：**255** | 表8impacted_application | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 主键 最小长度：**0** 最大长度：**100** | | name | String | 名字 最小长度：**0** 最大长度：**255** | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider_code | String | 服务标识 缺省值：**4** 最小长度：**3** 最大长度：**3** | | error_code | String | 请求响应代码，范围：0000\~9999，正常时取值：0 最小长度：**1** 最大长度：**20** | | error_msg | String | 请求响应描述 最小长度：**0** 最大长度：**10240** | | data | Object | 响应数据 | #### 请求示例 ``` POST https://{Endpoint}/v1/external/warrooms/list { "incident_num" : "string", "title" : "string", "admin" : [ 0 ], "status" : [ 0 ], "triggered_start_time" : 0, "triggered_end_time" : 0, "occur_start_time" : 0, "occur_end_time" : 0, "recover_start_time" : 0, "recover_end_time" : 0 } ``` #### 响应示例 **状态码：200** 查询成功响应。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "error_code" : "COC.00080000", "error_msg" : "success", "provider_code" : "049", "data" : { "total" : 1, "total_num" : null, "running_num" : null, "closed_num" : null, "list" : [ { "id" : "2fc9f08089d2779477a8b0cd29a9be45", "title" : "WarRoom标题", "admin" : "0620da4b7a99414a9bd5147354469c3a", "recover_member" : [ ], "recover_leader" : [ ], "incident" : { "id" : "d98117b816a96988f6420f071ec4a300", "incident_id" : "IM202511191044190150629281", "alarm_id" : null, "is_change_event" : null, "source_id" : null, "failure_level" : "level_30", "incident_url" : null }, "source" : null, "regions" : [ ], "change_num" : null, "occur_time" : 1765798327678, "recover_time" : null, "fault_cause" : null, "create_time" : 1765798327679, "first_report_time" : null, "recovery_notification_time" : null, "fault_impact" : null, "description" : "test", "circular_level" : "level_30", "war_room_status" : { "id" : "1", "name_zh" : "启动 warroom", "name_en" : "Start WarRoom", "type" : "WAR_ROOM_STATUS" }, "impacted_application" : [ { "name" : null, "id" : "64898bf60224b9730ccb577f" } ], "processing_duration" : null, "restoration_duration" : null, "war_room_num" : "WR202512151932076780100565", "enterprise_project_id" : "0" } ] } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功响应。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 | | 400 | 请求失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。