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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
{
"info": {
"_postman_id": "b66f95b1-925a-464a-8441-f85439a33f89",
"name": "SOL005 - NSD Management Interface",
"description": "DRAFT - SOL005 - NSD Management Interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "ns_descriptors",
"description": "Folder for ns_descriptors",
"item": [
{
"name": "Query NSD Info",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors"
]
},
"description": "The GET method queries information about multiple NS descriptor resources. This method shall follow the provisions specified in the Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Create NSD Info",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors"
]
},
"description": "The POST method is used to create a new NS descriptor resource. This method shall follow the provisions specified in the Tables 5.4.2.3.1-1 and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Query NSD Info",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors/{{nsdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors",
"{{nsdInfoId}}"
]
},
"description": "The GET method reads information about an individual NS descriptor. This method shall follow the provisions specified in GS NFV-SOL 005 Tables 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Update NSD Info",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors/{{nsdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors",
"{{nsdInfoId}}"
]
},
"description": "The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource. This method can be used to:\n1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new\nnetwork service with this descriptor. The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of\nnew network service(s) with this descriptor. The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change\nas a result.\n3) Modify the user defined data of an individual NS descriptor resource.\nThis method shall follow the provisions specified in the Tables 5.4.3.3.4-1 and 5.4.3.3.4-2 for URI query parameters,\nrequest and response data structures, and response codes."
},
"response": []
},
{
"name": "Delete NSD",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors/{{nsdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors",
"{{nsdInfoId}}"
]
},
"description": "The DELETE method deletes an individual NS descriptor resource. An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method shall fail. This method shall follow the provisions specified in the Tables 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Get NSD Content",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Range",
"value": "{{Range}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors/{{nsdInfoId}}/nsd_content",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors",
"{{nsdInfoId}}",
"nsd_content"
]
},
"description": "The GET method fetches the content of the NSD.\n\nThe NSD can be implemented as a single file or as a collection of multiple files. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned.\n\nThe selection of the format is controlled by the \"Accept\" HTTP header passed in the GET request:\n\n• If the \"Accept\" header contains only \"text/plain\" and the NSD is implemented as a single file, the file shall be returned; otherwise, an error message shall be returned.\n\n• If the \"Accept\" header contains only \"application/zip\", the single file or the multiple files that make up the NSD shall be returned embedded in a ZIP file.\n\n• If the \"Accept\" header contains both \"text/plain\" and \"application/zip\", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned.\n\nNOTE: The structure of the NSD zip file is outside the scope of the present document."
},
"response": []
},
{
"name": "Upload NSD",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "{{Content-Type}}"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}ns_descriptors/{{nsdInfoId}}/nsd_content",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}ns_descriptors",
"{{nsdInfoId}}",
"nsd_content"
]
},
"description": "The PUT method is used to upload the content of a NSD. The NSD to be uploaded can be implemented as a single file or as a collection of multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be uploaded. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be uploaded. The \"Content-Type\" HTTP header in the PUT request shall be set accordingly based on the format selection of the NSD. If the NSD to be uploaded is a text file, the \"Content-Type\" header is set to \"text/plain\". If the NSD to be uploaded is a zip file, the \"Content-Type\" header is set to \"application/zip\". This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2 of GS-NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
}
]
},
{
"name": "pnf_descriptors",
"description": "Folder for pnf_descriptors",
"item": [
{
"name": "Query PFND Info",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors?exclude_default={{exclude_default}}&all_fields={{all_fields}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors"
],
"query": [
{
"key": "exclude_default",
"value": "{{exclude_default}}"
},
{
"key": "all_fields",
"value": "{{all_fields}}"
}
]
},
"description": "The GET method queries information about multiple PNF descriptor resources."
},
"response": []
},
{
"name": "Create PNFD Info",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors"
]
},
"description": "The POST method is used to create a new PNF descriptor resource."
},
"response": []
},
{
"name": "Query PNFD Info",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors/{{pnfdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors",
"{{pnfdInfoId}}"
]
},
"description": "The GET method reads information about an individual PNF descriptor. This method shall follow the provisions specified in the Tables 5.4.6.3.2-1 and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Update PNFD Info",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors/{{pnfdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors",
"{{pnfdInfoId}}"
]
},
"description": "The PATCH method modifies the user defined data of an individual PNF descriptor resource. This method shall follow the provisions specified in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Delete PNFD",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors/{{pnfdInfoId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors",
"{{pnfdInfoId}}"
]
},
"description": "The DELETE method deletes an individual PNF descriptor resource. An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD referencing it. To delete all PNFD versions identified by a particular value of the \"pnfdInvariantId\" attribute, the procedure is to first use the GET method with filter \"pnfdInvariantId\" towards the PNF descriptors resource to find all versions of the PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. This method shall follow the provisions specified in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes."
},
"response": []
},
{
"name": "Get PNFD Content",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors/{{pnfdInfoId}}/pnfd_content",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors",
"{{pnfdInfoId}}",
"pnfd_content"
]
},
"description": "The GET method fetches the content of the PNFD."
},
"response": []
},
{
"name": "Upload PNFD",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "{{Content-Type}}"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}pnf_descriptors/{{pnfdInfoId}}/pnfd_content",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}pnf_descriptors",
"{{pnfdInfoId}}",
"pnfd_content"
]
},
"description": "The PUT method is used to upload the content of a PNFD. This method shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2 of GS NFV-SOL 005for URI query parameters, request and response data structures, and response codes."
},
"response": []
}
]
},
{
"name": "subscriptions",
"description": "Folder for subscriptions",
"item": [
{
"name": "Query Subscription Information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}subscriptions",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}subscriptions"
]
},
"description": "The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005."
},
"response": []
},
{
"name": "Subscribe",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}subscriptions",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}subscriptions"
]
},
"description": "The POST method creates a new subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2 of GS-NFV SOL 005. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the \"201 Created\" response code), or may decide to not create a duplicate subscription resource (in which case it shall return a \"303 See Other\" response code referencing the existing subscription resource with the same filter and callbackUri)."
},
"response": []
},
{
"name": "Query Subscription Information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}subscriptions/:subscriptionId",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}subscriptions",
":subscriptionId"
],
"variable": [
{
"key": "subscriptionId",
"value": ""
}
]
},
"description": "The GET method retrieves information about a subscription by reading an individual subscription resource. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2."
},
"response": []
},
{
"name": "Terminate Subscription",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}subscriptions/:subscriptionId",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}subscriptions",
":subscriptionId"
],
"variable": [
{
"key": "subscriptionId",
"value": ""
}
]
},
"description": "The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.9.3.5-1 and 5.4.9.3.3-2 of GS NFV-SOL 005."
},
"response": []
}
]
}
]
}