Newer
Older
openapi: 3.0.2
info:
title: SOL002 - VNF LCM Coordination interface
description: |
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.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
description: ETSI GS NFV-SOL 002 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf
servers:
- url: http://127.0.0.1/lcmcoord/v1
- url: https://127.0.0.1/lcmcoord/v1
paths:
/api_versions:
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
/coordinations:
parameters:
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
post:
description: |
This POST method requests the coordination of an LCM operation occurrence with
a management operation executed in the API producer. See clause 10.4.2.3.1.
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/LcmCoordRequest'
responses:
"201":
$ref: '#/components/responses/Coordination.Post.201'
$ref: '#/components/responses/Coordination_async.Post.202'
"403":
$ref: '#/components/responses/Coordination.Post.403'
"409":
$ref: '#/components/responses/Coordination.Post.409'
"503":
$ref: '#/components/responses/Coordination.Post.503'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
"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
"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
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
/coordinations/{coordinationId}:
parameters:
- $ref: '#/components/parameters/coordinationId'
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
The GET method reads a coordination result. See clause 10.4.3.3.2.
$ref: '#/components/responses/LcmCoord.Get.200'
"202":
$ref: '#/components/responses/LcmCoord.Get.202'
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
"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
"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
/coordinations/{coordinationId}/cancel:
parameters:
- $ref: '#/components/parameters/coordinationId'
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization
post:
description: |
The POST method initiates the cancellation of an ongoing coordination action.
$ref: '#/components/responses/CoordinationCancel.Post.202'
"409":
$ref: '#/components/responses/CoordinationCancel.Post.409'
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
"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
"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
components:
parameters:
coordinationId:
name: coordinationId
in: path
description: |
Identifier of the LCM coordination. This identifier can be retrieved from the
resource referenced by the "Location" HTTP header in the response to a
POST request to the "Coordinations" resource
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
LcmCoordRequest:
description: |
Parameters for the coordination action as defined in clause 10.5.2.2.
content:
application/json:
schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoordRequest
required: true
responses:
Shall be returned returned to indicate a finished coordination action when the API producer has
chosen the synchronous mode, which may be selected for coordination actions that finish within the time
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
frame in which an HTTP response is expected.
The response body shall contain an LcmCoord data structure that represents
the result of the coordination action.
The HTTP response shall include a "Location" HTTP header that indicates the URI
of the "Individual coordination action" resource that has been created as the
result of the finished coordination procedure.
headers:
Version:
description: |
The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
URI of the "Individual coordination action" resource
style: simple
explode: false
schema:
type: string
format: url
content:
application/json:
schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoord
Shall be returned when the API producer has chosen the asynchronous mode and the
request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that indicates the URI of
the "Individual coordination action" resource that will be created once the
coordination operation has finished successfully.
Further, the HTTP response may include a "Retry-After" HTTP header that indicates the
time to wait before sending the next GET request to the "individual coordination" resource
indicated in the "Location" header. If the header is provided, the VNFM shall record the signalled
delay value in the "delay" attribute of the applicable entry in the "lcmCoordinations" array in the
"VnfLcmOpOcc" structure.
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
headers:
Version:
description: |
The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
Used in redirection, or when a new resource has been created. This header field shall be present if the
response status code is 201 or 3xx. In the present document this header field is also used if the response
status code is 202 and a new resource was created.
style: simple
explode: false
schema:
type: string
format: url
content: {}
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
Coordination.Post.403:
description: >
403 FORBIDDEN
Shall be returned upon the following error: The starting of the coordination operation has been
rejected.
No "individual coordination action" resource shall be created.
A ProblemDetails structure shall be included in the response to provide more details about the rejection
in the "details" attribute.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Coordination.Post.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a
conflict with the state of the "Coordinations" resource.
Typically, this is due to the fact that no more coordination actions can be executed currently e.g.
because too many of them, or conflicting ones, are in progress.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute should
convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Coordination.Post.503:
description: >
503 SERVICE UNAVAILABLE
Shall be returned upon the following error: The API producer has chosen the synchronous mode and
cannot perform the requested coordination currently, but expects to be able to perform it sometime
in the future.
No "individual coordination action" resource shall be created.
A ProblemDetails structure shall be included in the response to provide more details about the
rejection in the "details" attribute.
The HTTP response shall include a "Retry-After" HTTP header that indicates the delay after
which it is suggested to repeat the coordination request with the same set of parameters. The VNFM
shall record the signalled delay value in the "delay" attribute of the applicable entry in the
"rejectedLcmCoordinations" array in the "VnfLcmOpOcc" structure.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Shall be returned when the coordination is finished and the coordination result has been read successfully.
A representation of the "Individual coordination action" resource shall be returned in the response body.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoord
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
LcmCoord.Get.202:
description: |
202 ACCEPTED
Shall be returned when the management operation with which coordination is requested is still ongoing or
in the process of being cancelled, i.e. no coordination result is available yet.
The response shall be empty.
headers:
Version:
description: |
The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
Used in redirection, or when a new resource has been created. This header field shall be present if the
response status code is 201 or 3xx. In the present document this header field is also used if the response
status code is 202 and a new resource was created.
style: simple
explode: false
schema:
type: string
format: url
content: {}
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
Shall be returned when the cancellation request has been accepted for processing.
The response shall have an empty payload body.
headers:
Version:
description: |
The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
Used in redirection, or when a new resource has been created. This header field shall be present if the
response status code is 201 or 3xx. In the present document this header field is also used if the response
status code is 202 and a new resource was created.
style: simple
explode: false
schema:
type: string
format: url
content: {}
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
CoordinationCancel.Post.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a
conflict with the state of the "Individual coordination action" resource.
Typically, this is due to the fact that the coordination action has finished processing.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute
shall convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
schema:
type: string
maximum: 1
minimum: 1
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"