Newer
Older
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
in: header
required: false
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
responses:
200:
description: >
moscatelli
committed
Shall be returned when status information for zero or
more NS lifecycle management operation occurrences
has been queried successfully.
The response body shall contain in an array the status
information about zero or more NS lifecycle operation
occurrences, as defined in clause 6.5.2.3.
If the "filter" URI parameter or one of the "all_fields",
"fields", "exclude_fields" or "exclude_default" URI
parameters was supplied in the request and is
supported, the data in the response body shall have
been transformed according to the rules specified in
clauses 5.2.2 and 5.3.2 of ETSI
GS NFV-SOL 013 [16], respectively.
If the NFVO supports alternative 2 (paging) according
to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] 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 [16].
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:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
$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/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual NS lifecycle operation occurrence #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.10
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence.
in: path
type: string
required: true
moscatelli
committed
get:
summary: Read an individual NS LCM operation occurrence resource.
The API consumer can use this method to retrieve status information about
moscatelli
committed
a NS lifecycle management operation occurrence by
reading an individual "NS LCM operation occurrence" resource.
This method shall follow the provisions specified in the
Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters,
request and response data structures, and response codes.
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
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
Shall be returned when information about an NS
LCM operation occurrence has been read
successfully.
The response body shall contain status information
about an NS lifecycle management operation
occurrence (see clause 6.5.2.3).
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers:
Content-Type:
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
rameshnaraya
committed
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.
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
$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
###############################################################################
# Retry operation task #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/retry':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.11
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be retried.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
type: string
required: true
post:
summary: Retry a NS lifecycle management operation occurrence.
description: >
The POST method initiates retrying a NS lifecycle management operation
if that operation has experienced a temporary
failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
description: >
202 ACCEPTED
Shall be returned when the request has been
accepted for processing, but processing has not been
completed.
The response shall have an empty payload body.
$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"
description: >
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
including rules for the presence of the response body.
Specifically in case of this task resource, the response
code 404 shall also be returned if the task is not
supported for the NS LCM operation occurrence
represented by the parent resource, which means that
the task resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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 NS LCM operation
occurrence resource.
Typically, this is due to the fact that the NS LCM
operation occurrence is not in FAILED_TEMP state, or
another error handling action is starting, such as
rollback or fail.
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
###############################################################################
# Rollback a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/rollback':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.12
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be rolled back.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Rollback a NS lifecycle management operation occurrence.
description: >
The POST method initiates rolling back a NS lifecycle operation
if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
description: >
Shall be returned when the request has been
accepted for processing, but processing has not
been completed.
The response shall have an empty payload body.
$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"
description: >
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [16], including rules for the
presence of the response body.
Specifically, in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the NS LCM operation
occurrence represented by the parent resource,
which means that the task resource consequently
does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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 NS LCM operation
occurrence resource.
Typically, this is due to the fact that the NS LCM
operation occurrence is not in FAILED_TEMP state,
or another error handling action is starting, such as
retry or fail.
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
###############################################################################
# Continue a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/continue':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.13
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be continued.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering an NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
moscatelli
committed
post:
summary: Continue a NS lifecycle management operation occurrence.
description: >
The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
description: >
202 ACCEPTED
Shall be returned when the request has been
accepted for processing, but processing has not
been completed.
The response shall have an empty payload body.
$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"
description: >
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [16], including rules for the
presence of the response body.
Specifically, in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the NS LCM operation
occurrence represented by the parent resource,
which means that the task resource consequently
does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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 NS LCM operation
occurrence resource.
Typically, this is due to the fact that the NS LCM
operation occurrence is not in FAILED_TEMP state,
or another error handling action is starting, such as
retry or fail.
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
###############################################################################
# Fail operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.14
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
moscatelli
committed
This identifier can be retrieved from the resource referenced by
he "Location" HTTP header in the response
to a POST request triggering a NS LCM operation.
It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Mark a NS lifecycle management operation occurrence as failed.
description: >
The POST method marks a NS lifecycle management operation
occurrence as "finally failed" if that operation
occurrence is in "FAILED_TEMP" state.
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
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
Shall be returned when the state of the NS lifecycle
management operation occurrence has been changed
successfully.
The response shall include a representation of the
"Individual NS lifecycle management operation occurrence" resource.
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
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.
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
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
description: >
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
including rules for the presence of the response body.
Specifically in case of this task resource, the response
code 404 shall also be returned if the task is not
supported for the NS LCM operation occurrence
represented by the parent resource, which means that
the task resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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 NS LCM operation
occurrence resource.
Typically, this is due to the fact that the NS LCM
operation occurrence is not in FAILED_TEMP state, or
another error handling action is starting, such as retry
or rollback.
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
###############################################################################
# Cancel operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.15
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be canceled.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Cancel a NS lifecycle management operation occurrence.
The POST method initiates cancelling an ongoing NS lifecycle management operation while it is being executed or
rolled back, i.e. the related "NS LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
This method shall follow the provisions specified in the Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters,
request and response data structures, and response codes.
Before returning the "202 Accepted" response, the NFVO shall update the "isCancelPending" and "cancelMode"
attributes in the representation of the parent resource according to the provisions in clause 6.5.2.3.
In case of success of processing the asynchronous request:
1) If the request has been processed in "PROCESSING" or "ROLLING_BACK" state, the "operationState"
attribute in the representation of the parent resource shall be changed to "FAILED_TEMP".
In both cases, the NFVO shall update the "isCancelPending" and "cancelMode" attributes in the representation of the
parent resource according to the provisions in clause 6.5.2.3 to reflect the new status, and the applicable "result"
notification according to clause 6.6.2.2 shall be emitted to indicate that the execution of the underlying NS LCM
operation occurrence has temporarily failed.
Due to race conditions, the processing of the actual operation that is to be cancelled may eventually still succeed, in
which case the "operationState" attribute in the representation of the parent resource shall represent the result of that
operation, rather than the result of the cancellation.
moscatelli
committed
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
- 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/CancelMode"
description: >
The POST request to this resource shall include a CancelMode
structure in the payload body to choose between "graceful" and
"forceful" cancellation.
description: >
202 ACCEPTED
Shall be returned when the request has been
accepted for processing, but processing has not been
completed.
The response shall have an empty entity body.
$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"
description: >
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
including rules for the presence of the response body.
Specifically, in case of this task resource, the
response code 404 shall also be returned if the task is
not supported for the NS LCM operation occurrence
represented by the parent resource, which means that
the task resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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 NS LCM operation
occurrence resource.
Typically, this is due to the fact that the operation
occurrence is not in STARTING, PROCESSING or
ROLLING_BACK 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/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.16
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
moscatelli
committed
post:
summary: Subscribe to NS lifecycle change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.16.3.1-1 and 6.4.16.3.1-2.
Creation of two subscription resources with the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
the existing subscription resource with the same filter and callbackUri).
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: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
moscatelli
committed
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 6.5.2.2.
moscatelli
committed
Shall be returned when the subscription has been
created successfully.
The response body shall contain a representation
of the created "Individual subscription" resource.
The HTTP response shall include a "Location:"
HTTP header that points to the created
"Individual subscription" resource.
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
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
description: >
303 SEE OTHER
Shall be returned if a subscription with the same
callback URI and the same filter already exits and
the policy of the NFVO is to not create redundant
subscriptions.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of
the existing "Individual subscription" resource.
The response body shall be empty.
$ref: "../responses/SOL005_resp.yaml#/responses/303"
$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"
422:
$ref: "../responses/SOL005_resp.yaml#/responses/422"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
get:
rameshnaraya
committed
Query Subscription Information.
The GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations.
parameters:
Samir Medjiah
committed
- name: filter
in: query
required: false
type: string
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 LccnSubscription and in data types
referenced from it shall be supported by the NFVO in the filter expression.
- 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:
moscatelli
committed
Shall be returned when the list of subscriptions has
been queried successfully.
The response body shall contain in an array the
representations of all active subscriptions of the
functional block that invokes the method, i.e. zero or
more representations of lifecycle change notification
subscriptions as defined in clause 6.5.2.4.
If the "filter" URI parameter was supplied in the
request, the data in the response body shall have
been transformed according to the rules specified in
clause 5.2.2 of ETSI GS NFV-SOL 013 [16].
If the NFVO supports alternative 2 (paging) according
to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] 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 [16].
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.
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.