查询warroom信息
功能介绍
该接口可分页查询到warroom信息，分页参数为limit与offset。同时可对warroom关联的事件单单号incident_num、标题title、状态status等进行过滤，更多过滤参数详见请求参数说明。查询结果包含warroom名称、warroom状态、关联事件单信息等。同时该接口也可以只返回当前warroom的统计结果，当statistic_flag参数为true时，返回当前租户下共多少warroom（total_num），已关闭（closed_num）和未关闭（running_num）的数量。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/external/warrooms/list
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
列表查询接口分页参数，表示一页查询多少条数据，该值需大于等于1且为整数，表示分页查询时每一页最多查到的数量。 最小值：0 最大值：1000 缺省值：0 |
|
offset |
否 |
Integer |
列表查询接口分页参数，表示当前查询第几页，0表示查询第一页。 最小值：0 最大值：2147483647 缺省值：0 |
|
incident_num |
否 |
String |
事件单号，对单号进行搜索时为精确查询，需要填写准确的事件单号。 最小长度：0 最大长度：64 |
|
title |
否 |
String |
warroom名称，对warroom名称进行搜索时为模糊查询。 最小长度：0 最大长度：1000 |
|
region_code_list |
否 |
Array of strings |
对区域进行过滤，传值为region_id，可同时传递多个region_id，例如：["cn-north-4"]表示过滤北京四下的warroom。 最小长度：0 最大长度：200 数组长度：0 - 1000 |
|
incident_levels |
否 |
Array of strings |
对事件级别进行过滤，可同时传递多个值，可传递的值范围为：level_10、level_20、level_30、level_40和level_50，分别对应P1、P2、P3、P4和P5。 最小长度：0 最大长度：32 数组长度：0 - 1000 |
|
impacted_application_ids |
否 |
Array of strings |
对影响应用进行过滤，传值为应用ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 |
|
admin |
否 |
Array of strings |
warroom管理员，传值为用户ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 |
|
status |
否 |
Array of strings |
warroom状态，过滤场景下需要传递状态ID。当前warroom状态分别为启动 warroom（状态ID：1）、故障界定（状态ID：3）、故障已恢复（状态ID：7）、warroom关闭（状态ID：20）。 最小长度：0 最大长度：10 数组长度：0 - 100 |
|
triggered_start_time |
否 |
Long |
warroom拉起时间，值为13位时间戳，默认前30天。 最小值：0 最大值：9223372036854775807 |
|
triggered_end_time |
否 |
Long |
warroom结束时间，默认为当前时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
occur_start_time |
否 |
Long |
故障发生时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
occur_end_time |
否 |
Long |
故障结束时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
recover_start_time |
否 |
Long |
故障恢复开始时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
recover_end_time |
否 |
Long |
故障恢复结束时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
notification_level |
否 |
Array of strings |
通报级别，可同时传递多个值，可传递的值范围为：level_10、level_20、level_30、level_40和level_50，分别对应P1、P2、P3、P4和P5。 最小长度：0 最大长度：32 数组长度：0 - 1000 |
|
enterprise_project_ids |
否 |
Array of strings |
企业项目id，可多选。 最小长度：0 最大长度：64 数组长度：0 - 500 |
|
war_room_num |
否 |
String |
warroom单号。 最小长度：0 最大长度：255 |
|
statistic_flag |
否 |
Boolean |
是否只返回统计数据，当值为false返回基本信息，值为true接口只返回统计结果：total_num,running_num,closed_num。 缺省值：false |
|
current_users |
否 |
Array of strings |
当前用户ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 |
|
war_room_nums |
否 |
Array of strings |
warroom单号，当有这个筛选条件时，其他筛选条件忽略。 最小长度：0 最大长度：255 数组长度：0 - 1000 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
服务标识。 缺省值：4 最小长度：3 最大长度：3 |
|
error_code |
String |
请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 |
|
error_msg |
String |
请求响应描述。 最小长度：0 最大长度：10240 |
|
data |
data object |
响应数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
list |
Array of WarRoomTenantInfo objects |
warroom信息。 数组长度：0 - 1000 |
|
total |
Long |
当前查询条件下查到的warroom总数。 最小值：0 最大值：9223372036854775807 |
|
running_num |
Long |
进行中warroom总数。 最小值：0 最大值：9223372036854775807 |
|
closed_num |
Long |
已关闭warroom总数。 最小值：0 最大值：9223372036854775807 |
|
total_num |
Long |
warroom总数。 最小值：0 最大值：9223372036854775807 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
warroom存在后台数据库的主键ID。 最小长度：0 最大长度：100 |
|
title |
String |
warroom名称 最小长度：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 |
开始时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
recover_time |
Long |
故障恢复时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
fault_cause |
String |
故障原因。 最小长度：0 最大长度：255 |
|
create_time |
Long |
添加时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
first_report_time |
Long |
首次通报时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 |
|
recovery_notification_time |
Long |
恢复通报时间，值为13位时间戳。 最小值：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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
后台数据库存储的主键ID。 最小长度：0 最大长度：100 |
|
incident_id |
String |
事件单单号ID。 最小长度：0 最大长度：32 |
|
is_change_event |
Boolean |
是否变更事件。 |
|
failure_level |
String |
事件级别。 最小长度：0 最大长度：32 |
|
incident_url |
String |
事件单号链接。 最小长度：0 最大长度：20000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
枚举值ID。 最小长度：0 最大长度：255 |
|
name_zh |
String |
枚举值中文名。 最小长度：0 最大长度：255 |
|
name_en |
String |
枚举值英文名。 最小长度：0 最大长度：255 |
|
type |
String |
枚举类型。 最小长度：0 最大长度：255 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
受影响服务对应的唯一ID。 最小长度：0 最大长度：100 |
|
name |
String |
受影响服务的名字，比如CloudMonitorAlarm。 最小长度：0 最大长度：255 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
服务标识。 缺省值：049 最小长度：3 最大长度：3 |
|
error_code |
String |
请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 |
|
error_msg |
String |
请求响应异常时报错信息。 最小长度：0 最大长度：10240 |
|
data |
Object |
响应数据。 |
请求示例
POST https://{endpoint}/v1/external/warrooms/list
{
"offset" : 0,
"limit" : 10,
"incident_num" : "IM202504101040150000000000",
"title" : "warroom名称",
"region_code_list" : [ "region_code1", "region_code2" ],
"incident_levels" : [ "level_40", "level_50" ],
"impacted_application_ids" : [ "service_id1", "service_id2" ],
"admin" : [ "user_id1", "user_id2" ],
"status" : [ 0 ],
"triggered_start_time" : 1743350400000,
"triggered_end_time" : 1745942400000,
"occur_start_time" : 1743350400000,
"occur_end_time" : 1745942400000,
"recover_start_time" : 1743350400000,
"recover_end_time" : 1745942400000,
"notification_level" : [ "level_40", "level_50" ],
"enterprise_project_ids" : [ "project_id1", "project_id2" ],
"war_room_num" : "war_room_num",
"statistic_flag" : false,
"current_users" : [ "user_id1", "user_id2" ],
"war_room_nums" : [ "war_room_num1", "war_room_num2" ]
}
响应示例
状态码：200
查询成功响应
{
"error_code" : "COC.00080000",
"error_msg" : "success",
"data" : {
"total" : 1,
"total_num" : null,
"running_num" : null,
"list" : [ {
"id" : "warroom_id",
"title" : "warroom_title",
"admin" : "admin_user_id",
"recover_member" : [ ],
"recover_leader" : [ ],
"incident" : {
"id" : "incident_id",
"incident_id" : "IM202504101040150000000000",
"alarm_id" : null,
"is_change_event" : null,
"source_id" : null,
"failure_level" : "level_50",
"incident_url" : null
},
"source" : null,
"regions" : [ {
"code" : "region_code1",
"name" : null
} ],
"change_num" : null,
"occur_time" : 1742027787527,
"recover_time" : null,
"fault_cause" : null,
"create_time" : 1742027787528,
"first_report_time" : null,
"recovery_notification_time" : null,
"fault_impact" : null,
"description" : "",
"circular_level" : "level_50",
"war_room_status" : {
"id" : "1",
"name_zh" : "启动 warroom",
"name_en" : "Start WarRoom",
"type" : "WAR_ROOM_STATUS"
},
"impacted_application" : [ {
"name" : null,
"id" : "application_id1"
} ],
"processing_duration" : null,
"restoration_duration" : null,
"war_room_num" : "war_room_num",
"enterprise_project_id" : "0"
} ]
},
"provider_code" : "049"
}
状态码：400
查询失败
{
"error_code" : "common.01010001",
"error_msg" : "Token missing or invalid.",
"data" : null,
"provider_code" : "049"
}
错误码
请参见错误码。
