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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
{
"description": "This type represents the information of a VNF snapshot package.\n",
"type": "object",
"required": [
"id",
"name",
"isFullSnapshot",
"state",
"isCancelPending",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshotPkgUniqueId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"checksum": {
"description": "Cheksum description\n",
"type": "string"
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfSnapshotId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcSnapshotInfoIds": {
"description": "Identifiers of information held by the VNFM about specific VNFC snapshots part of the VNF snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM during the VNF snapshot creation.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
"type": "object",
"items": {
"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
"type": "string"
}
},
"isFullSnapshot": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"vnfdInfo": {
"description": "This type represents the VNFD which is contained in a VNF snapshot package.\n",
"type": "object",
"required": [
"avnfdId",
"vnfdPath",
"checksum",
"isEncrypted"
],
"properties": {
"avnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfdPath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"checksum": {
"description": "Cheksum description\n",
"type": "string"
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
}
}
},
"vnfsr": {
"description": "This type represents the VNF snapshot record which is contained in a VNF snapshot package.\n",
"type": "object",
"required": [
"recordPath",
"checksum",
"isEncrypted"
],
"properties": {
"recordPath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"checksum": {
"description": "Cheksum description\n",
"type": "string"
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
}
}
},
"vnfcSnapshotImages": {
"description": "Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and external snapshot image shall be included. No other artifacts shall be included.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
"type": "object",
"items": {
"description": "This type represents an artifact contained in a VNF snapshot package which represents a snapshot image.\n",
"type": "object",
"required": [
"id",
"name",
"checksum",
"isEncrypted",
"vnfcInstanceId",
"containerFormat",
"diskFormat",
"createdAt",
"minDisk",
"minRam",
"size"
],
"properties": {
"id": {
"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
"type": "string"
},
"name": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"checksum": {
"description": "Cheksum description\n",
"type": "string"
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"vnfcInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"containerFormat": {
"description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format\nNOTE: The list of permitted values was taken from \"Container formats\" in [i.5] (OpenStack® documentation: \"Disk and container formats for images\").\n",
"type": "string",
"enum": [
"AKI",
"AMI",
"ARI",
"BARE",
"DOCKER",
"OVA",
"OVF"
]
},
"diskFormat": {
"description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format\nNOTE: The list of permitted values was adapted from \"Disk formats\" in [i.5] (OpenStack® documentation: \"Disk and container formats for images\").\n",
"type": "string",
"enum": [
"AKI",
"AMI",
"ARI",
"ISO",
"QCOW2",
"RAW",
"VDI",
"VHD",
"VHDX",
"VMDK"
]
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"minDisk": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"minRam": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"size": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"userMetadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"imagePath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"imageUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
},
"additionalArtifacts": {
"description": "Information about VNF snapshot artifacts that are not VNFC snapshot images.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
"type": "object",
"items": {
"description": "This type represents an artifact other than a software image which is contained in a VNF snapshot package.\n",
"type": "object",
"required": [
"checksum",
"isEncrypted"
],
"properties": {
"artifactPath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"artifactUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
},
"checksum": {
"description": "Cheksum description\n",
"type": "string"
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"state": {
"description": "State of the VNF snapshot package. Permitted values: - CREATED: the VNF snapshot package information has been created. - BUILDING: the VNF snapshot package is being built. - UPLOADING: the VNF snapshot package is being uploaded. - EXTRACTING: the VNF snapshot packages content is being extracted. - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). - ERROR: failure during the VNF snapshot package building, uploading or processing. - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task.\n",
"type": "string",
"enum": [
"CREATED",
"BUILDING",
"UPLOADING",
"EXTRACTING",
"AVAILABLE",
"ERROR",
"ERROR_EXTRACTING"
]
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"failureDetails": {
"description": "Failure details associated to current error state of the VNF snapshot package state. If \"state\" is \"ERROR\" or \"ERROR_EXTRACTING\", this attribute shall be present unless it has been requested to be excluded via an attribute selector.\n",
"type": "object",
"required": [
"errorType",
"details"
],
"properties": {
"errorType": {
"description": "Type of error, when the failure happened (building, upload, processing, extracting).\nPermitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n",
"type": "string",
"enum": [
"BUILD_ERROR",
"UPLOAD_ERROR",
"PROCESS_ERROR",
"CANCELLED",
"EXTRACTION_ERROR"
]
},
"details": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
}
}
},
"userDefinedData": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"packageContent"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"packageContent": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}