VNFLifecycleManagement.yaml 99.3 KB
Newer Older
Francesca Moscatelli's avatar
Francesca Moscatelli committed
1
openapi: 3.0.2
2

3
info:
moscatelli's avatar
moscatelli committed
4
  title: SOL002 - VNF Lifecycle Management interface
5
  description: |
Giacomo Bernini's avatar
Giacomo Bernini committed
6
7
8
9
10
11
    SOL002 - VNF Lifecycle Management interface

    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
Giacomo Bernini's avatar
Giacomo Bernini committed
13

14
15
  contact:
    name: NFV-SOL WG
16
  license:
moscatelli's avatar
moscatelli committed
17
    name: ETSI Forge copyright notice
18
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Sana Zulfiqar's avatar
Sana Zulfiqar committed
19
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
20

21
externalDocs:
Sana Zulfiqar's avatar
Sana Zulfiqar committed
22
23
  description: ETSI GS NFV-SOL 002 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.05.01_60/gs_NFV-SOL002v030501p.pdf
24

25
servers:
Giacomo Bernini's avatar
Giacomo Bernini committed
26
27
  - url: http://127.0.0.1/vnflcm/v2
  - url: https://127.0.0.1/vnflcm/v2
28
29

paths:
30
31
32
33
  /api_versions:
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions

  /vnf_instances:
34
    parameters:
35
36
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
37
    get:
38
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
39
        The GET method queries information about multiple VNF instances. See clause 5.4.2.3.2.
40
      parameters:
41
42
43
44
45
46
47
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
48
      responses:
49
50
51
        "200":
          $ref: '#/components/responses/VnfInstances.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
52
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
53
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
54
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
55
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
56
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
57
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
58
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
59
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
60
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
61
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
62
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
63
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
64
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
65
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
66
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
67
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
68
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
69
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
70
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
71
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
72
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
73
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
74
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
75
76
77

    post:
      description: |
78
        The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in "ENABLED" state.
Sana Zulfiqar's avatar
Sana Zulfiqar committed
79
        See clause 5.4.2.3.1.
80
81
82
83
84
85
86
87
88
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceCreationRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfInstances.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
89
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
90
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
91
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
92
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
93
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
94
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
95
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
96
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
97
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
98
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
99
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
100
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
101
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
102
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
103
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
104
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
105
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
106
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
107
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
108
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
109
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
110
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
111
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
112
113

  /vnf_instances/{vnfInstanceId}:
114
    parameters:
115
116
117
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
118
    get:
119
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
120
        Information about a VNF instance by reading an "Individual VNF instance". See clause 5.4.3.3.2.
121
      responses:
122
123
124
        "200":
          $ref: '#/components/responses/IndividualVnfInstance.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
125
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
126
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
127
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
128
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
129
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
130
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
131
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
132
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
133
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
134
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
135
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
136
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
137
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
138
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
139
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
140
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
141
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
142
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
143
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
144
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
145
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
146
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
147
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
148

149
    delete:
150
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
151
        This method deletes an "Individual VNF instance" resource. See clause 5.4.3.3.5.
152
      responses:
153
154
155
        "204":
          $ref: '#/components/responses/IndividualVnfInstance.Delete'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
156
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
157
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
158
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
159
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
160
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
161
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
162
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
163
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
164
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
165
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
166
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
167
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
168
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
169
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
170
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
171
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
172
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
173
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
174
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
175
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
176
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
177
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
178
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
179
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
180
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
181
182
183

    patch:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
184
        This method modifies an "Individual VNF instance" resource. See clause 5.4.3.3.4.
185
186
187
188
189
190
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceModificationRequest'
      responses:
        "202":
          $ref: '#/components/responses/IndividualVnfInstance.Patch'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
191
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
192
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
193
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
194
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
195
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
196
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
197
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
198
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
199
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
200
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
201
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
202
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
203
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
204
        "412":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
205
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
206
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
207
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
208
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
209
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
210
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
211
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
212
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
213
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
214
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
215
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
216
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
217
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
218
219

  /vnf_instances/{vnfInstanceId}/instantiate:
220
    parameters:
221
222
223
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
224
    post:
225
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
226
        The POST method instantiates a VNF instance. See clause 5.4.4.3.1.
227
228
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceInstantiationRequest'
229
      responses:
230
231
232
        "202":
          $ref: '#/components/responses/InstantiateVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
233
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
234
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
235
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
236
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
237
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
238
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
239
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
240
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
241
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
242
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
243
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
244
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
245
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
246
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
247
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
248
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
249
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
250
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
251
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
252
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
253
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
254
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
255
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
256
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
257
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
258
259

  /vnf_instances/{vnfInstanceId}/scale:
260
    parameters:
261
262
263
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
264
    post:
265
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
266
        The POST method requests to scale a VNF instance resource incrementally. See clause 5.4.5.3.1.
267
268
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceScaleRequest'
269
      responses:
270
271
272
        "202":
          $ref: '#/components/responses/ScaleVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
273
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
274
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
275
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
276
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
277
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
278
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
279
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
280
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
281
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
282
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
283
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
284
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
285
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
286
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
287
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
288
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
289
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
290
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
291
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
292
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
293
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
294
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
295
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
296
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
297
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
298
299

  /vnf_instances/{vnfInstanceId}/scale_to_level:
300
    parameters:
301
302
303
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
304
    post:
305
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
306
        The POST method requests to scale a VNF instance resource to a target level. See clause 5.4.6.3.1.
