[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Retrieve Clear Alarms

Description

This operation retrieves a ClearAlarms entity. Attribute selection is enabled for all first level attributes.

Request

URL

get

https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/clearAlarms/{id}

Copy

Path Parameters

string

id Required

Identifier of the ClearAlarms

id example

"ojEVD4QBpi1WVs4LcOe9"

Query Parameters

string

fields Optional

Comma-separated properties to provide in response

fields example

"id"

Authentication

This operation uses the following authentication methods.

bearerAuth

Response

Response Body

200 OK

Returns ClearAlarms of type application/json

{
	"@baseType": null,
	"@schemaLocation": null,
	"@type": null,
	"alarmClearedTime": "2022-10-25T12:18:06.690858Z",
	"alarmPattern": [
		{
			"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_Down$Source:INCHARGE-SA-PRES$"
		},
		{
			"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_Down$Source:INCHARGE-SA-PRES$"
		}
	],
	"clearSystemId": "postman-api",
	"clearUserId": "admin",
	"clearedAlarm": [
		{
			"@baseType": "alarm",
			"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
			"@type": "notification",
			"ackState": "UNACKNOWLEDGED",
			"ackSystemId": null,
			"ackUserId": null,
			"affectedService": null,
			"alarmChangedTime": "2022-10-20T15:07:14Z",
			"alarmClearedTime": null,
			"alarmDetails": "no description available",
			"alarmEscalation": null,
			"alarmRaisedTime": "2022-10-25T08:08:45.431Z",
			"alarmReportingTime": "2022-10-25T08:08:45.431Z",
			"alarmType": "Down",
			"alarmedObject": {
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"href": "/tcsa/api/topology/v1/instances/KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5%24KubernetesPod%24INCHARGE-SA-PRES",
				"id": "KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5$KubernetesPod$INCHARGE-SA-PRES"
			},
			"alarmedObjectType": "KubernetesPod",
			"clearSystemId": null,
			"clearUserId": null,
			"comment": [
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:02:05Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:01:09Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:01:01Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:00:26Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "INCHARGE-SA: Domain Server Disconnected.",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T14:58:10Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T14:57:32Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T09:37:30Z",
					"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-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_Failed%24Source%3AINCHARGE-SA-PRES%24",
					"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_Failed$Source:INCHARGE-SA-PRES$",
					"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_Failed$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-Container_Container-0f5e85e1-a143-4b95-aff0-269c034f39e5_Failed%24Source%3AINCHARGE-SA-PRES%24",
					"id": "Name:NOTIFICATION-Container_Container-0f5e85e1-a143-4b95-aff0-269c034f39e5_Failed$Source:INCHARGE-SA-PRES$",
					"name": "Name:NOTIFICATION-Container_Container-0f5e85e1-a143-4b95-aff0-269c034f39e5_Failed$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-NetworkFunction_ContainerNetworkFunction-852df9f0-8847-41fa-b858-24b708784b5d_Impaired%24Source%3AINCHARGE-SA-PRES%24",
					"id": "Name:NOTIFICATION-NetworkFunction_ContainerNetworkFunction-852df9f0-8847-41fa-b858-24b708784b5d_Impaired$Source:INCHARGE-SA-PRES$",
					"name": "Name:NOTIFICATION-NetworkFunction_ContainerNetworkFunction-852df9f0-8847-41fa-b858-24b708784b5d_Impaired$Source:INCHARGE-SA-PRES$"
				}
			],
			"crossedThresholdInformation": {},
			"externalAlarmId": null,
			"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_Down%24Source%3AINCHARGE-SA-PRES%24",
			"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-c8b99b8c-ebc4-4d7f-851f-44a345ec08a5_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-ESM",
			"specificProblem": null,
			"state": "ACTIVE"
		},
		{
			"@baseType": "alarm",
			"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
			"@type": "notification",
			"ackState": "UNACKNOWLEDGED",
			"ackSystemId": null,
			"ackUserId": null,
			"affectedService": null,
			"alarmChangedTime": "2022-10-20T15:01:17Z",
			"alarmClearedTime": null,
			"alarmDetails": "no description available",
			"alarmEscalation": null,
			"alarmRaisedTime": "2022-10-25T08:08:45.441Z",
			"alarmReportingTime": "2022-10-25T08:08:45.441Z",
			"alarmType": "Down",
			"alarmedObject": {
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"href": "/tcsa/api/topology/v1/instances/KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551%24KubernetesPod%24INCHARGE-SA-PRES",
				"id": "KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551$KubernetesPod$INCHARGE-SA-PRES"
			},
			"alarmedObjectType": "KubernetesPod",
			"clearSystemId": null,
			"clearUserId": null,
			"comment": [
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:01:17Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T15:00:34Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "INCHARGE-SA: Domain Server Disconnected.",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T14:58:11Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T14:57:35Z",
					"type": "notification",
					"userId": "DXA"
				},
				{
					"baseType": "alarm",
					"comment": "Server: INCHARGE-SA",
					"schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
					"systemId": null,
					"time": "2022-10-20T09:37:51Z",
					"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-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_Failed%24Source%3AINCHARGE-SA-PRES%24",
					"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_Failed$Source:INCHARGE-SA-PRES$",
					"name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_Failed$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-Container_Container-e0d164fd-f630-457b-b3f7-9ce342300ad4_Failed%24Source%3AINCHARGE-SA-PRES%24",
					"id": "Name:NOTIFICATION-Container_Container-e0d164fd-f630-457b-b3f7-9ce342300ad4_Failed$Source:INCHARGE-SA-PRES$",
					"name": "Name:NOTIFICATION-Container_Container-e0d164fd-f630-457b-b3f7-9ce342300ad4_Failed$Source:INCHARGE-SA-PRES$"
				}
			],
			"crossedThresholdInformation": {},
			"externalAlarmId": null,
			"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_Down%24Source%3AINCHARGE-SA-PRES%24",
			"id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-9e646517-4db6-431b-8ac8-47ceb5ed0551_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-ESM",
			"specificProblem": null,
			"state": "ACTIVE"
		}
	],
	"href": "/tcsa/api/tmf/v1/clearAlarms/ojEVD4QBpi1WVs4LcOe9",
	"id": "ojEVD4QBpi1WVs4LcOe9",
	"state": "COMPLETED"
}

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 as date-time

alarmClearedTime Optional

Time of the alarm clearing

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

clearSystemId Optional

Name of the clearing system

string

clearUserId Optional

Name of the clearing user

array of AlarmRefOrValue

clearedAlarm Optional

The successfully cleared alarms

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

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

cURL Command

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

[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Tmf Alarms Operations

post

Create Ack Alarms

post

Create Alarm

post

Create Clear Alarms

post

Create Comment Alarms

post

Create Un Ack Alarms

delete

Delete Alarm

get

List Ack Alarms

get

List Alarm

get

List Clear Alarms

get

List Comment Alarms

get

List Un Ack Alarms

patch

Patch Alarm

get

Retrieve Ack Alarms

get

Retrieve Alarm

get

Retrieve Clear Alarms

get

Retrieve Comment Alarms

get

Retrieve Un Ack Alarms

Retrieve Clear Alarms

Request

URL

Path Parameters

id example

Query Parameters

fields example

Authentication

bearerAuth

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Tmf Alarms Operations

Was this page helpful?