Querying WarRoom Information

Updated on 2024-10-21 GMT+08:00

View PDF

Function

This API is used to query war room information.

URI

POST /v1/external/WarRooms/list

Request Parameters

**Table 1** Request body parameter
Parameter	Mandatory or Not	Type	Description
limit	No	Long	limit Minimum value: 0 Maximum value: 1000 Default value: 0
offset	No	Long	Number of records to be queried. Minimum value: 0 Maximum value: 9223372036854775807 Default value: 10
incident_num	No	String	Incident ticket number (queried by exact query) Minimum length: 0 character Maximum length: 64 characters
title	No	String	War room name (queried by fuzzy query) Minimum length: 0 character Maximum length: 1,000 characters
region_code_list	No	Array of strings	Regions. Multiple values can be selected. Minimum length: 0 character Maximum length: 200 characters Array length: 0 to 1,000 elements
incident_levels	No	Array of strings	Incident level. Multiple values can be selected. Minimum length: 0 character Maximum length: 32 characters Array length: 0 to 1,000 elements
impacted_application_ids	No	Array of strings	ID of the affected application Minimum length: 0 character Maximum length: 200 characters Array length: 0 to 1,000 elements
admin	No	Array of strings	War room administrator. Minimum length: 0 character Maximum length: 200 characters Array length: 0 to 1,000 elements
status	No	Array of strings	War room status. Minimum length: 0 character Maximum length: 10 characters Array length: 0 to 100 characters
triggered_start_time	No	Long	Trigger start time. The default value is 30 days before the start time. Minimum value: 0 Maximum value: 9223372036854775807
triggered_end_time	No	Long	Trigger end time. By default, the current time is the used. Minimum value: 0 Maximum value: 9223372036854775807
occur_start_time	No	Long	Occurrence start time Minimum value: 0 Maximum value: 9223372036854775807
occur_end_time	No	Long	Occurrence end time Minimum value: 0 Maximum value: 9223372036854775807
recover_start_time	No	Long	Recovery start time Minimum value: 0 Maximum value: 9223372036854775807
recover_end_time	No	Long	Recovery end time Minimum value: 0 Maximum value: 9223372036854775807
notification_level	No	Array of strings	Notification level Minimum length: 0 character Maximum length: 32 characters Array length: 0 to 1,000 elements
enterprise_project_ids	No	Array of strings	Enterprise project ID Minimum length: 0 character Maximum length: 64 characters Array length: 0 to 500 characters
war_room_num	No	String	War room ticket number, which is used by the frontend. Minimum length: 0 character Maximum length: 255 characters
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 value: false

Response Parameters

Status code: 200

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

**Table 3** data
Parameter	Type	Description
list	Array of WarRoomTenantInfo objects	War room information. Array length: 0 to 1,000 elements
total	Long	Total number. Minimum value: 0 Maximum value: 9223372036854775807
running_num	Long	Total number of war rooms in progress Minimum value: 0 Maximum value: 9223372036854775807
closed_num	Long	Total number of closed war rooms Minimum value: 0 Maximum value: 9223372036854775807
total_num	Long	Total war rooms Minimum value: 0 Maximum value: 9223372036854775807

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

**Table 5** WarRoomIncident
Parameter	Type	Description
id	String	Primary key Minimum length: 0 character Maximum length: 100 characters
incident_id	String	Incident ID Minimum length: 0 character Maximum length: 32 characters
is_change_event	Boolean	Whether the incident is a change incident
failure_level	String	Incident level Minimum length: 0 character Maximum length: 32 characters
incident_url	String	Incident ticket ID URL Minimum length: 0 character Maximum length: 20,000 characters

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

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

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

Status code: 400

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

Request Example

{
  "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
}

Response Example

None

Status Code

Status Code	Description
200	Response indicating a successful query.
400	Request failed.

Parent topic: WarRoom

Previous topic: Creating a War Room

Next topic: Integration Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel