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
|
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=======================
Port Pairs (port-pairs)
=======================
Lists, shows information for, creates, updates and deletes port pairs.
List Port Pairs
===============
.. rest_method:: GET /v1.0/sfc/port_pairs
Lists port pairs.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- id: port_pair_id
- name: port_pair_name
- description: description
- port_pair_groups: port_pair_groups
- flow_classifiers: flow_classifiers
Response Example
----------------
**Example List port pairs: JSON response**
.. literalinclude:: samples/sfc-port-pairs/port-pair-list-resp.json
:language: javascript
Create Port Pair
================
.. rest_method:: POST /v1.0/sfc/port_pairs
Creates a port pair.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- name: port_pair_name
- description: description
- ingress: ingress_port_id
- egress: egress_port_id
- service_function_parameters: service_function_parameters
Request Example
---------------
**Example Create port pair: JSON request**
.. literalinclude:: samples/sfc-port-pairs/port-pair-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: port_pair_id
- name: port_pair_name
- description: description
- ingress: ingress_port_id
- egress: egress_port_id
- service_function_parameters: service_function_parameters
Response Example
----------------
**Example Create port pair: JSON response**
.. literalinclude:: samples/sfc-port-pairs/port-pair-create-resp.json
:language: javascript
Show Port Pair Details
======================
.. rest_method:: GET /v1.0/sfc/port_pairs/{port_pair_id}
Shows details for a port pair.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- port_pair_id: port_pair_id-path
Response
--------
.. rest_parameters:: parameters.yaml
- id: port_pair_id
- name: port_pair_name
- description: description
- ingress: ingress_port_id
- egress: egress_port_id
- service_function_parameters: service_function_parameters
Response Example
----------------
**Example Show port pair: JSON response**
.. literalinclude:: samples/sfc-port-pairs/port-pair-get-resp.json
:language: javascript
Update Port Pair
================
.. rest_method:: PUT /v1.0/sfc/port_pairs/{port_pair_id}
Updates a port pair.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- port_pair_id: port_pair_id-path
- name: port_pair_name
- description: description
Request Example
---------------
**Example Update port pair: JSON request**
.. literalinclude:: samples/sfc-port-pairs/port-pair-update-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: port_pair_id
- name: port_pair_name
- description: description
- ingress: ingress_port_id
- egress: egress_port_id
- service_function_parameters: service_function_parameters
Response Example
----------------
**Example Update port pair: JSON response**
.. literalinclude:: samples/sfc-port-pairs/port-pair-update-resp.json
:language: javascript
Delete Port Pair
================
.. rest_method:: DELETE /v1.0/sfc/port-pairs/{port_pair_id}
Deletes a port pair.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- port_pair_id: port_pair_id-path
Response
--------
There is no body content for the response of a successful Delete request.
|
