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
|
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=============================
Service Graph (service_graph)
=============================
Lists, shows information for, creates, updates and deletes Service Graphs.
List Service Graphs
===================
.. rest_method:: GET /v1.0/sfc/service_graphs
Lists service graphs.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- id: sfc_service_graph_id
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
Response Example
----------------
**Example List service graphs: JSON response**
.. literalinclude:: samples/sfc-service-graphs/service-graph-list-resp.json
:language: javascript
Create Service Graph
====================
.. rest_method:: POST /v1.0/sfc/service_graphs
Creates a service graph.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
**Example Create service graph: JSON request**
.. literalinclude:: samples/sfc-service-graphs/service-graph-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: sfc_service_graph_id
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
Response Example
----------------
**Example Create service graph: JSON response**
.. literalinclude:: samples/sfc-service-graphs/service-graph-create-resp.json
:language: javascript
Show Service Graph Details
==========================
.. rest_method:: GET /v1.0/sfc/service_graphs/{sfc_service_graph_id-path}
Shows details for a service graph.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- service_graph_id: sfc_service_graph_id-path
Response
--------
.. rest_parameters:: parameters.yaml
- id: sfc_service_graph_id
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
Response Example
----------------
**Example Show service graph: JSON response**
.. literalinclude:: samples/sfc-service-graphs/service-graph-get-resp.json
:language: javascript
Update Service Graph
====================
.. rest_method:: PUT /v1.0/sfc/service_graphs/{sfc_service_graph_id-path}
Updates a service graph.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- service_graph_id: sfc_service_graph_id-path
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
Request Example
---------------
**Example Update service graph: JSON request**
.. literalinclude:: samples/sfc-service-graphs/service-graph-update-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: sfc_service_graph_id
- name: sfc_service_graph_name
- description: description
- port_chains: port_chains
Response Example
----------------
**Example Update service graph: JSON response**
.. literalinclude:: samples/sfc-service-graphs/service-graph-update-resp.json
:language: javascript
Delete Service Graph
====================
.. rest_method:: DELETE /v1.0/sfc/service_graphs/{sfc_service_graph_id-path}
Deletes a service graph.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- service_graph_id: sfc_service_graph_id-path
Response
--------
There is no body content for the response of a successful Delete request.
|