Querying War Room Information

Function

This API is used to query the war room information list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:warroom:list	List	-	-	-	-

URI

POST /v1/external/warrooms/list

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
limit	No	Long	limit Minimum: 0 Maximum: 1000 Default: 0
offset	No	Long	Number of queried items Minimum value: 0. Maximum value: 1000 Minimum: 0 Maximum: 9223372036854775807 Default: 10
current_users	No	Array of strings	User ID Minimum: 0 Maximum: 200 Array Length: 0 - 1000
war_room_nums	No	Array of strings	War room ticket number. If this filtering condition is available, ignore other filtering conditions. Minimum: 0 Maximum: 255 Array Length: 0 - 1000
incident_num	No	String	Incident ticket number (queried by exact query) Minimum: 0 Maximum: 64
title	No	String	Fuzzy query of war room names Minimum: 0 Maximum: 1000
region_code_list	No	Array of strings	Regions. Multiple values can be selected. Minimum: 0 Maximum: 200 Array Length: 0 - 1000
incident_levels	No	Array of strings	Incident level. Multiple values can be selected. Minimum: 0 Maximum: 32 Array Length: 0 - 1000
impacted_application_ids	No	Array of strings	ID of the affected application Minimum: 0 Maximum: 200 Array Length: 0 - 1000
admin	No	Array of strings	War room administrator Minimum: 0 Maximum: 200 Array Length: 0 - 1000
status	No	Array of strings	War room status Minimum: 0 Maximum: 10 Array Length: 0 - 100
triggered_start_time	No	Long	Trigger start time. The default value is 30 days before the start time. Minimum: 0 Maximum: 9223372036854775807
triggered_end_time	No	Long	Trigger end time. By default, the current time is the used. Minimum: 0 Maximum: 9223372036854775807
occur_start_time	No	Long	Occurrence start time Minimum: 0 Maximum: 9223372036854775807
occur_end_time	No	Long	Occurrence end time Minimum: 0 Maximum: 9223372036854775807
recover_start_time	No	Long	Recovery start time Minimum: 0 Maximum: 9223372036854775807
recover_end_time	No	Long	Recovery end time Minimum: 0 Maximum: 9223372036854775807
notification_level	No	Array of strings	Notification level Minimum: 0 Maximum: 32 Array Length: 0 - 1000
enterprise_project_ids	No	Array of strings	Enterprise project ID Minimum: 0 Maximum: 64 Array Length: 0 - 500
war_room_num	No	String	Front-end use of the war room ticket number Minimum: 0 Maximum: 255
statistic_flag	No	Boolean	Whether to collect statistics. If the value is false, basic information is returned. If the value is true, only the statistics result, including total_num, running_num, and closed_num, is returned. Default: false

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID Default: 4 Minimum: 3 Maximum: 3
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Minimum: 1 Maximum: 20
error_msg	String	Request response description Minimum: 0 Maximum: 10240
data	data object	Response data.

**Table 3** data
Parameter	Type	Description
list	Array of WarRoomTenantInfo objects	War room information Array Length: 0 - 1000
total	Long	Total number Minimum: 0 Maximum: 9223372036854775807
running_num	Long	Total number of ongoing war rooms Minimum: 0 Maximum: 9223372036854775807
closed_num	Long	Total number of closed war rooms Minimum: 0 Maximum: 9223372036854775807
total_num	Long	Total number of war rooms Minimum: 0 Maximum: 9223372036854775807

**Table 4** WarRoomTenantInfo
Parameter	Type	Description
id	String	Primary key Minimum: 0 Maximum: 100
title	String	Title Minimum: 0 Maximum: 255
admin	String	War room administrator Minimum: 0 Maximum: 255
recover_member	Array of strings	Members of recovery Minimum: 0 Maximum: 255 Array Length: 0 - 1000
recover_leader	Array of strings	Primary recovery owner Minimum: 0 Maximum: 255 Array Length: 0 - 1000
incident	WarRoomIncident object	Incident
source	String	Incident source Minimum: 0 Maximum: 255
regions	Array of regions objects	Affected region Array Length: 0 - 1000
change_num	String	Change ticket number Minimum: 0 Maximum: 255
occur_time	Long	Start time Minimum: 0 Maximum: 9223372036854775807
recover_time	Long	Fault rectification time Minimum: 0 Maximum: 9223372036854775807
fault_cause	String	Fault cause Minimum: 0 Maximum: 255
create_time	Long	Addition time Minimum: 0 Maximum: 9223372036854775807
first_report_time	Long	First notification time Minimum: 0 Maximum: 9223372036854775807
recovery_notification_time	Long	Recovery notification time Minimum: 0 Maximum: 9223372036854775807
fault_impact	String	Fault impact Minimum: 0 Maximum: 255
description	String	War room description Minimum: 0 Maximum: 255
circular_level	String	The notification level is the same as the incident level in the tenant zone Minimum: 0 Maximum: 32
war_room_status	WarRoomEnumeration object	War room status
impacted_application	Array of impacted_application objects	Affected application Array Length: 0 - 1000
processing_duration	Long	Handling duration (minutes) Minimum: 0 Maximum: 9223372036854775807
restoration_duration	Long	Recovery duration (minute) Minimum: 0 Maximum: 9223372036854775807
war_room_num	String	War room ticket number Minimum: 0 Maximum: 255
enterprise_project_id	String	Enterprise project ID Minimum: 0 Maximum: 64

**Table 5** WarRoomIncident
Parameter	Type	Description
id	String	Primary key Minimum: 0 Maximum: 100
incident_id	String	Incident ID Minimum: 0 Maximum: 32
alarm_id	String	Alarm ID Minimum: 0 Maximum: 64
is_change_event	Boolean	Whether to change the incident
source_id	Long	Source ID Minimum: 0 Maximum: 9223372036854775807
failure_level	String	Incident level Minimum: 0 Maximum: 32
incident_url	String	Incident ticket ID URL Minimum: 0 Maximum: 20000

**Table 6** regions
Parameter	Type	Description
code	String	Primary key Minimum: 0 Maximum: 100
name	String	Name Minimum: 0 Maximum: 255

**Table 7** WarRoomEnumeration
Parameter	Type	Description
id	String	Enumerated value ID Minimum: 0 Maximum: 255
name_zh	String	Enumerated value name (Chinese) Minimum: 0 Maximum: 255
name_en	String	Enumerated value name (English) Minimum: 0 Maximum: 255
type	String	Enumerated type Minimum: 0 Maximum: 255

**Table 8** impacted_application
Parameter	Type	Description
id	String	Primary key Minimum: 0 Maximum: 100
name	String	Name Minimum: 0 Maximum: 255

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID Default: 4 Minimum: 3 Maximum: 3
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Minimum: 1 Maximum: 20
error_msg	String	Request response description Minimum: 0 Maximum: 10240
data	Object	Response data

Example Requests

/v1/warroom/list

{
  "marker" : 10,
  "page_size" : 1,
  "incident_num" : "string",
  "title" : "string",
  "change_num" : "string",
  "region_ids" : [ 0 ],
  "level_names" : [ "string" ],
  "impacted_services_ids" : [ 0 ],
  "root_cause_service_ids" : [ 0 ],
  "site_ids" : [ 0 ],
  "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,
  "effectiveness" : [ "string" ],
  "recover_leader_id" : [ 0 ],
  "pre_warning_briefing_p2" : true,
  "is_verify" : true
}