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
6
7
  description: |
    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 and has not been approved by the ETSI NFV ISG.
8
9
    In case of discrepancies the published ETSI Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
10
11
  contact:
    name: NFV-SOL WG
12
  license:
moscatelli's avatar
moscatelli committed
13
    name: ETSI Forge copyright notice
14
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
15
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
16

17
externalDocs:
Sana Zulfiqar's avatar
Sana Zulfiqar committed
18
19
  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
20

21
servers:
Giacomo Bernini's avatar
Giacomo Bernini committed
22
23
  - url: http://127.0.0.1/vnflcm/v2
  - url: https://127.0.0.1/vnflcm/v2
24
25

paths:
26
27
28
29
  /api_versions:
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions

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

    post:
      description: |
74
        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
75
        See clause 5.4.2.3.1.
76
77
78
79
80
81
82
83
84
      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
85
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
86
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
87
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
88
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
89
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
90
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
91
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
92
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
93
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
94
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
95
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
96
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
97
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
98
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
99
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
100
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
101
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
102
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
103
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
104
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
105
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
106
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
107
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
108
109

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

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

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

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

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

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

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

  /vnf_instances/{vnfInstanceId}/terminate:
376
    parameters:
377
378
379
      - $ref: '#/components/parameters/VnfInstanceId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
380
    post:
381
      description: |
382
        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
383
        used virtualised resources. See clause 5.4.8.3.1.
384
385
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceTerminationRequest'
386
      responses:
387
388
389
        "202":
          $ref: '#/components/responses/TerminateVnfInstance.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
390
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
391
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
392
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
393
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
394
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
395
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
396
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
397
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
398
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
399
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
400
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
401
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
402
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
403
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
404
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
405
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
407
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
408
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
409
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
410
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
411
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
412
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
413
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
414
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
415
416

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

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

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

536
537
538
539
540
  /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
541
542
543
    post:
      description: |
        The POST method changes the current VNF package on which the VNF instance is based.
Sana Zulfiqar's avatar
Sana Zulfiqar committed
544
        See clause 5.4.11a.3.1.
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
      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
576

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

  /vnf_lcm_op_occs/{vnfLcmOpOccId}:
621
    parameters:
622
623
624
      - $ref: '#/components/parameters/VnfLcmOpOccId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
625
    get:
626
627
      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
628
        by reading an "Individual VNF LCM operation occurrence" resource. See clause 5.4.13.3.2.
629
      responses:
630
631
632
        "200":
          $ref: '#/components/responses/IndividualVnfLcmOpOcc.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
633
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
634
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
635
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
636
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
637
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403