Querying Alarm Details

alarm_id

Yes

String

Definition:

Alarm ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

data

AlarmInfoDTO object

Details about an alarm.

id

String

Definition:

Alarm ID, which uniquely identifies an alarm. You can obtain the alarm ID from the aggregated alarms page of the alarm management module on COC.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

name

String

Definition:

Alarm name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

importance

String

Definition:

Alarm severity.

Constraints:

N/A

Value range:

urgent

• major

• minor

• warn

Default value:

N/A

come_from

String

Description:

Alarm source, which can be obtained from the alarm source integration management module on the COC page. The value is the name of each cloud service.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

transfer_rule

String

Definition:

Unique ID of an alarm conversion rule. You can obtain the alarm conversion rule ID from the alarm management module of COC. An alarm is created using an alarm conversion rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

transfer_rule_name

String

Definition:

Name of the alarm conversion rule. You can obtain the alarm conversion rule name from the alarm management module of COC.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

app

String

Definition:

Application name. You need to enter the application name when creating an alarm conversion rule. You can obtain the application name from the alarm conversion rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

status

String

Description:

Alarm status. There are two alarm statuses: alarming and resolved. When you click Clear Alarm for an alarm, the alarm status changes to Resolved.

Constraints:

N/A

Value range:

• alarming: An alarm is being generated.

• resolved: The alarm is cleared.

Default value:

alarming

owner

String

Definition:

Owner ID. When creating an alarm conversion rule, you need to specify the owner. You can obtain the owner ID in the personnel management module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

owner_name

String

Definition:

Owner name. When creating an alarm conversion rule, you need to specify the owner. You can obtain the owner name in the personnel management module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

owner_alias

String

Definition:

Owner alias. COC allows you to set aliases for owners. You can obtain the aliases in the personnel management module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

converge_count

Integer

Definition:

Number of alarms that meet the alarm conversion rule in a specified period.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

associate_event_id

String

Definition:

Associated incident ID, which uniquely identifies an incident. You can obtain the incident ID from the incident management page on COC. After an alarm is converted to an incident, the alarm can be associated with an incident.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

domain_id

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

creator

String

Definition:

ID of the user who creates the alarm conversion rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

creator_name

String

Definition:

Name of the user who creates the alarm conversion rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

create_time

Long

Definition:

Time the alarm was created.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

update_time

Long

Definition:

Alarm update time. This parameter is updated when you perform operations on an alarm.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

remarks

String

Definition:

Remarks. You can enter remarks when clearing an alarm.

Value range:

N/A

Default value:

N/A

region

String

Definition:

Region ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

task_type

String

Definition:

Task type. A specific task needs to be executed to handle alarms. For details, see the value range.

Constraints:

N/A

Value range:

• SCRIPT: script

• RUNBOOK: job

• PLAN: contingency plan

Default value:

N/A

associated_task_type

String

Definition:

Task type. Each task can be classified as a custom task or a public task. Custom tasks are created by users, and public tasks are those provided by COC.

Constraints:

N/A

Value range:

• CUSTOMIZATION: custom task.

• COMMUNAL: public task.

Default value:

N/A

associated_task_id

String

Definition:

Unique ID of a task. You can obtain the task ID from the Resource O&M > Automated O&M page on COC.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

associated_task_name

String

Definition:

Task name. You can obtain the task name from the Resource O&M > Automated O&M page on COC.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_code

String

Error code

error_msg

String

Error description

200

The details about the alarm are queried successfully.

400

Invalid request from the client.