Newer
Older
swagger: "2.0"
info:
title: "SOL005 - NS 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. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
- https
consumes:
moscatelli
committed
###############################################################################
Samir Medjiah
committed
# API Versions #
###############################################################################
'/api-versions':
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
Samir Medjiah
committed
###############################################################################
moscatelli
committed
# NSInstances #
###############################################################################
'/ns_instances':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
Samir Medjiah
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
summary: Create a NS instance resource.
description: >
The POST method creates a new NS instance resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
description: >
The NS creation parameters, as defined in clause 6.5.2.7.
moscatelli
committed
responses:
moscatelli
committed
A NS Instance identifier has been created
successfully.
The response body shall contain a representation of
the created NS instance, as defined in clause 6.5.2.8.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the created
NS instance.
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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.
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
rameshnaraya
committed
Query NS Instances.
moscatelli
committed
The GET method queries information about multiple NS instances.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
Samir Medjiah
committed
- name: filter
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
Samir Medjiah
committed
The NFVO shall support receiving this parameter as part of the URI
query string. The OSS/BSS may supply this parameter.
All attribute names that appear in the NsInstance and in data types
Samir Medjiah
committed
referenced from it shall be supported by the NFVO in the filter expression.
- name: all_fields
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
Samir Medjiah
committed
The NFVO shall support this parameter.
- name: fields
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
"Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
details. The NFVO should support this parameter."
Samir Medjiah
committed
- name: exclude_fields
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
"Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
details. The NFVO should support this parameter."
Samir Medjiah
committed
- name: exclude_default
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
"Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the NsInstance structure in
the response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
- vnfInstances
- pnfInfo
- virtualLinkInfo
- vnffgInfo
- sapInfo
- nsScaleStatus
- additionalAffinityOrAntiAffinityRules"
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
description: >
moscatelli
committed
Information about zero or more NS instances has
been queried successfully.
The response body shall contain in an array the
representations of zero or more NS instances, as
defined in clause 6.5.2.8.
If the NFVO supports alternative 2 (paging)
according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response
shall follow the provisions in clause 5.4.2.3 of ETSI
GS NFV-SOL 013.
headers:
Content-Type:
description: The MIME type of the body of the response.
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.
maximum: 1
moscatelli
committed
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
moscatelli
committed
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual NS instance #
###############################################################################
'/ns_instances/{nsInstanceId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.3
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance.
in: path
type: string
required: true
Samir Medjiah
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
description: >
The GET method retrieves information about a NS instance by
reading an individual NS instance resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
moscatelli
committed
Information about an individual NS instance has been queried successfully.
The response body shall contain a representation of the NS instance.
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
headers:
Content-Type:
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
moscatelli
committed
minimum: 1
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.
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
Delete NS Identifier
moscatelli
committed
This method deletes an individual NS instance resource.
responses:
204:
description: >
204 No Content
moscatelli
committed
The NS instance resource and the associated NS
identifier were deleted successfully.
The response body shall be empty.
headers:
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.
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in INSTANTIATED state.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/412"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Instantiate NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/instantiate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.4
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be instantiated.
in: path
type: string
required: true
moscatelli
committed
post:
description: >
The POST method requests to instantiate a NS instance resource.
parameters:
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
description: >
Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
description: >
202 ACCEPTED
The request has been accepted for processing, but
the processing has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP
header that contains the URI of the newly-created
"NS LCM operation occurrence" resource
corresponding to the operation.
$ref: "../responses/SOL005_resp.yaml#/responses/202"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in the INSTANTIATED state, or that
another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Scale NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/scale':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.5
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be scaled.
in: path
type: string
required: true
moscatelli
committed
post:
description: >
The POST method requests to scale a NS instance resource.
moscatelli
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
description: >
Parameters for the scale NS operation, as defined in clause 6.5.2.13.
description: >
202 ACCEPTED
The request has been accepted for processing, but
the processing has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP
header that contains the URI of the newly-created
"NS lifecycle operation occurrence" resource
corresponding to the operation.
$ref: "../responses/SOL005_resp.yaml#/responses/202"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in NOT_INSTANTIATED state, or that
another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Update NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/update':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.6
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be updated.
in: path
type: string
required: true
moscatelli
committed
post:
description: >
Scale NS instance.
The POST method requests to scale a NS instance resource.
moscatelli
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
description: >
Parameters for the update NS operation, as defined in clause 6.5.2.11.
description: >
202 ACCEPTED
The request has been accepted for processing, but
the processing has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP
header that contains the URI of the newly-created
"NS lifecycle operation occurrence" resource
corresponding to the operation.
$ref: "../responses/SOL005_resp.yaml#/responses/202"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in NOT_INSTANTIATED state, or that
another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Heal NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/heal':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be healed.
in: path
type: string
required: true
post:
moscatelli
committed
summary: Heal a NS instance.
description: >
The POST method requests to heal a NS instance resource.
This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and
6.4.7.3.1-2 for URI query parameters,
request and response data structures, and response codes.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
Samir Medjiah
committed
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
description: >
Parameters for the heal NS operation, as defined in clause 6.5.2.12.
description: >
202 ACCEPTED
The request has been accepted for processing, but
the processing has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP
header that contains the URI of the newly-created
"NS lifecycle operation occurrence" resource
corresponding to the operation.
$ref: "../responses/SOL005_resp.yaml#/responses/202"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in NOT_INSTANTIATED state, or that
another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Terminate NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/terminate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
parameters:
- name: nsInstanceId
description: >
The identifier of the NS instance to be terminated.
in: path
type: string
required: true
post:
summary: Terminate a NS instance.
description: >
Terminate NS task.
The POST method terminates a NS instance. This method can only be
used with a NS instance in the INSTANTIATED
state. Terminating a NS instance does not delete the NS instance identifier,
but rather transitions the NS into the NOT_INSTANTIATED state.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
Samir Medjiah
committed
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
description: >
The terminate NS request parameters, as defined in clause 6.5.2.14.
description: >
202 ACCEPTED
Shall be returned when the request has been
accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP
header that contains the URI of the newly-created
"NS lifecycle operation occurrence" resource
corresponding to the operation.
$ref: "../responses/SOL005_resp.yaml#/responses/202"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
409 CONFLICT
Error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to the fact that the NS instance
resource is in NOT_INSTANTIATED state, or that
another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
$ref: "../responses/SOL005_resp.yaml#/responses/409"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# NS LCM operation occurrences #
###############################################################################
'/ns_lcm_op_occs':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
get:
summary: Query multiple NS LCM operation occurrences.
rameshnaraya
committed
Get Operation Status.
The client can use this method to query status information about multiple NS lifecycle management operation
occurrences.
This method shall follow the provisions specified in the Tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
Samir Medjiah
committed
- name: filter
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
Samir Medjiah
committed
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the NsLcmOpOcc and in data types referenced
Samir Medjiah
committed
from it shall be supported by the NFVO in the filter expression.
Samir Medjiah
committed
- name: fields
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The
NFVO should support this parameter.
Samir Medjiah
committed
- name: exclude_fields
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details.
The NFVO should support this parameter.
Samir Medjiah
committed
- name: exclude_default
in: query
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Indicates to exclude the following complex attributes from the response. See
clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the NsLcmOpOcc structure in the
response body if this parameter is provided:
- operationParams
- changedVnfInfo
- error
- resourceChanges
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV SOL 013 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
rameshnaraya
committed
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235