Create Comment Alarms
This operation creates a CommentAlarms entity.
The CommentAlarms to be created
Show optional properties
{
"comment": {
"comment": "Testing Comment Alarms OpenAPI"
},
"alarmPattern": [
{
"alarmedObjectType": "Container",
"state": "ACTIVE"
},
{
"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
}
]
}{
"state": "string",
"alarmPattern": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down%24Source%3AINCHARGE-SA-PRES%24",
"ackState": "UNACKNOWLEDGED",
"ackSystemId": "string",
"ackUserId": "string",
"alarmChangedTime": "string",
"alarmClearedTime": "string",
"alarmDetails": "no description available",
"alarmEscalation": false,
"alarmRaisedTime": "string",
"alarmReportingTime": "string",
"alarmType": "Down",
"alarmedObjectType": "KubernetesPod",
"clearSystemId": "string",
"clearUserId": "string",
"externalAlarmId": "string",
"isRootCause": true,
"perceivedSeverity": "CRITICAL",
"plannedOutageIndicator": "OUT_OF_SERVICE",
"probableCause": "string",
"proposedRepairedActions": "string",
"reportingSystemId": "string",
"serviceAffecting": false,
"sourceSystemId": "INCHARGE-ESM, INCHARGE-SA-PRES",
"specificProblem": "string",
"state": "ACTIVE",
"affectedService": [
{
"id": "string",
"href": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}
],
"alarmedObject": {
"id": "KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b$KubernetesPod$INCHARGE-SA-PRES",
"href": "/tcsa/api/topology/v1/instances/KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b%24KubernetesPod%24INCHARGE-SA-PRES",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification"
},
"comment": [
{
"comment": "Testing Comments for openAPI spec",
"systemId": "postman-api",
"time": "string",
"userId": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}
],
"correlatedAlarm": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"@referredType": "string"
}
],
"crossedThresholdInformation": {
"direction": "string",
"granularity": "string",
"indicatorName": "string",
"indicatorUnit": "string",
"observedValue": "string",
"thresholdCrossingDescription": "string",
"threshold": {
"id": "string",
"href": "string",
"name": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string",
"@referredType": "string"
},
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
},
"parentAlarm": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"@referredType": "string"
}
],
"place": [
{
"id": "string",
"href": "string",
"name": "string",
"role": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string",
"@referredType": "string"
}
],
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification"
}
],
"comment": {
"comment": "Testing Comments for openAPI spec",
"systemId": "postman-api",
"time": "string",
"userId": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
},
"commentedAlarm": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down%24Source%3AINCHARGE-SA-PRES%24",
"ackState": "UNACKNOWLEDGED",
"ackSystemId": "string",
"ackUserId": "string",
"alarmChangedTime": "string",
"alarmClearedTime": "string",
"alarmDetails": "no description available",
"alarmEscalation": false,
"alarmRaisedTime": "string",
"alarmReportingTime": "string",
"alarmType": "Down",
"alarmedObjectType": "KubernetesPod",
"clearSystemId": "string",
"clearUserId": "string",
"externalAlarmId": "string",
"isRootCause": true,
"name": "string",
"perceivedSeverity": "CRITICAL",
"plannedOutageIndicator": "OUT_OF_SERVICE",
"probableCause": "string",
"proposedRepairedActions": "string",
"reportingSystemId": "string",
"serviceAffecting": false,
"sourceSystemId": "INCHARGE-ESM, INCHARGE-SA-PRES",
"specificProblem": "string",
"state": "ACTIVE",
"affectedService": [
{
"id": "string",
"href": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}
],
"alarmedObject": {
"id": "KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b$KubernetesPod$INCHARGE-SA-PRES",
"href": "/tcsa/api/topology/v1/instances/KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b%24KubernetesPod%24INCHARGE-SA-PRES",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification"
},
"comment": [
{
"comment": "Testing Comments for openAPI spec",
"systemId": "postman-api",
"time": "string",
"userId": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}
],
"correlatedAlarm": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"@referredType": "string"
}
],
"crossedThresholdInformation": {
"direction": "string",
"granularity": "string",
"indicatorName": "string",
"indicatorUnit": "string",
"observedValue": "string",
"thresholdCrossingDescription": "string",
"threshold": {
"id": "string",
"href": "string",
"name": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string",
"@referredType": "string"
},
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
},
"parentAlarm": [
{
"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"@referredType": "string"
}
],
"place": [
{
"id": "string",
"href": "string",
"name": "string",
"role": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string",
"@referredType": "string"
}
],
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"@referredType": "string"
}
]
}Current state of the operation task
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.
Created
{
"id": "hEgGOIQB9XatrL7sjVDb",
"href": "/tcsa/api/tmf/v1/commentAlarms/hEgGOIQB9XatrL7sjVDb",
"state": "IN_PROGRESS",
"alarmPattern": [
{
"alarmedObjectType": "Container",
"state": "ACTIVE"
},
{
"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
}
],
"comment": {
"comment": "Testing Comment Alarms OpenAPI",
"systemId": null,
"time": "2022-11-02T11:07:44Z",
"userId": "admin",
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification"
},
"commentedAlarm": [],
"@baseType": null,
"@schemaLocation": null,
"@type": null
}The identifier of the task
A reference to the task
Current state of the operation task
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.
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
Bad Request
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.
Unauthorized
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.
Forbidden
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.
Method Not allowed
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.
Conflict
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.
Internal Server Error
{
"code": "string",
"reason": "string",
"message": "string",
"status": "string",
"referenceError": "string",
"@baseType": "string",
"@schemaLocation": "string",
"@type": "string"
}Application relevant detail, defined in the API or a common list.
Explanation of the reason for the error which can be shown to a client user.
More details and corrective actions related to the error which can be shown to a client user.
HTTP Error code extension
URI of documentation describing the error.
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.