forked from trema/virtual-network-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
693 lines (612 loc) · 14.8 KB
/
api.html
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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
<!DOCTYPE html>
<head>
<meta charset="UTF-8">
<title>Virtual Network Management API</title>
<style type="text/css">
body
{
background-color: #f8f8ff;
margin: 0px 0px 0px 0px;
padding: 12px;
font-family : Verdana, Arial, Helvetica, sans-serif;
}
table
{
margin: 12px;
border: 1px #e3e3e3 solid;
border-collapse: collapse;
border-spacing: 0;
table-layout: fixed;
word-wrap: break-word;
width: 98%;
}
th
{
padding: 5px;
border: 1px #e3e3e3 solid;
border-width: 0 0 1px 1px;
text-align: center;
}
th.request, th.response
{
width: 45%;
}
th.response
{
width: 40%;
}
td
{
padding: 5px;
border: 1px #e3e3e3 solid;
border-width: 0 0 1px 1px;
text-align: left;
}
h1
{
font-size : 20pt;
border-top: solid 1px blue;
border-bottom: solid 1px blue;
padding: 5px;
text-align: center;
}
h2
{
font-size : 16pt;
border-left: blue 8px solid;
border-bottom: blue 1px solid;
background: #f5f5f5;
padding: 5px 0 5px 15px;
text-align: left;
}
h3
{
font-size : 14pt;
border-left: blue 8px solid;
background: #f5f5f5;
padding: 5px 0 5px 15px;
text-align: left;
}
p.footer
{
font-size: 14px;
margin: 10px;
text-align: right;
background: #f5f5f5;
color: #808080;
}
</style>
</head>
<body>
<h1>Virtual Network Management API</h1>
<h2>Basics</h2>
<h3>Request and Response</h3>
<p>
Request messages which require body part, they must be properly formatted with the JSON
(JavaScript Object Notation). Content-Type must be <i>application/json</i> and
other types are not accepted.
</p>
<p>
Response codes may be "200 OK" or "202 Accepted" if a requested operation is successfully
completed or accepted. "202 Accepted" must be interpreted as the request is just accepted
and does not mean the operation is successfully completed. The client must proactively
check if the operation is successfully completed or not after receiving 202 response.
</p>
<p>
Response codes may be 4XX or 5XX if a requested operation is not successfully completed.
Only typical errors are shown in the tables below and you must prepare for other response
codes. Error responses may contain body other format than application/json (e.g. text/plain)
for describing errors in detail.
</p>
<h3>JSON formatting</h3>
<p>
Any integer values smaller than or equal to 32-bit are represented as integer values.
They must not be text strings.
</p>
<p>
64-bit integer values are represented as text strings for compatibility with different
JSON implementations. Several JSON implementations do not accept integer values greater
than 32-bit.
</p>
<h2>API</h2>
<!-- /networks -->
<h3>/networks</h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks -->
<tr>
<td rowspan="2">GET</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">List existing networks.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="list_networks.json">list_networks.json</a></td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- POST /networks -->
<tr>
<td rowspan="4">POST</td>
<td>id</td>
<td>A unique identifier of the network.
The value must be a value between 0 and 16777215.
If omitted, the value is automatically assigned.</td>
<td rowspan="4">application/json</td>
<td rowspan="4"><a href="create_network.json">create_network.json</a></td>
<td rowspan="4">Create a new network associated.</td>
<td>202 Accepted</td>
<td>application/json</td>
<td><a href="create_network_response.json">create_network_response.json</a></td>
</tr>
<tr>
<td rowspan="3">description</td>
<td rowspan="3">Description (text string) of the network.
If omitted, an empty string is saved.</td>
<td>400 Bad request</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>422 Specified parameters are unacceptable</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<!-- /networks/<net_id> -->
<h3>/networks/<net_id></h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks/<net_id> -->
<tr>
<td rowspan="3">GET</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">Show details of the network identified by net_id.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="show_network.json">show_network.json</a></td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- PUT /networks/<net_id> -->
<tr>
<td rowspan="5">PUT</td>
<td rowspan="5">description</td>
<td rowspan="5">Description (text string) of the network.
This is a mandatory parameter.</td>
<td rowspan="5">application/json</td>
<td rowspan="5"><a href="modify_network.json">modify_network.json</a></td>
<td rowspan="5">Update details of the network identified by net_id.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>400 Bad request</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- DELETE /networks/<net_id> -->
<tr>
<td rowspan="4">DELETE</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">Delete the network identified by net_id.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<!-- /networks/<net_id>/ports -->
<h3>/networks/<net_id>/ports</h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks/<net_id>/ports -->
<tr>
<td rowspan="3">GET</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">List all switch ports associated with the network identified by net_id.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="show_ports.json">show_ports.json</a></td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- POST /networks/<net_id>/ports -->
<tr>
<td rowspan="6">POST</td>
<td>id</td>
<td>A unique identifier of the switch port.
The value must be a value between 1 and 4294967295.
If omitted, the value is automatically assigned.</td>
<td rowspan="6">application/json</td>
<td rowspan="6"><a href="create_port.json">create_port.json</a></td>
<td rowspan="6">Attach a switch port to the network identified by net_id.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>datapath_id</td>
<td>Datapath identifier of the switch which the switch port belongs.
The value must be an unsigned 64-bit integer value represented as a text string.
This is a mandatory parameter.</td>
<td>400 Bad request</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>number</td>
<td rowspan="2">Port number and name of the switch port.
Port number must be a value between 1 and 65280.
Port name must be a text string.
<i>number</i> and <i>name</i> are exclusive and one of them must be provided.</td>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>name</td>
<td>422 Specified parameters are unacceptable</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>vid</td>
<td>VLAN identifier of the switch port.
You can multiplex multiple networks on a single switch port with 802.1q VLAN.
The value must be a value between 0 and 4095 or equal to 65535.
If 65535 is specified, no VLAN is associated.
</td>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>description</td>
<td>Description (text string) of the switch port.
If omitted, empty string is saved.</td>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<!-- /networks/<net_id>/ports/<port_id> -->
<h3>/networks/<net_id>/ports/<port_id></h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks/<net_id>/ports/<port_id> -->
<tr>
<td rowspan="2">GET</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">-</td>
<td rowspan="2">Show details of the switch port identified by port_id and net_id.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="show_port.json">show_port.json</a></td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<!-- DELETE /networks/<net_id>/ports/<port_id> -->
<tr>
<td rowspan="4">DELETE</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">Detach the switch port identified by port_id from the network identified by net_id.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<!-- /networks/<net_id>/ports/<port_id>/mac_addresses -->
<h3>/networks/<net_id>/ports/<port_id>/mac_addresses</h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks/<net_id>/ports/<port_id>/mac_addresses -->
<tr>
<td rowspan="3">GET</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">List all the mac addresses associated with the switch port.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="show_mac_addresses.json">show_mac_addresses.json</a></td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- POST /networks/<net_id>/ports/<port_id>/mac_addresses -->
<tr>
<td rowspan="6">POST</td>
<td rowspan="6">address</td>
<td rowspan="6">MAC addresses to be associated with the switch port.
This is a mandatory parameter.</td>
<td rowspan="6">application/json</td>
<td rowspan="6"><a href="create_mac_address.json">create_mac_address.json</a></td>
<td rowspan="6">Associate a MAC address to the switch port identified by port_id and net_id.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>400 Bad request</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>422 Specified parameters are unacceptable</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<!-- /networks/<net_id>/ports/<port_id>/mac_addresses/<mac_address> -->
<h3>/networks/<net_id>/ports/<port_id>/mac_addresses/<mac_addresses></h3>
<table>
<tr>
<th rowspan="3">Method</th>
<th colspan="4" class="request">Request</th>
<th rowspan="3">Behavior</th>
<th colspan="3" class="response">Response</th>
</tr>
<tr>
<th colspan="2">Parameters</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
<th rowspan="2">Code</th>
<th rowspan="2">Content-Type</th>
<th rowspan="2">Body (example)</th>
</tr>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
<!-- GET /networks/<net_id>/ports/<port_id>/mac_addresses/<mac_address> -->
<tr>
<td rowspan="3">GET</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">-</td>
<td rowspan="3">Check existence of the MAC address.</td>
<td>200 OK</td>
<td>application/json</td>
<td><a href="show_mac_address.json">show_mac_address.json</a></td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
<!-- DELETE /networks/<net_id>/ports/<port_id>/mac_addresses/<mac_address> -->
<tr>
<td rowspan="4">DELETE</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">-</td>
<td rowspan="4">Detach the MAC address from the switch port.</td>
<td>202 Accepted</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>404 Not found</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>486 Another update is in progress</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>500 Internal error</td>
<td>-</td>
<td>-</td>
</tr>
</table>
<p class="footer">
Copyright (C) 2012-2013 NEC Corporation
</p>
</body>
</html>