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
|
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
===================================
Flow Classifiers (flow-classifiers)
===================================
Lists, shows information for, creates, updates and deletes flow classifiers.
List Flow Classifiers
=====================
.. rest_method:: GET /v1.0/sfc/flow_classifiers
Lists flow classifiers.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
Response Example
----------------
**Example List flow classifiers: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-list-resp.json
:language: javascript
Create Flow Classifier
======================
.. rest_method:: POST /v1.0/sfc/flow_classifiers
Creates a flow classifier.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Request Example
---------------
**Example Create flow classifier: JSON request**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Create flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-create-resp.json
:language: javascript
Show Flow Classifier Details
============================
.. rest_method:: GET /v1.0/sfc/flow_classifiers/{flow_classifier_id}
Shows details for a flow classifier.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
Response
--------
.. rest_parameters:: parameters.yaml
- id: flow_classifier_id
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Show flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-get-resp.json
:language: javascript
Update Flow Classifier
======================
.. rest_method:: PUT /v1.0/sfc/flow_classifiers/{flow_classifier_id}
Updates a flow classifier.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
Request Example
---------------
**Example Update flow classifier: JSON request**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-update-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: flow_classifier_id
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Update flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-update-resp.json
:language: javascript
Delete Flow Classifier
======================
.. rest_method:: DELETE /v1.0/sfc/flow-classifiers/{flow_classifier_id}
Deletes a flow classifier.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
Response
--------
There is no body content for the response of a successful Delete request.
|