Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
{
"swagger": "2.0",
"info": {
"version": "1.1.1",
"title": "DRAFT - SOL002 - VNF Fault Management interface",
"description": "DRAFT VNF Fault Management interface of ETSI NFV SOL002\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---\n",
"license": {
"name": "ETSI Forge copyright notice",
"url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
}
},
"externalDocs": {
"description": "ETSI GS NFV-SOL 002 V2.4.1",
"url": "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf"
},
"basePath": "/vnffm/v1",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/alarms": {
"get": {
"description": "The client can use this method to retrieve information about the alarm list.\n",
"parameters": [
{
"name": "Accept",
"description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "Content-Type",
"description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"description": "The authorization token for the request. Reference: IETF RFC 7235\n",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded. The response body shall contain the list of related alarms.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "The alarm data type encapsulates information about an alarm.\n",
"type": "object",
"required": [
"id",
"managedObjectId",
"rootCauseFaultyResource",
"alarmRaisedTime",
"ackState",
"perceivedSeverity",
"eventTime",
"eventType",
"probableCause",
"isRootCause",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"managedObjectId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"rootCauseFaultyResource": {
"description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
"type": "object",
"required": [
"faultyResource",
"faultyResourceType"
],
"properties": {
"faultyResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Type of the resource in the scope of the VIM or the resource provider.\n",
"type": "string"
}
}
},
"faultyResourceType": {
"description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
"type": "string",
"enum": [
"COMPUTE",
"STORAGE",
"NETWORK"
]
}
}
},
"alarmRaisedTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"alarmChangedTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"alarmClearedTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"ackState": {
"description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
"type": "string",
"enum": [
"UNACKNOWLEDGED",
"ACKNOWLEDGED"
]
},
"perceivedSeverity": {
"type": "string"
},
"eventTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"eventType": {
"type": "string"
},
"faultType": {
"description": "Additional information to clarify the type of the fault.\n",
"type": "string"
},
"probableCause": {
"description": "Information about the probable cause of the fault.\n",
"type": "string"
},
"isRootCause": {
"description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
"type": "boolean"
},
"correlatedAlarmIds": {
"description": "List of identifiers of other alarms correlated to this fault.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"faultDetails": {
"description": "Provides additional information about the fault.\n",
"type": "array",
"items": {
"type": "string"
}
Loading
Loading full blame…