Help Center/ Cloud Operations Center/ API Reference/ API/ Fault Management/ Alarm Management/ Converting an Alarm Ticket to an Incident Ticket
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Converting an Alarm Ticket to an Incident Ticket

Function

This API is used to convert an alarm ticket to an incident ticket. You can manually convert an alarm ticket to an incident ticket based on the alarm impact and the alarm reporting status after the task execution. If the alarm impact is severe, you can handle the alarm based on the incident handling process.

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:alarm:createAlarmLinkedIncident

    Write

    -

    -

    -

    -

URI

POST /v1/alarm-mgmt/alarms-linked-incident

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

alarm_ids

Yes

String

Definition:

Alarm ID list. Each alarm ID 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

enterprise_project_id

No

String

Definition:

Enterprise project ID. Enterprise ID created by a user on EPS.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

assignee

No

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

assignee_role

No

String

Definition:

Shift name. You can obtain the shift name on the shift management page of the basic configuration module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

assignee_scene

No

String

Definition:

Shift role. You can obtain the shift role on the shift management page of the basic configuration module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

attachment

No

String

Definition:

Attachment list. You can upload attachments when an alarm ticket is converted into an incident ticket.

Constraints:

N/A

Value range:

0–1,024 characters.

Default value:

N/A

current_cloud_service_id

Yes

String

Definition:

Faulty application ID. When you select an incident ticket, you can select an application where the incident occurs.

Constraints:

Select the ID of the application in the raw alarm inAlarm Management.

Value range:

0–255 characters.

Default value:

N/A

description

Yes

String

Definition:

Incident description.

Constraints:

N/A

Value range:

0–600 characters.

Default value:

N/A

is_change_event

No

Boolean

Definition:

Whether to change the incident ticket.

Constraints:

N/A

Value range:

  • false: The incident ticket is not interrupted.

  • true: The incident ticket is interrupted.

Default value:

false

is_service_interrupt

Yes

Boolean

Definition:

Whether the service is interrupted.

Constraints:

N/A

Value range:

  • false: The service is not interrupted.

  • true: The service is interrupted.

Default value:

false

level_id

Yes

String

Definition:

Incident level.

Constraints:

N/A

Value range:

  • level_10: P1 incident

  • level_20: P2 incident

  • level_30: P3 incident

  • level_40: P4 incident

  • level_50: P5 incident

Default value:

level_50

mtm_region

No

String

Definition:

Region ID. You can select the region where the incident occurs.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

mtm_type

Yes

String

Definition:

Incident type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

source_id

No

String

Definition:

Incident creation mode. You can set the incident creation mode based on the site requirements.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

title

Yes

String

Definition:

Incident name.

Constraints:

0–255 characters.

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

data

Array of strings

Definition:

IDs of cleared alarms.

Constraints:

N/A

Default value:

N/A

Example Requests

Convert the alarm whose ID is ALM2025071420081505ylU68fX to a P5 incident.

GET https://{Endpoint}//v1/alarm-mgmt/alarms-linked-incident

{
  "alarm_ids" : "ALM2025071420081505ylU68fX",
  "mtm_region" : "",
  "enterprise_project_id" : "0",
  "current_cloud_service_id" : "****",
  "level_id" : "level_50",
  "is_service_interrupt" : false,
  "mtm_type" : "inc_type_p_monitoring_issues",
  "title" : "test",
  "description" : "Demo",
  "owner" : {
    "group_type" : "user",
    "schedule_scene" : null,
    "schedule_role" : null,
    "users" : "****"
  },
  "fault_time" : null,
  "attachment" : "[]",
  "assignee" : "****",
  "assignee_scene" : null,
  "assignee_role" : null,
  "source_id" : "incident_source_alarm"
}

Example Responses

Status code: 200

Response is returned correctly.

{
  "data" : [ "ALM2025071420081505ylU68fX" ]
}

Status Codes

Status Code

Description

200

Response is returned correctly.

Error Codes

See Error Codes.

Parent topic: Alarm Management