[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

List Un Ack Alarms

Description

This operation lists or finds UnAckAlarms entities

Request

Request

URL

URL


get
https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/unAckAlarms
Copy

Query Parameters

Query Parameters

string
fields Optional

Comma-separated properties to be provided in response

fields example
"id"

integer
limit Optional

Requested number of resources to be provided in response

limit example
10

integer
offset Optional

Requested index for start of resources to be provided in response

offset example
0

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of UnAckAlarms of type application/json
[
	{
		"@baseType": null,
		"@schemaLocation": null,
		"@type": null,
		"ackSystemId": "admin",
		"ackTime": "2022-10-25T12:03:57.637781Z",
		"ackUserId": "admin",
		"alarmPattern": [
			{
				"id": "Name:NOTIFICATION-Card_CARD-10.31.161.51[limal051]/39896_Down$Source:INCHARGE-SA-PRES$"
			},
			{
				"id": "Name:NOTIFICATION-Blade_BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7_Down$Source:INCHARGE-SA-PRES$"
			},
			{
				"id": "Name:NOTIFICATION-CPU__Performance__HostResources_I-CPU__Performance__HostResources-PSR-10.107.118.170/14_HighUtilization$Source:INCHARGE-SA-PRES$"
			}
		],
		"href": "/tcsa/api/tmf/v1/ackAlarms/b_YHD4QBpi1WVs4LJtpK",
		"id": "b_YHD4QBpi1WVs4LJtpK",
		"state": "COMPLETED",
		"unAckedAlarm": [
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"ackState": "ACKNOWLEDGED",
				"ackSystemId": null,
				"ackUserId": null,
				"affectedService": null,
				"alarmChangedTime": "2022-10-25T11:55:14Z",
				"alarmClearedTime": null,
				"alarmDetails": "Indicates that a failed card is the root cause.",
				"alarmEscalation": null,
				"alarmRaisedTime": "2022-10-25T11:55:35.670Z",
				"alarmReportingTime": "2022-10-25T11:55:35.670Z",
				"alarmType": "Down",
				"alarmedObject": {
					"@baseType": "alarm",
					"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"@type": "notification",
					"href": "/tcsa/api/topology/v1/instances/BEM-10.31.161.51%5Blimal051%5D%2F1%24BladeEnclosureManager%24INCHARGE-SA-PRES",
					"id": "BEM-10.31.161.51[limal051]/1$BladeEnclosureManager$INCHARGE-SA-PRES"
				},
				"alarmedObjectType": "Card",
				"clearSystemId": null,
				"clearUserId": null,
				"comment": [
					{
						"baseType": "alarm",
						"comment": "",
						"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"systemId": null,
						"time": "2022-10-25T11:55:14Z",
						"type": "notification",
						"userId": "admin"
					},
					{
						"baseType": "alarm",
						"comment": "Testing Comments 1 for openAPI spec",
						"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"systemId": null,
						"time": "2022-10-25T11:55:14Z",
						"type": "notification",
						"userId": "admin"
					},
					{
						"baseType": "alarm",
						"comment": "Acknowledged the notification",
						"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"systemId": null,
						"time": "2022-10-25T11:50:13Z",
						"type": "notification",
						"userId": "admin"
					},
					{
						"baseType": "alarm",
						"comment": "Server: INCHARGE-SA",
						"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"systemId": null,
						"time": "2022-10-25T11:47:14Z",
						"type": "notification",
						"userId": "DXA"
					}
				],
				"correlatedAlarm": [
					{
						"@baseType": "alarm",
						"@referredType": null,
						"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"@type": "notification",
						"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-BladeEnclosureManager_BEM-10.31.161.51%5Blimal051%5D%2F1_Unresponsive%24Source%3AINCHARGE-SA-PRES%24",
						"id": "Name:NOTIFICATION-BladeEnclosureManager_BEM-10.31.161.51[limal051]/1_Unresponsive$Source:INCHARGE-SA-PRES$",
						"name": "Name:NOTIFICATION-BladeEnclosureManager_BEM-10.31.161.51[limal051]/1_Unresponsive$Source:INCHARGE-SA-PRES$"
					},
					{
						"@baseType": "alarm",
						"@referredType": null,
						"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
						"@type": "notification",
						"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Blade_BLD-BEM-10.31.161.51%5Blimal051%5D%2F1%2Fsys%2Fchassis-1%2Fblade-7_Unresponsive%24Source%3AINCHARGE-SA-PRES%24",
						"id": "Name:NOTIFICATION-Blade_BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7_Unresponsive$Source:INCHARGE-SA-PRES$",
						"name": "Name:NOTIFICATION-Blade_BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7_Unresponsive$Source:INCHARGE-SA-PRES$"
					}
				],
				"crossedThresholdInformation": {},
				"externalAlarmId": null,
				"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-Card_CARD-10.31.161.51%5Blimal051%5D%2F39896_Down%24Source%3AINCHARGE-SA-PRES%24",
				"id": "Name:NOTIFICATION-Card_CARD-10.31.161.51[limal051]/39896_Down$Source:INCHARGE-SA-PRES$",
				"instanceName": null,
				"isRootCause": true,
				"parentAlarm": [],
				"perceivedSeverity": "CRITICAL",
				"place": [],
				"plannedOutageIndicator": "OUT_OF_SERVICE",
				"probableCause": null,
				"proposedRepairedActions": null,
				"reportingSystemId": null,
				"rootCause": true,
				"serviceAffecting": null,
				"source": null,
				"sourceSystemId": "INCHARGE-AM, INCHARGE-SA-PRES",
				"specificProblem": null,
				"state": "ACTIVE"
			}
		]
	}
]
string
@baseType Optional

When sub-classing, this defines the super-class


string as uri
@schemaLocation Optional

A URI to a JSON-Schema file that defines additional attributes and relationships


string
@type Optional

When sub-classing, this defines the sub-class entity name


string
ackSystemId Optional

Name of the unacknowledging system


string as date-time
ackTime Optional

Time of the unacknowledgement


string
ackUserId Optional

Name of the unacknowledging user


array of Alarm
alarmPattern Optional

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.


string
href Optional

A reference to the task


string
id Optional

The identifier of the task


string
state Optional

Current state of the operation task


array of AlarmRefOrValue
unAckedAlarm Optional

The successfully unacknowledged alarms

Response Headers
integer
X-Result-Count

Actual number of items returned in the response body

X-Result-Count example
10
integer
X-Total-Count

Total number of items matching criteria

X-Total-Count example
1000
Errors

Errors

Error
400

Bad Request


Error
401

Unauthorized


Error
403

Forbidden


Error
404

Not Found


Error
405

Method Not allowed


Error
409

Conflict


Error
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/unAckAlarms


Feedback

Was this page helpful?