List Clear Alarms

List Clear Alarms

This operation lists or finds ClearAlarms entities

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/tmf/v1/clearAlarms
COPY
Query Parameters
string
fields
Optional

Comma-separated properties to be provided in response

fields example 
id
integer
offset
Optional

Requested index for start of resources to be provided in response

integer
limit
Optional

Requested number of resources to be provided in response

limit example 
10
Authentication
This operation uses the following authentication methods.
Responses
200

Success

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

Response Headers

integer
X-Total-Count

Total number of items matching criteria

integer
X-Result-Count

Actual number of items returned in the response body


400

Bad Request

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


401

Unauthorized

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


403

Forbidden

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


404

Not Found

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


405

Method Not allowed

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


409

Conflict

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


500

Internal Server Error

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


On This Page
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