307
308
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceScaleToLevelRequest'
309
      responses:
310
311
312
        "202":
          $ref: '#/components/responses/ScaleVnfInstanceToLevel.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
313
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
314
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
315
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
316
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
317
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
318
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
319
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
320
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
321
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
322
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
323
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
324
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
325
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
326
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
327
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
328
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
329
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
330
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
331
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
332
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
333
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
334
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
335
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
336
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
337
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
338
339

  /vnf_instances/{vnfInstanceId}/change_flavour:
340
    parameters:
341
342
343
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
344
    post:
345
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
346
        The POST method changes the deployment flavour of a VNF instance. See clause 5.4.7.3.1.
347
348
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceChangeFlavourRequest'
349
      responses:
350
351
352
        "202":
          $ref: '#/components/responses/VnfInstanceChangeFlavour.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
353
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
354
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
355
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
356
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
357
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
358
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
359
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
360
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
361
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
362
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
363
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
364
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
365
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
366
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
367
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
368
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
369
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
370
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
371
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
372
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
373
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
374
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
375
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
376
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
377
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
378
379

  /vnf_instances/{vnfInstanceId}/terminate:
380
    parameters:
381
382
383
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
384
    post:
385
      description: |
386
        The POST method triggers the VNFM to terminate a VNF  instance and to request to the VIM the release of its
Sana Zulfiqar's avatar
Sana Zulfiqar committed
387
        used virtualised resources. See clause 5.4.8.3.1.
388
389
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceTerminationRequest'
390
      responses:
391
392
393
        "202":
          $ref: '#/components/responses/TerminateVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
394
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
395
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
396
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
397
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
398
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
399
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
400
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
401
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
402
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
403
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
404
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
405
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
407
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
408
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
409
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
410
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
411
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
412
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
413
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
414
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
415
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
416
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
417
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
418
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
419
420

  /vnf_instances/{vnfInstanceId}/heal:
421
    parameters:
422
423
424
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
425
    post:
426
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
427
        The POST method requests to heal a VNF instance. See clause 5.4.9.3.1.
428
429
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceHealRequest'
430
      responses:
431
432
433
        "202":
          $ref: '#/components/responses/HealVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
434
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
435
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
436
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
437
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
438
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
439
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
440
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
441
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
442
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
443
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
444
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
445
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
446
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
447
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
448
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
449
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
450
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
451
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
452
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
453
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
454
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
455
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
456
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
457
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
458
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
459
460

  /vnf_instances/{vnfInstanceId}/operate:
461
    parameters:
462
463
464
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
465
    post:
466
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
467
        The POST method changes the operational state of a VNF instance. See clause 5.4.10.3.1.
468
469
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceOperateRequest'
470
      responses:
471
472
473
        "202":
          $ref: '#/components/responses/OperateVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
474
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
475
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
476
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
477
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
478
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
479
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
480
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
481
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
482
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
483
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
484
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
485
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
486
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
487
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
488
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
489
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
490
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
491
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
492
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
493
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
494
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
495
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
496
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
497
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
498
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
499
500

  /vnf_instances/{vnfInstanceId}/change_ext_conn:
501
    parameters:
502
503
504
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
505
    post:
506
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
507
        The POST method changes the external connectivity of a VNF instance. See clause 5.4.11.3.1.
508
509
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceChangeExtConnRequest'
510
      responses:
511
512
513
        "202":
          $ref: '#/components/responses/VnfInstanceChangeExtConn.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
514
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
515
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
516
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
517
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
518
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
519
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
520
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
521
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
522
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
523
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
524
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
525
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
526
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
527
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
528
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
529
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
530
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
531
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
532
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
533
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
534
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
535
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
536
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
537
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
538
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
539

540
541
542
543
544
  /vnf_instances/{vnfInstanceId}/change_vnfpkg:
    parameters:
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
545
546
547
    post:
      description: |
        The POST method changes the current VNF package on which the VNF instance is based.
Sana Zulfiqar's avatar
Sana Zulfiqar committed
548
        See clause 5.4.11a.3.1.
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
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceChangeVnfPkgRequest'
      responses:
        "202":
          $ref: '#/components/responses/VnfInstanceChangeVnfPkg.Post'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "404":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "409":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
        "504":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
580

581
  /vnf_lcm_op_occs:
582
    parameters:
583
584
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
585
    get:
586
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
587
588
        The client can use this method to query status information about multiple VNF lifecycle
        management operation occurrences. See clause 5.4.12.3.2.
589
      parameters:
590
591
592
593
594
595
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
596
      responses:
597
598
599
        "200":
          $ref: '#/components/responses/VnfLcmOpOccs.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
600
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
601
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
602
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
603
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
604
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
605
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
606
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
607
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
608
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
609
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
610
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
611
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
612
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
613
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
614
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
615
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
616
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
617
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
618
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
619
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
620
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
621
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
622
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
623
624

  /vnf_lcm_op_occs/{vnfLcmOpOccId}:
625
    parameters:
626
627
628
      - $ref: '#/components/parameters/VnfLcmOpOccId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
629
    get:
630
631
      description: |
        The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence
Sana Zulfiqar's avatar
Sana Zulfiqar committed
632
        by reading an "Individual VNF LCM operation occurrence" resource. See clause 5.4.13.3.2.
633
      responses:
634
635
636
        "200":
          $ref: '#/components/responses/IndividualVnfLcmOpOcc.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
637
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
638
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
639
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401