Help Center/ Cloud Operations Center/ API Reference/ API/ Fault Management/ Alarm Management/ Clearing Alarms in Batches
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Clearing Alarms in Batches

Function

This API is used to clear alarms in batches. You can manually clear alarms based on the alarm impact and alarm reporting status after the task execution.

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:clear

    Write

    -

    -

    -

    -

URI

POST /v1/alarm-mgmt/alarms/cancel

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

remarks

No

String

Definition:

Alarm remarks.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

alarm_ids

Yes

String

Definition:

Alarm ID list.

Constraints:

Select the alarm ID in the aggregated alarm inAlarm Management.

Value range:

N/A

Default value:

N/A

is_service_interrupt

No

Boolean

Definition:

Whether the service is interrupted.

Constraints:

N/A

Value range:

  • true: The service is interrupted.

  • false: The service is not interrupted.

Default value:

false

start_time

No

Long

Definition:

Fault occurrence time.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

fault_recovery_time

No

Long

Definition:

Fault rectification time.

Constraints:

N/A

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

Clear the alarms whose IDs are ALM2025071215495805XCFf001 and ALM2025071215495805XCFf002, the services are not interrupted, and remarks are Demo.

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

{
  "alarm_ids" : "ALM2025071215495805XCFf001,ALM2025071215495805XCFf002",
  "is_service_interrupt" : false,
  "remarks" : "Demo"
}

Example Responses

Status code: 200

Response is returned correctly.

{
  "data" : [ "ALM2025071215495805XCFf001", "ALM2025071215495805XCFf002" ]
}

Status Codes

Status Code

Description

200

Response is returned correctly.

Error Codes

See Error Codes.

Parent topic: Alarm Management