Create Clear Alarms
DescriptionThis operation creates a ClearAlarms entity.
Request
URLURL
Request Body
{
"alarmPattern": [
{
"alarmedObjectType": "Container",
"state": "ACTIVE"
},
{
"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
}
],
"clearSystemId": "postman-api"
}
Alarm patterns to match target alarms. An alarm will match if an attribute in any of the patterns is equal to the corresponding attribute of the alarm. The attributes which are supported with matching are - id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.
Name of the clearing system
Time of the alarm clearing
Name of the clearing user
Current state of the operation task
Authentication
Response
Response BodyResponse Body
201 Created
{
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"alarmClearedTime": "2022-11-02T10:58:03.916199Z",
"alarmPattern": [
{
"alarmedObjectType": "Container",
"state": "ACTIVE"
},
{
"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
}
],
"clearSystemId": "postman-api",
"clearUserId": "admin",
"clearedAlarm": [],
"href": "/tcsa/api/tmf/v1/clearAlarms/qUf9N4QB9XatrL7ssv0U",
"id": "qUf9N4QB9XatrL7ssv0U",
"state": "IN_PROGRESS"
}
When sub-classing, this defines the super-class
A URI to a JSON-Schema file that defines additional attributes and relationships
When sub-classing, this defines the sub-class entity name
Time of the alarm clearing
Alarm patterns to match target alarms. An alarm will match if an attribute in any of the patterns is equal to the corresponding attribute of the alarm. The attributes which are supported with matching are - id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.
Name of the clearing system
Name of the clearing user
A reference to the task
The identifier of the task
Current state of the operation task
Errors
Bad Request
Unauthorized
Forbidden
Method Not allowed
Conflict
Internal Server Error
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: clearAlarms
