--- swagger: "2.0" info: description: | 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 version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL005 - NS Lifecycle Management Interface termsOfService: https://www.vmware.com/content/dam/digitalmarketing/vmware/en/pdf/product/vmware-product-guide.pdf license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt basePath: /telco/api/nslcm/v2 schemes: - http - https consumes: - application/json produces: - application/json paths: /ns_instances: get: summary: Query multiple NS instances. description: | Query NS Instances. 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. operationId: getNsInstances parameters: - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: filter in: query description: | Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. 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 referenced from it shall be supported by the NFVO in the filter expression. required: false type: string - name: all_fields in: query description: | Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. required: false type: string - name: fields in: query 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.\" \n" required: false type: string - name: exclude_fields in: query 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." required: false type: string - name: exclude_default in: query 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" required: false type: string - 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 in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string responses: "200": description: | 200 OK Shall be returned when 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 "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request, 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]. examples: application/json: flavourId: {} href: http://example.com/aeiou headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. Link: type: string description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. schema: type: array items: $ref: '#/definitions/inline_response_200' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "416": description: | 416 RANGE NOT SATISFIABLE headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' post: summary: Create a NS instance resource. description: | The POST method creates a new NS instance resource. As the result of successfully executing this method, a new "Individual NS instance" resource as defined in clause 6.4.3 shall have been created, and the value of the "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification of type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 6.5.2.6. operationId: createNs parameters: - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - in: body name: body description: | The NS creation parameters, as defined in clause 6.5.2.7. required: true schema: $ref: '#/definitions/CreateNsRequest' responses: "201": description: | 201 Created Shall be returned when a new "Individual NS instance" resource and the associated 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.10. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NS instance. headers: Content-Type: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/NsInstance' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "416": description: | 416 RANGE NOT SATISFIABLE headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}: get: summary: Read an individual NS instance resource. description: | The GET method retrieves information about a NS instance by reading an individual NS instance resource. operationId: getNsInstance parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string responses: "200": description: | 200 OK Shall be returned when information about an individual NS instance has been read successfully. The response body shall contain a representation of the NS instance, as defined in clause 6.5.2.10. headers: Content-Type: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/NsInstance' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "416": description: | 416 RANGE NOT SATISFIABLE headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' delete: summary: Delete NS instance resource. description: | Delete NS Identifier This method deletes an individual NS instance resource. As the result of successfully executing this method, the "Individual NS instance" resource shall not exist any longer. A notification of type "NsIdentifierDeletionNotification" shall be triggered as part of successfully executing this method as defined in clause 6.5.2.7. operationId: deleteNs parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "204": description: | 204 No Content Shall be returned when the "Individual NS instance" resource and the associated NS identifier have been deleted successfully. The response body shall be empty. headers: WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "412": description: | 412 PRECONDITION FAILED Error: A precondition given in an HTTP request header is not fulfilled. Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}/instantiate: post: summary: Instantiate a NS. description: | The POST method requests to instantiate a NS instance resource. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the "nsState" attribute to the value "INSTANTIATED" in the representation of the "Individual NS instance" resource. operationId: instantiateNS parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance to be instantiated. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - in: body name: body description: | Parameters for the instantiate NS operation, as defined in clause 6.5.2.11. required: true schema: $ref: '#/definitions/InstantiateNsRequest' responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "416": description: | 416 RANGE NOT SATISFIABLE headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}/scale: post: summary: Scale a NS instance. description: | The POST method requests to scale a NS instance resource. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall reflect the result of scaling the NS instance by updating the "nsScaleStatus" attribute in the representation of the "Individual NS instance" resource. operationId: scaleNS parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance to be scaled. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - in: body name: body description: | Parameters for the scale NS operation, as defined in clause 6.5.2.14. required: true schema: $ref: '#/definitions/ScaleNsRequest' responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}/update: post: summary: Updates a NS instance. description: | The POST method updates an NS instance. operationId: nsUpdate parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance to be updated. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - in: body name: body description: | Parameters for the update NS operation, as defined in clause 6.5.2.12. required: true schema: $ref: '#/definitions/UpdateNsRequest' responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}/heal: post: summary: Heal a NS instance. description: | The POST method requests to heal an NS instance. 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. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. operationId: healNS parameters: - name: nsInstanceId in: path description: | Identifier of the NS instance to be healed. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - in: body name: body description: | Parameters for the heal NS operation, as defined in clause 6.5.2.13. required: true schema: $ref: '#/definitions/HealNsRequest' responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_instances/{nsInstanceId}/terminate: post: summary: Terminate a NS instance. description: | Terminate NS task. The POST method terminates an NS instance. This method shall follow the provisions specified in the Tables 6.4.8.3.1-1 and 6.4.8.3.1-2 for URI query parameters, request and response data structures, and response codes. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the "nsState" attribute in the representation of the "Individual NS instance" resource to the value "NOT_INSTANTIATED". This method can only be used with an NS instance in the INSTANTIATED state. Terminating an NS instance does not delete the NS instance identifier, but rather transitions the NS into the NOT_INSTANTIATED state. operationId: terminateNS parameters: - name: nsInstanceId in: path description: | The identifier of the NS instance to be terminated. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - in: body name: body description: | The terminate NS request parameters, as defined in clause 6.5.2.15. required: true schema: $ref: '#/definitions/TerminateNsRequest' responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_lcm_op_occs: get: summary: Query multiple NS LCM operation occurrences. description: | Get Operation Status. Shall be returned upon the following 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 operationId: queryNsLcmOperations parameters: - name: filter in: query description: | Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013[16]. 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 from it shall be supported by the NFVO in the filter expression. required: false type: string - name: fields in: query 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. required: false type: string - name: exclude_fields in: query 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. required: false type: string - name: exclude_default in: query 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 required: false type: string - 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 in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "200": description: | 200 OK 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: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. Link: type: string description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. schema: type: array items: $ref: '#/definitions/inline_response_200_1' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_lcm_op_occs/{nsLcmOpOccId}: get: summary: Read an individual NS LCM operation occurrence resource. description: | The API consumer can use this method to retrieve status information about 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. operationId: queryNsLcmOperationJob parameters: - name: nsLcmOpOccId in: path description: | Identifier of a NS lifecycle management operation occurrence. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "200": description: | 200 OK 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). headers: Content-Type: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/NsLcmOpOcc' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "416": description: | 416 RANGE NOT SATISFIABLE headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_lcm_op_occs/{nsLcmOpOccId}/retry: 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. operationId: retryNsInstance parameters: - name: nsLcmOpOccId in: path description: | Identifier of a NS lifecycle management operation occurrence to be retried. 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. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /ns_lcm_op_occs/{nsLcmOpOccId}/rollback: 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. operationId: rollbackNsInstance parameters: - name: nsLcmOpOccId in: path description: | Identifier of a NS lifecycle management operation occurrence to be rolled back. 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. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235 required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "202": description: | 202 ACCEPTED headers: Content-Type: type: string description: The MIME type of the body of the response. Location: type: string format: url description: The resource URI of the created NS instance WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "409": description: | 409 CONFLICT headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /subscriptions: get: summary: Query multiple subscriptions. description: | 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: - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: filter in: query description: | Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. 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. required: false type: string - 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 in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string responses: "200": description: | 200 OK 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: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. Link: type: string description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. schema: type: array items: $ref: '#/definitions/LccnSubscription' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' 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: - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string - name: Content-Type in: header description: | The MIME type of the body of the request. Reference: IETF RFC 7231 required: true type: string - in: body name: body description: | Details of the subscription to be created, as defined in clause 6.5.2.2. required: true schema: $ref: '#/definitions/LccnSubscriptionRequest' responses: "201": description: "201 Created\nShall 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. \n" headers: Content-Type: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/LccnSubscription' "303": description: | 303 SEE OTHER headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "422": description: | 422 UNPROCESSABLE ENTITY If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. This error response code is only applicable for methods that have a request body. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' /subscriptions/{subscriptionId}: get: summary: Read an individual subscription resource. description: | The GET method retrieves information about a subscription by reading an individual subscription resource. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 6.4.17.3.2-1 and 6.4.17.3.2-2 parameters: - name: subscriptionId in: path description: | Identifier of this subscription. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string - name: Accept in: header description: | Content-Types that are acceptable for the response. Reference: IETF RFC 7231 required: true type: string responses: "200": description: "200 OK\nShall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the \"Individual subscription\" resource. \n" headers: Content-Type: type: string 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. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/LccnSubscription' "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "404": description: | 404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' delete: summary: Terminate a subscription. description: | The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2. As the result of successfully executing this method, the "Individual subscription" resource shall not exist any longer. This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer. NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. parameters: - name: subscriptionId in: path description: | Identifier of this subscription. required: true type: string - name: Authorization in: header description: | The authorization token for the request. Reference: IETF RFC 7235. required: false type: string - name: Version in: header description: | Version of the API requested to use when responding to this request. required: true type: string responses: "204": description: | 204 NO CONTENT Shall be returned when the "Individual subscription" resource has been deleted successfully. The response body shall be empty. headers: WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. "400": description: | 400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "401": description: | 401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "403": description: | 403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "405": description: | 405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "406": description: | 406 NOT ACCEPTABLE If the "Accept" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "500": description: | 500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "503": description: | 503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' "504": description: | 504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. headers: Content-Type: type: string description: The MIME type of the body of the response. WWW-Authenticate: type: string 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. Version: type: string description: | Version of the API used in the response. schema: $ref: '#/definitions/ProblemDetails' definitions: NsInstance: type: object required: - _links - id - nsInstanceDescription - nsInstanceName - nsState - nsdId - nsdInfoId properties: id: description: | Identifier of the NS instance. $ref: '#/definitions/Identifier' nsInstanceName: type: string description: | Human readable name of the NS instance. nsInstanceDescription: type: string description: | Human readable description of the NS instance. nsdId: description: | Identifier of the NSD on which the NS instance is based. $ref: '#/definitions/Identifier' nsdInfoId: description: | Identifier of the NSD information object on which the NS instance is based. This identifier has been allocated by the NFVO. $ref: '#/definitions/Identifier' flavourId: description: | Identifier of the NS deployment flavor applied to the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED. $ref: '#/definitions/IdentifierInNsd' vnfInstance: type: array description: | Information on constituent VNF(s) of the NS instance. items: $ref: '#/definitions/VnfInstance' pnfInfo: type: array description: | Information on the PNF(s) that are part of the NS instance. items: $ref: '#/definitions/PnfInfo' virtualLinkInfo: type: array description: | Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity. items: $ref: '#/definitions/NsVirtualLinkInfo' vnffgInfo: type: array description: | Information on the VNFFG(s) of the NS instance. items: $ref: '#/definitions/VnffgInfo' sapInfo: type: array description: | Information on the SAP(s) of the NS instance. items: $ref: '#/definitions/SapInfo' nestedNsInstanceId: type: array description: | Identifier of the nested NS(s) of the NS instance. items: $ref: '#/definitions/Identifier' nsState: type: string description: | The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated. enum: - NOT_INSTANTIATED - INSTANTIATED monitoringParameter: type: array description: | Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD. items: $ref: '#/definitions/NsMonitoringParameter' nsScaleStatus: type: array description: | Status of each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED. items: $ref: '#/definitions/NsScaleInfo' additionalAffinityOrAntiAffinityRule: type: array description: | Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD. items: $ref: '#/definitions/AffinityOrAntiAffinityRule' _links: $ref: '#/definitions/NsInstance__links' description: | This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1. Identifier: type: string description: | An identifier with the intention of being globally unique. IdentifierInNsd: type: string description: | An identifier that is unique within a NS descriptor. Representation: string of variable length. VnfInstance: type: object required: - id - instantiationState - vnfPkgId - vnfProductName - vnfProvider - vnfSoftwareVersion - vnfdId - vnfdVersion properties: id: description: | Identifier of the VNF instance. $ref: '#/definitions/Identifier' vnfInstanceName: type: string description: | Name of the VNF instance. This attribute can be modified with the PATCH method. vnfInstanceDescription: type: string description: | Human-readable description of the VNF instance. This attribute can be modified with the PATCH method. vnfdId: description: | Identifier of the VNFD on which the VNF instance is based. $ref: '#/definitions/Identifier' vnfProvider: type: string description: | Provider of the VNF and the VNFD. The value is copied from the VNFD. vnfProductName: type: string description: | Name to identify the VNF Product. The value is copied from the VNFD. vnfSoftwareVersion: description: | Software version of the VNF. The value is copied from the VNFD. $ref: '#/definitions/Version' vnfdVersion: description: | Identifies the version of the VNFD. The value is copied from the VNFD. $ref: '#/definitions/Version' vnfPkgId: description: | Identifier of information held by the NFVO about the specific VNF package on which the VNF is based. This identifier has been allocated by the NFVO. This attribute can be modified with the PATCH method. $ref: '#/definitions/Identifier' vnfConfigurableProperties: description: "Additional VNF-specific attributes that provide the current values of the configurable properties of the VNF instance.\nThese attributes represent values that are stored persistently in the VnfInstance structure and that correspond to configuration parameters of the VNF instance. Modifying these attributes affects the configuration of the VNF instance either directly(if the VNF instance is in INSTANTIATED state at the time of the modification) or as part of the subsequent VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED state at the time of the modification).\nConfigurable properties referred in these attributes are declared in the VNFD.\nETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. VNF configurable properties are sometimes also referred to as configuration parameters applicable to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, some are set prior to instantiation (are part of initial configuration) and can be modified later, and others can be set only after instantiation. The applicability of certain configuration may depend on the VNF and the required operation of the VNF at a certain point in time. These configurable properties include the following standard attributes, which are declared in the VNFD if auto-scaling and/or auto-healing are supported by the VNF: \n - isAutoscaleEnabled: If present, the VNF supports auto-scaling. If\n set to true, auto-scaling is currently enabled. If set to false,\n auto-scaling is currently disabled.\n - isAutohealEnabled: If present, the VNF supports auto-healing. If\n set to true, auto-healing is currently enabled. If set to false,\n auto-healing is currently disabled.\n\nThese attributea can be modified with the PATCH method.\n" $ref: '#/definitions/KeyValuePairs' vimId: description: | Identifier of a VIM that manages resources for the VNF instance. $ref: '#/definitions/Identifier' instantiationState: type: string description: | The instantiation state of the VNF. enum: - NOT_INSTANTIATED - INSTANTIATED instantiatedVnfInfo: $ref: '#/definitions/VnfInstance_instantiatedVnfInfo' metadata: description: | Additional VNF-specific attributes that provide metadata describing the VNF instance. Metadata that are writeable are declared in the VNFD (see note 2). These attributes represent values that are stored persistently in the VnfInstance structure for consumption by functional blocks that invoke the VNF lifecycle management interface. They are not consumed by the VNFM, or the lifecycle management scripts. Modifying the values of these attributes has no effect on the VNF instance, it only affects the information represented in the VnfInstance structure. Metadata that are writeable are declared in the VNFD (see note 2). These attributes can be modified with the PATCH method $ref: '#/definitions/KeyValuePairs' extensions: type: object description: | Additional VNF-specific attributes that affect the lifecycle management of this VNF instance. These attributes represent values that are stored persistently in the VnfInstance structure for consumption by the VNFM, or by the lifecycle management scripts. during the execution of VNF lifecycle management operations. Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified attribute values can be considered during subsequent VNF lifecycle management operations, which means that the modified values can indirectly affect the configuration of the VNF instance. Extensions that are writeable are declared in the VNFD. This attribute These attributes can be modified with the PATCH method. ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. allOf: - $ref: '#/definitions/KeyValuePairs' - $ref: '#/definitions/VnfInstanceExtensions' description: | This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF. Version: type: string description: | A Version. Representation: string of variable length. KeyValuePairs: type: object description: | This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. additionalProperties: type: string IdentifierInVnfd: type: string description: | Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. VnfOperationalStateType: type: string enum: - STARTED - STOPPED VnfScaleInfo: type: object required: - aspectId - scaleLevel properties: aspectId: description: | Identifier of the scaling aspect. $ref: '#/definitions/IdentifierInVnfd' scaleLevel: type: integer description: | Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. VnfExtCpInfo: type: object required: - cpdId - id properties: id: description: | Identifier of the external CP instance and the related information instance. $ref: '#/definitions/IdentifierInVnf' cpdId: description: | Identifier of the external CPD, VnfExtCpd, in the VNFD. $ref: '#/definitions/IdentifierInVnfd' cpProtocolInfo: type: array description: | Network protocol information for this CP. items: $ref: '#/definitions/CpProtocolInfo' minItems: 1 extLinkPortId: description: | Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. $ref: '#/definitions/CpProtocolInfo' metadata: description: | Metadata about this external CP. $ref: '#/definitions/KeyValuePairs' associatedVnfcCpId: description: | Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents the VNFC CP which is exposed by this external CP instance. Shall be present in case this CP instance maps to a VNFC CP(s). The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. One and only one shall be present. $ref: '#/definitions/IdentifierInVnf' associatedVnfVirtualLinkId: description: | Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL, which is exposed by this external CP instance. Shall be present in case this CP instance maps to an internal VL. The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. One and only one shall be present. $ref: '#/definitions/IdentifierInVnf' description: | This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1. IdentifierInVnf: type: string description: | An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. CpProtocolInfo: type: object required: - ipOverEthernet - layerProtocol properties: layerProtocol: type: string description: | The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note. enum: - IP_OVER_ETHERNET ipOverEthernet: description: | IP addresses over Ethernet to assign to the CP or SAP instance. Shall be present if layerProtocol is equal to " IP_OVER_ETHERNET", and shall be absent otherwise. $ref: '#/definitions/IpOverEthernetAddressInfo' description: | This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1. IpOverEthernetAddressInfo: type: object required: - ipAddresses - macAddress properties: macAddress: description: | Assigned MAC address. $ref: '#/definitions/MacAddress' ipAddresses: type: array description: | Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. items: $ref: '#/definitions/IpOverEthernetAddressInfo_ipAddresses' type: type: string description: | The type of the IP addresses enum: - PV4 - PV6 addresses: description: | Fixed addresses assigned (from the subnet defined by "subnetId" if provided). See note. $ref: '#/definitions/IpAddress' isDynamic: type: boolean description: | Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if "addresses" is present and shall be absent otherwise. addressRange: $ref: '#/definitions/IpOverEthernetAddressInfo_addressRange_1' minAddress: description: | Lowest IP address belonging to the range $ref: '#/definitions/IpAddress' maxAddress: description: | Highest IP address belonging to the range. $ref: '#/definitions/IpAddress' subnetId: description: | Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses are bound to that subnet. $ref: '#/definitions/IdentifierInVim' description: | This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1. MacAddress: type: string format: MAC description: | A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons. IpAddress: type: string format: IP description: | An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons. IdentifierInVim: type: string description: | An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length. ExtVirtualLinkInfo: type: object required: - id - resourceHandle properties: id: description: | Identifier of the external VL and the related external VL information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. $ref: '#/definitions/Identifier' resourceHandle: description: | Reference to the resource realizing this VL. $ref: '#/definitions/ResourceHandle' extLinkPorts: type: array description: | Link ports of this VL. items: $ref: '#/definitions/ExtLinkPortInfo' ResourceHandle: type: object required: - resourceId properties: vimId: description: | Identifier of the VIM under whose control this resource is placed. This attribute shall be present if VNF-related resource management in direct mode is applicable. It shall also be present for resources that are part of an NS instance such as virtual link resources. $ref: '#/definitions/Identifier' resourceProviderId: description: | Identifier of the entity responsible for the management of the resource. This attribute shall only be supported and present when VNF-related resource management in indirect mode is applicable. The identification scheme is outside the scope of the present document. $ref: '#/definitions/Identifier' resourceId: description: | Identifier of the resource in the scope of the VIM or the resource provider. $ref: '#/definitions/IdentifierInVim' vimLevelResourceType: type: string description: | Type of the resource in the scope of the VIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. description: | This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. ExtLinkPortInfo: type: object required: - id - resourceHandle properties: id: description: | Identifier of this link port as provided by the entity that has created the link port. $ref: '#/definitions/Identifier' resourceHandle: description: | Reference to the virtualised resource realizing this link port. $ref: '#/definitions/ResourceHandle' cpInstanceId: description: | Identifier of the external CP of the VNF connected to this link port. There shall be at most one link port associated with any external connection point instance. The value refers to an "extCpInfo" item in the VnfInstance. $ref: '#/definitions/IdentifierInVnf' description: "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. \n" ExtManagedVirtualLinkInfo: type: object required: - id - vnfVirtualLinkDescId properties: id: description: | Identifier of the externally-managed internal VL and the related externally-managed VL information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. $ref: '#/definitions/Identifier' vnfVirtualLinkDescId: description: | Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: '#/definitions/IdentifierInVnfd' networkResource: description: | Reference to the VirtualNetwork resource. $ref: '#/definitions/ResourceHandle' vnfLinkPorts: type: array description: | Link ports of this VL. items: $ref: '#/definitions/VnfLinkPortInfo' VnfLinkPortInfo: type: object required: - id - resourceHandle properties: id: description: | Identifier of this link port as provided by the entity that has created the link port. $ref: '#/definitions/IdentifierInVnf' resourceHandle: description: | Reference to the virtualised network resource realizing this link port. $ref: '#/definitions/ResourceHandle' cpInstanceId: description: | When the link port is used for external connectivity by the VNF, this attribute represents the identifier of the external CP of the VNF to be connected to this link port. When the link port is used for internal connectivity in the VNF, this attribute represents the VNFC CP to be connected to this link port. Shall be present when the link port is used for external connectivity by the VNF. may be present if used to reference a VNFC CP instance. There shall be at most one link port associated with any external connection point instance or internal connection point (i.e. VNFC CP) instance. The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance. $ref: '#/definitions/IdentifierInVnf' cpInstanceType: type: string description: | Type of the CP instance that is identified by cpInstanceId. Shall be present if "cpInstanceId" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP. enum: - VNFC_CP - EXT_CP VnfMonitoringParameter: type: object required: - id - performanceMetric properties: id: description: | Identifier of the monitoring parameter defined in the VNFD. $ref: '#/definitions/IdentifierInNsd' name: type: string description: | Human readable name of the monitoring parameter, as defined in the VNFD. performanceMetric: type: string description: | Performance metric that is monitored. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. description: | This type represents a monitoring parameter that is tracked by the VNFM, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1. VnfcResourceInfo: type: object required: - computeResource - id - vduId properties: id: description: | Identifier of this VnfcResourceInfo instance. $ref: '#/definitions/IdentifierInVnf' vduId: description: | Reference to the applicable VDU in the VNFD. $ref: '#/definitions/IdentifierInVnfd' computeResource: description: | Reference to the VirtualCompute resource. $ref: '#/definitions/ResourceHandle' storageResourceIds: type: array description: | References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance. items: $ref: '#/definitions/Identifier' reservationId: description: | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: '#/definitions/Identifier' vnfcCpInfo: type: array description: | CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise. items: $ref: '#/definitions/VnfcResourceInfo_vnfcCpInfo' metadata: description: | Metadata about this resource. $ref: '#/definitions/KeyValuePairs' description: | This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance. VnfVirtualLinkResourceInfo: type: object required: - id - networkResource - vnfVirtualLinkDescId properties: id: description: | Identifier of this VnfVirtualLinkResourceInfo instance. $ref: '#/definitions/IdentifierInVnf' vnfVirtualLinkDescId: description: | Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: '#/definitions/IdentifierInVnfd' networkResource: description: | Reference to the VirtualNetwork resource. $ref: '#/definitions/ResourceHandle' reservationId: description: | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: '#/definitions/Identifier' vnfLinkPorts: type: array description: | Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise. items: $ref: '#/definitions/VnfLinkPortInfo' metadata: description: | Metadata about this resource. $ref: '#/definitions/KeyValuePairs' description: | This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance. VirtualStorageResourceInfo: type: object required: - id - storageResource - virtualStorageDescId properties: id: description: | Identifier of this VirtualStorageResourceInfo instance. $ref: '#/definitions/IdentifierInVnf' virtualStorageDescId: description: | Identifier of the VirtualStorageDesc in the VNFD. $ref: '#/definitions/IdentifierInVnfd' storageResource: description: | Reference to the VirtualStorage resource. $ref: '#/definitions/ResourceHandle' reservationId: description: | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: '#/definitions/Identifier' metadata: description: | Metadata about this resource. $ref: '#/definitions/KeyValuePairs' description: | This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. VnfInstanceExtensions: type: object properties: managedBy: $ref: '#/definitions/VnfInstanceExtensions_managedBy' type: type: string networks: type: array items: $ref: '#/definitions/VnfInstanceExtensions_networks' vimName: type: string lcmOperation: type: string lcmOperationState: type: string isOrchestrated: type: boolean PnfInfo: type: object required: - pnfId - pnfProfileId - pnfdId - pnfdInfoId properties: pnfId: description: | Identifier of the PNF. This identifier is allocated by the OSS/BSS. $ref: '#/definitions/Identifier' pnfName: type: string description: | Name of the PNF. pnfdId: description: | Identifier of the PNFD on which the PNF is based. $ref: '#/definitions/Identifier' pnfdInfoId: description: | Identifier of the PNFD information onject related to this PNF. This identifier is allocated by the NFVO $ref: '#/definitions/Identifier' pnfProfileId: description: | Identifier of the related PnfProfile in the NSD on which the PNF is based. $ref: '#/definitions/IdentifierInNsd' cpInfo: description: | Information on the external CP of the PNF. $ref: '#/definitions/PnfExtCpInfo' description: | This type represents the information about a PNF that is part of an NS instance. It shall comply with the provisions defined in Table 6.5.3.13-1. PnfExtCpInfo: type: object required: - cpInstanceId - cpdId properties: cpInstanceId: description: | Identifier of the CP in the scope of the PNF. $ref: '#/definitions/IdentifierInPnf' cpdId: description: | Identifier of (reference to) the Connection Point Descriptor (CPD) for this CP. $ref: '#/definitions/IdentifierInNsd' cpProtocolData: type: array description: | Parameters for configuring the network protocols on the CP. items: $ref: '#/definitions/CpProtocolData' description: | This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1. IdentifierInPnf: type: string description: | An Identifier that is unique within respect to a PNF. Representation: string of variable length. CpProtocolData: type: object required: - layerProtocol properties: layerProtocol: type: string description: | Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET. enum: - IP_OVER_ETHERNET ipOverEthernet: description: | Network address data for IP over Ethernet to assign to the extCP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise. $ref: '#/definitions/IpOverEthernetAddressData' description: | This type represents network protocol data. IpOverEthernetAddressData: type: object properties: macAddress: description: | MAC address. If this attribute is not present, it shall be chosen by the NFV MANO. $ref: '#/definitions/MacAddress' ipAddresses: type: array description: | List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned. items: $ref: '#/definitions/IpOverEthernetAddressData_ipAddresses' description: | This type represents network address data for IP over Ethernet. NsVirtualLinkInfo: type: object required: - id - nsVirtualLinkDescId - nsVirtualLinkProfileId properties: id: description: | Identifier of the VL instance. $ref: '#/definitions/IdentifierInNs' nsVirtualLinkDescId: description: | Identifier of the VLD in the NSD. $ref: '#/definitions/IdentifierInNsd' nsVirtualLinkProfileId: description: | Identifier of the VL profile in the NSD. $ref: '#/definitions/IdentifierInNsd' resourceHandle: type: array description: | Identifier(s) of the virtualised network resource(s) realizing the VL instance. See note. items: $ref: '#/definitions/ResourceHandle' linkPort: type: array description: | Link ports of the VL instance. Cardinality of zero indicates that no port has yet been created for the VL instance. items: $ref: '#/definitions/NsLinkPortInfo' description: | This type specifies the information about an NS VL instance. It shall comply with the provisions defined in Table 6.5.3.53-1 IdentifierInNs: type: string description: | An identifier that is unique with respect to a NS. Representation: string of variable length. NsLinkPortInfo: type: object required: - id - resourceHandle properties: id: description: | Identifier of this link port as provided by the entity that has created the link port. $ref: '#/definitions/Identifier' resourceHandle: description: | Identifier of the virtualised network resource realizing this link port. $ref: '#/definitions/ResourceHandle' nsCpHandle: type: array description: | Identifier of the CP/SAP instance to be connected to this link port. The value refers to a vnfExtCpInfo item in the VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a sapInfo item in the NS instance. There shall be at most one link port associated with any connection point instance. items: $ref: '#/definitions/NsCpHandle' description: | This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1. NsCpHandle: type: object properties: vnfInstanceId: description: | Identifier of the VNF instance associated to the CP instance. This attribute shall be present if the CP instance is VNF external CP. $ref: '#/definitions/Identifier' vnfExtCpInstanceId: description: | Identifier of the VNF external CP instance in the scope of the VNF instance. This attribute shall be present if the CP instance is VNF external CP. See notes 1 and 4. $ref: '#/definitions/IdentifierInVnf' pnfInfoId: description: "Identifier of the PNF instance associated to the CP instance. This attribute shall be present if the CP instance is PNF external CP. See notes 2 and 4. \n" $ref: '#/definitions/Identifier' pnfExtCpInstanceId: description: | Identifier of the PNF external CP instance in the scope of the PNF. This attribute shall be present if the CP instance is PNF external CP. See notes 2 and 4. $ref: '#/definitions/IdentifierInPnf' nsInstanceId: description: "Identifier of the NS instance associated to the SAP instance. This attribute shall be present if the CP instance is NS SAP. See notes 3 and 4. \n" $ref: '#/definitions/Identifier' nsSapInstanceId: description: "Identifier of the SAP instance in the scope of the NS instance. This attribute shall be present if the CP instance is NS SAP. See notes 3 and 4. \n" $ref: '#/definitions/IdentifierInNs' description: | This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1. VnffgInfo: type: object required: - id - vnfInstanceId - vnffgdId properties: id: description: | Identifier of this VNFFG instance. $ref: '#/definitions/Identifier' vnffgdId: description: | Identifier of the VNFFGD in the NSD. $ref: '#/definitions/IdentifierInNsd' vnfInstanceId: type: array description: | Identifier(s) of the constituent VNF instance(s) of this VNFFG instance. items: $ref: '#/definitions/Identifier' pnfdInfoId: type: array description: | Identifier(s) of the constituent PNF instance(s) of this VNFFG instance. items: $ref: '#/definitions/Identifier' nsVirtualLinkInfoId: type: array description: | Identifier(s) of the constituent VL instance(s) of this VNFFG instance. items: $ref: '#/definitions/IdentifierInNs' nsCpHandle: type: array description: | Identifiers of the CP instances attached to the constituent VNFs and PNFs or the SAP instances of the VNFFG. See note. items: $ref: '#/definitions/NsCpHandle' description: | Information on the VNFFG(s) of the NS instance. SapInfo: type: object required: - id - sapName - sapProtocolInfo - sapdId properties: id: description: | Identifier of the SAP instance. $ref: '#/definitions/IdentifierInNs' sapdId: description: | Identifier of the SAPD in the NSD. $ref: '#/definitions/IdentifierInNsd' sapName: type: string description: | Human readable name for the SAP instance. description: type: string description: | Human readable description for the SAP instance. sapProtocolInfo: type: array description: | Network protocol information for this SAP. items: $ref: '#/definitions/CpProtocolInfo' description: | This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1. NsMonitoringParameter: type: object required: - id - performanceMetric properties: id: description: | Identifier of the monitoring parameter defined in the NSD. $ref: '#/definitions/IdentifierInNsd' name: type: string description: | Human readable name of the monitoring parameter, as defined in the NSD. performanceMetric: type: string description: | Performance metric that is monitored. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. description: | This type represents a monitoring parameter that is tracked by the NFVO, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1. NsScaleInfo: type: object required: - nsScaleLevelId - nsScalingAspectId properties: nsScalingAspectId: description: | Identifier of the NS scaling aspect. $ref: '#/definitions/IdentifierInNsd' nsScaleLevelId: description: | Identifier of the NS scale level. $ref: '#/definitions/IdentifierInNsd' description: | This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor. AffinityOrAntiAffinityRule: type: object required: - affinityOrAntiAffiinty - scope properties: vnfdId: type: array description: | Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated. items: $ref: '#/definitions/Identifier' vnfProfileId: type: array description: | Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated. items: $ref: '#/definitions/IdentifierInNsd' vnfInstanceId: type: array description: | Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated. items: $ref: '#/definitions/Identifier' affinityOrAntiAffiinty: type: string description: | The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY. enum: - AFFINITY - ANTI_AFFINITY scope: type: string description: | Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE. enum: - NFVI_POP - ZONE - ZONE_GROUP - NFVI_NODE description: | This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances.. Link: type: object required: - href properties: href: type: string format: url description: | URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: | This type represents a link to a resource. ProblemDetails: type: object required: - detail - status properties: type: type: string format: URI description: | A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank". title: type: string description: | A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). status: type: integer description: | The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. detail: type: string description: | A human-readable explanation specific to this occurrence of the problem. instance: type: string format: URI description: | A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. description: | The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19]. CreateNsRequest: type: object required: - nsDescription - nsName - nsdId properties: nsdId: description: | Identifier of the NSD that defines the NS instance to be created. $ref: '#/definitions/Identifier' nsName: type: string description: | Human-readable name of the NS instance to be created. nsDescription: type: string description: | Human-readable description of the NS instance to be created. InstantiateNsRequest: type: object required: - nsFlavourId properties: nsFlavourId: description: | Identifier of the NS deployment flavor to be instantiated. $ref: '#/definitions/IdentifierInNsd' sapData: type: array description: | Create data concerning the SAPs of this NS. items: $ref: '#/definitions/SapData' addpnfData: type: array description: | Information on the PNF(s) that are part of this NS. items: $ref: '#/definitions/AddPnfData' vnfInstanceData: type: array description: | Specify an existing VNF instance to be used in the NS. If needed, the VNF Profile to be used for this VNF instance is also provided. The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile. items: $ref: '#/definitions/VnfInstanceData' nestedNsInstanceData: type: array description: | Specify an existing NS instance to be used as a nested NS within the NS. If needed, the NS Profile to be used for this nested NS instance is also provided. NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated). NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the nested NSD in the composite NSD. items: $ref: '#/definitions/NestedNsInstanceData' locationConstraints: type: array description: | Defines the location constraints for the VNF to be instantiated as part of the NS instantiation. An example can be a constraint for the VNF to be in a specific geographic location.. items: $ref: '#/definitions/VnfLocationConstraint' additionalParamsForNs: type: object description: | Allows the OSS/BSS to provide additional parameter(s) at the composite NS level (as opposed to the VNF level, which is covered in additionalParamsForVnf), and as opposed to the nested NS level, which is covered in additionalParamForNestedNs. allOf: - $ref: '#/definitions/KeyValuePairs' - $ref: '#/definitions/InstantiateAdditionalParamsForNs' additionalParamForNestedNs: type: array description: | Allows the OSS/BSS to provide additional parameter(s) per nested NS instance (as opposed to the composite NS level, which is covered in additionalParamForNs, and as opposed to the VNF level, which is covered in additionalParamForVnf). This is for nested NS instances that are to be created by the NFVO as part of the NS instantiation and not for existing nested NS instances that are referenced for reuse. items: $ref: '#/definitions/ParamsForNestedNs' additionalParamsForVnf: type: array description: | Allows the OSS/BSS to provide additional parameter(s) per VNF instance (as opposed to the composite NS level, which is covered in additionalParamsForNs and as opposed to the nested NS level, which is covered in additionalParamForNestedNs). This is for VNFs that are to be created by the NFVO as part of the NS instantiation and not for existing VNF that are referenced for reuse. items: $ref: '#/definitions/ParamsForVnf' startTime: description: | Timestamp indicating the earliest time to instantiate the NS. Cardinality "0" indicates the NS instantiation takes place immediately. $ref: '#/definitions/DateTime' nsInstantiationLevelId: description: | Identifies one of the NS instantiation levels declared in the DF applicable to this NS instance. If not present, the default NS instantiation level as declared in the NSD shall be used. $ref: '#/definitions/IdentifierInNsd' additionalAffinityOrAntiAffinityRule: type: array description: | Specifies additional affinity or anti-affinity constraint for the VNF instances to be instantiated as part of the NS instantiation. Shall not conflict with rules already specified in the NSD. items: $ref: '#/definitions/AffinityOrAntiAffinityRule' SapData: type: object required: - description - sapName - sapdId properties: sapdId: description: | Reference to the SAPD for this SAP. $ref: '#/definitions/IdentifierInNsd' sapName: type: string description: | Human readable name for the SAP. description: type: string description: | Human readable description for the SAP. sapProtocolData: type: array description: | Parameters for configuring the network protocols on the SAP. items: $ref: '#/definitions/CpProtocolData' description: | This type represents the information related to a SAP of a NS. It shall comply with the provisions defined in Table 6.5.3.10-1. AddPnfData: type: object required: - pnfId - pnfName - pnfProfileId - pnfdId properties: pnfId: description: | Identifier of the PNF. This identifier is allocated by the OSS/BSS. $ref: '#/definitions/Identifier' pnfName: type: string description: | Name of the PNF pnfdId: description: | Identifier of the PNFD on which the PNF is based. $ref: '#/definitions/Identifier' pnfProfileId: description: | Identifier of related PnfProfile in the NSD on which the PNF is based. $ref: '#/definitions/IdentifierInNsd' cpData: type: array description: | Address assigned for the PNF external CP(s). items: $ref: '#/definitions/PnfExtCpData' description: | This type specifies an PNF to be added to the NS instance and the PNF Profile to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1. PnfExtCpData: type: object required: - cpProtocolData properties: cpInstanceId: description: | Identifier of the CP. Shall be present for existing CP. $ref: '#/definitions/IdentifierInPnf' cpdId: description: | Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP. $ref: '#/definitions/IdentifierInNsd' cpProtocolData: type: array description: | Address assigned for this CP. items: $ref: '#/definitions/CpProtocolData' description: | This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1. VnfInstanceData: type: object required: - vnfInstanceId - vnfProfileId properties: vnfInstanceId: description: | Identifier of the existing VNF instance to be used in the NS. $ref: '#/definitions/Identifier' vnfProfileId: description: | Identifier of (Reference to) a vnfProfile defined in the NSD which the existing VNF instance shall be matched with. If not present, the NFVO will select the VnfProfile matching the information in the VNF instance. $ref: '#/definitions/IdentifierInNsd' description: | This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1. NestedNsInstanceData: type: object required: - nestedNsInstanceId properties: nestedNsInstanceId: description: | Identifier of the existing nested NS instance to be used in the NS. $ref: '#/definitions/Identifier' nsProfileId: description: | Identifier of an NsProfile defined in the NSD which the existing nested NS instance shall be matched with. If not present, the NFVO will select the NsProfile matching the information in the nested NS instance. $ref: '#/definitions/IdentifierInNs' description: | This type specifies an existing nested NS instance to be used in the NS instance and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1. VnfLocationConstraint: type: object required: - vnfProfileId properties: vnfProfileId: description: | Identifier of (reference to) a vnfProfile to which the additional parameters apply. $ref: '#/definitions/IdentifierInNsd' locationConstraints: description: | Defines the location constraints for the VNF instance to be created based on the VNF profile. $ref: '#/definitions/LocationConstraints' description: | This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1. LocationConstraints: type: object required: - countryCode properties: countryCode: type: string description: | The two-letter ISO 3166 [29] country code in capital letters. civicAddressElement: type: array description: | Zero or more elements comprising the civic address. items: $ref: '#/definitions/LocationConstraints_civicAddressElement' description: | This type represents location constraints for a VNF to be instantiated. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776 [13]. InstantiateAdditionalParamsForNs: type: object properties: entityPrefix: type: string ParamsForNestedNs: type: object required: - nsProfileId properties: nsProfileId: description: | Identifier of a NsProfile to which the additional parameters apply. $ref: '#/definitions/IdentifierInNsd' additionalParam: type: array description: | Additional parameters that are to be applied on a per nested NS instance. items: $ref: '#/definitions/KeyValuePairs' description: | This type specifies additional parameters on a per-nested NS instance basis. It shall comply with the provisions defined in Table 6.5.3.21a-1. ParamsForVnf: type: object required: - vnfProfileId properties: vnfProfileId: description: | Identifier of (reference to) a vnfProfile to which the additional parameters apply. $ref: '#/definitions/IdentifierInNsd' vnfInstanceName: type: string description: | Human-readable name of the VNF instance to be created. vnfInstanceDescription: type: string description: | Human-readable description of the VNF instance to be created. vnfConfigurableProperties: description: | Values for the "vnfConfigurableProperties" input parameter of the Instantiate VNF operation defined in ETSI GS NFV-SOL 003 [4]. $ref: '#/definitions/KeyValuePairs' metadata: type: object description: | Values for the "metadata" input parameter of the Create VNF Identifier operation defined in ETSI GS NFV-SOL 003 [4]. properties: {} extensions: description: | Values for the "extensions" attribute of the Instantiate VNF operation defined in ETSI GS NFV-SOL 003 [4]. $ref: '#/definitions/KeyValuePairs' additionalParams: type: object description: | Additional input parameters for the instantiation process, specific to the VNF being instantiated, as declared in the VNFD as part of "InstantiateVnfOpConfig". allOf: - $ref: '#/definitions/KeyValuePairs' - $ref: '#/definitions/ParamsForVnfAdditionalParams' description: | This type defines the additional parameters for the VNF instance to be created associated with an NS instance. It shall comply with the provisions defined in Table 6.5.3.22-1. ParamsForVnfAdditionalParams: type: object properties: nfType: type: string description: Vnf type, ex vnf/cnf entityPrefix: type: string useVAppTemplates: type: boolean catalogName: type: string catalogId: type: string vduParams: type: array items: $ref: '#/definitions/VduParam' instantiationLevelId: type: string extVirtualLinks: type: array items: $ref: '#/definitions/ExtVirtualLinkData' nodeProfileName: type: string vimConnectionInfo: type: array items: $ref: '#/definitions/VimConnectionInfo' lcmInterfaces: type: object example: lcmInterfaces: scale_start: - name: USER type: string value: root - name: PWD type: password value: Y2EkaGMwdw== - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 scale_end: - name: USER type: string value: root - name: PWD type: password value: Y2EkaGMwdw== - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 properties: {} VduParam: type: object properties: vduName: type: string deploymentProfileId: type: string chartName: type: string namespace: type: string repoUrl: type: string username: type: string password: type: string overrides: type: string metadata: type: array items: type: object properties: {} catalogName: type: string catalogId: type: string ExtVirtualLinkData: type: object required: - extCps - resourceId properties: extVirtualLinkId: description: | The identifier of the external VL instance, if provided. $ref: '#/definitions/Identifier' vimId: description: | Identifier of the VIM that manages this resource. This attribute shall only be supported and present if VNFrelated resource management in direct mode is applicable. $ref: '#/definitions/Identifier' resourceProviderId: description: | Identifies the entity responsible for the management of this resource. This attribute shall only be supported and present if VNF-related resource management in indirect mode is applicable. The identification scheme is outside the scope of the present document. $ref: '#/definitions/Identifier' resourceId: description: | The identifier of the resource in the scope of the VIM or the resource provider. $ref: '#/definitions/IdentifierInVim' extCps: type: array description: | External CPs of the VNF to be connected to this external VL. items: $ref: '#/definitions/VnfExtCpData' extLinkPorts: type: array description: | Externally provided link ports to be used to connect external connection points to this external VL. items: $ref: '#/definitions/ExtLinkPortData' description: | This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1. VnfExtCpData: type: object required: - cpdId properties: cpdId: description: | The identifier of the CPD in the VNFD. $ref: '#/definitions/IdentifierInVnfd' cpConfig: type: array description: | List of instance data that need to be configured on the CP instances created from the respective CPD. items: $ref: '#/definitions/VnfExtCpConfig' description: | This type represents configuration information for external CPs created from a CPD. VnfExtCpConfig: type: object properties: cpInstanceId: description: | Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. Shall be present if this instance has already been created. $ref: '#/definitions/IdentifierInVnf' linkPortId: description: | Identifier of a pre-configured link port to which the external CP will be associated. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": * The "linkPortId" and "cpProtocolData" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. * At least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance. * If the "linkPortId" attribute is absent, the VNFM shall create a link port. * If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre-created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. * If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". $ref: '#/definitions/Identifier' cpProtocolData: type: array description: | Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": * The "linkPortId" and "cpProtocolData" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. * At least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance. * If the "linkPortId" attribute is absent, the VNFM shall create a link port. * If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre-created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. * If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". items: $ref: '#/definitions/CpProtocolData' description: | This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL. ExtLinkPortData: type: object required: - id - resourceHandle properties: id: description: | Identifier of this link port as provided by the entity that has created the link port. $ref: '#/definitions/Identifier' resourceHandle: description: | Reference to the virtualised resource realizing this link port. $ref: '#/definitions/ResourceHandle' description: | This type represents an externally provided link port to be used to connect an external connection point to an external VL. VimConnectionInfo: type: object required: - vimId properties: id: description: | The identifier of the VIM Connection. This identifier is managed by the NFVO. $ref: '#/definitions/Identifier' vimId: description: | The identifier of the VIM instance. This identifier is managed by the NFVO. Shall be present to address additional information about the VIM if such information has been configured into the VNFM by means outside the scope of the present document, and should be absent otherwise. $ref: '#/definitions/Identifier' vimType: type: string description: | Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003. interfaceInfo: description: | Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType. Alternatively, such information may have been configured into the VNFM and bound to the vimId. $ref: '#/definitions/KeyValuePairs' accessInfo: description: | Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType. If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included. If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band. If applicable, this attribute also provides information about the resourceGroupIds that are accessible using a particular set of credentials. See definition of "resourceGroupId" in clause 9.5.3.3. Once the connectivity between VNFM and VIM is provided through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM. $ref: '#/definitions/KeyValuePairs' extra: description: | VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. $ref: '#/definitions/vimConnectionInfoExtras' description: | This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM. vimConnectionInfoExtras: type: object properties: deploymentProfileId: type: string nodeProfileName: type: string nodePoolId: type: string nodePoolName: type: string vimName: type: string DateTime: type: string format: date-time description: | Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339. ScaleNsRequest: type: object required: - scaleType properties: scaleType: type: string description: | Indicates the type of scaling to be performed. Possible values: - SCALE_NS - SCALE_VNF enum: - SCALE_NS - SCALE_VNF scaleNsData: description: | The necessary information to scale the referenced NS instance. It shall be present when scaleType = SCALE_NS. $ref: '#/definitions/ScaleNsData' scaleVnfData: type: array description: | The necessary information to scale the referenced NS instance. It shall be present when scaleType = SCALE_VNF. items: $ref: '#/definitions/ScaleVnfData' scaleTime: description: | Timestamp indicating the scale time of the NS, i.e. the NS will be scaled at this timestamp. Cardinality "0" indicates the NS scaling takes place immediately". $ref: '#/definitions/DateTime' description: | This type represents a request for the scale NS operation. Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided ScaleNsData: type: object properties: vnfInstanceToBeAdded: type: array description: | An existing VNF instance to be added to the NS instance as part of the scaling operation. If needed, the VNF Profile to be used for this VNF instance may also be provided. items: $ref: '#/definitions/VnfInstanceData' vnfInstanceToBeRemoved: type: array description: | The VNF instance to be removed from the NS instance as part of the scaling operation. items: $ref: '#/definitions/Identifier' scaleNsByStepsData: description: | The information used to scale an NS instance by one or more scaling steps. $ref: '#/definitions/ScaleNsByStepsData' scaleNsToLevelData: description: | The information used to scale an NS instance to a target size. $ref: '#/definitions/ScaleNsToLevelData' additionalParamsForNs: description: | Allows the OSS/BSS to provide additional parameter(s) at the NS level necessary for the NS scaling (as opposed to the VNF level, which is covered in additionalParamForVnf). $ref: '#/definitions/ParamsForVnfAdditionalParams' additionalParamsForVnf: type: array description: | Allows the OSS/BSS to provide additional parameter(s) per VNF instance (as opposed to the NS level, which is covered in additionalParamforNs). This is for VNFs that are to be created by the NFVO as part of the NS scaling and not for existing VNF that are covered by the scaleVnfData. items: $ref: '#/definitions/ParamsForVnf' locationConstraints: type: array description: | The location constraints for the VNF to be instantiated as part of the NS scaling. An example can be a constraint for the VNF to be in a specific geographic location. items: $ref: '#/definitions/VnfLocationConstraint' description: | This type represents the information to scale a NS. ScaleNsByStepsData: type: object required: - aspectId - scalingDirection properties: scalingDirection: type: string description: | The scaling direction. Possible values are: - SCALE_IN - SCALE_OUT. enum: - SCALE_IN - SCALE_OUT aspectId: description: | The aspect of the NS that is requested to be scaled, as declared in the NSD. $ref: '#/definitions/IdentifierInNsd' numberOfSteps: type: integer description: | The number of scaling steps to be performed. Defaults to 1. description: | This type represents the information used to scale an NS instance by one or more scaling steps, with respect to a particular NS scaling aspect. Performing a scaling step means increasing/decreasing the capacity of an NS instance in a discrete manner, i.e. moving from one NS scale level to another. The NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are declared in the NSD. ScaleNsToLevelData: type: object properties: nsInstantiationLevel: description: | Identifier of the target NS instantiation level of the current DF to which the NS instance is requested to be scaled. $ref: '#/definitions/IdentifierInNsd' nsScaleInfo: type: array description: | For each NS scaling aspect of the current DF, defines the target NS scale level to which the NS instance is to be scaled. items: $ref: '#/definitions/NsScaleInfo' description: | This type represents the information used to scale an NS instance to a target size. The target size is either expressed as an NS instantiation level or as a list of NS scale levels, one per NS scaling aspect, of the current DF. The NS instantiation levels, the NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are declared in the NSD. ScaleVnfData: type: object required: - scaleVnfType - vnfInstanceid properties: vnfInstanceid: description: | Identifier of the VNF instance being scaled. $ref: '#/definitions/Identifier' scaleVnfType: type: string description: | Type of the scale VNF operation requested. Allowed values are: - SCALE_OUT - SCALE_IN - SCALE_TO_INSTANTIATION_LEVEL - SCALE_TO_SCALE_LEVEL(S) The set of types actually supported depends on the capabilities of the VNF being managed. enum: - SCALE_OUT - SCALE_IN - SCALE_TO_INSTANTIATION_LEVEL - SCALE_TO_SCALE_LEVEL(S) scaleToLevelData: description: | The information used for scaling to a given level. $ref: '#/definitions/ScaleToLevelData' scaleByStepData: description: | The information used for scaling by steps. $ref: '#/definitions/ScaleByStepData' description: | This type represents defines the information to scale a VNF instance to a given level, or to scale a VNF instance by steps. ScaleToLevelData: type: object properties: vnfInstantiationLevelId: description: | Identifier of the target instantiation level of the current deployment flavor to which the VNF is requested to be scaled. $ref: '#/definitions/IdentifierInVnfd' vnfScaleInfo: type: array description: | For each scaling aspect of the current deployment flavor, indicates the target scale level to which the VNF is to be scaled. items: $ref: '#/definitions/VnfScaleInfo' additionalParams: type: object description: | Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled. allOf: - $ref: '#/definitions/KeyValuePairs' - $ref: '#/definitions/ScaleAdditionalParams' description: | This type describes the information used to scale a VNF instance to a target size. The target size is either expressed as an instantiation level of that DF as defined in the VNFD, or given as a list of scale levels, one per scaling aspect of that DF. Instantiation levels and scaling aspects are declared in the VNFD. The NFVO shall then invoke the ScaleVnfToLevel operation towards the appropriate VNFM.. ScaleAdditionalParams: type: object properties: nfType: type: string vduParams: type: array items: $ref: '#/definitions/VduParam' lcmInterfaces: type: object properties: {} ScaleByStepData: type: object required: - aspectId properties: aspectId: description: | Identifier of (reference to) the aspect of the VNF that is requested to be scaled, as declared in the VNFD. $ref: '#/definitions/IdentifierInVnfd' numberOfSteps: type: integer description: | Number of scaling steps. It shall be a positive number. Defaults to 1. The VNF provider defines in the VNFD whether or not a particular VNF supports performing more than one step at a time. Such a property in the VNFD applies for all instances of a particular VNF. additionalParams: type: object description: | Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF instance being scaled. allOf: - $ref: '#/definitions/KeyValuePairs' - $ref: '#/definitions/ScaleAdditionalParams' description: | This type describes the information to scale a VNF instance by steps. The NFVO shall then invoke the Scale VNF operation towards the appropriate VNFM. UpdateNsRequest: type: object required: - updateType properties: updateType: type: string description: | The type of update. It determines also which one of the following parameters is present in the operation. Possible values include: * ADD_VNF: Adding existing VNF instance(s) * REMOVE_VNF: Removing VNF instance(s) * INSTANTIATE_VNF: Instantiating new VNF(s) * CHANGE_VNF_DF: Changing VNF DF * OPERATE_VNF: Changing VNF state, * MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s) * CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s) * ADD_SAP: Adding SAP(s) * REMOVE_SAP: Removing SAP(s) * ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s) * REMOVE_NESTED_NS: Removing existing nested NS instance(s) * ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance * MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance * ADD_VNFFG: Adding VNFFG(s) * REMOVE_VNFFG: Removing VNFFG(s) * UPDATE_VNFFG: Updating VNFFG(s) * CHANGE_NS_DF: Changing NS DF * ADD_PNF: Adding PNF * MODIFY_PNF: Modifying PNF * REMOVE_PNF: Removing PNF enum: - ADD_VNF - REMOVE_VNF - INSTANTIATE_VNF - CHANGE_VNF_DF - OPERATE_VNF - MODIFY_VNF_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY - ADD SAP - REMOVE_SAP - ADD_NESTED_NS - REMOVE_NESTED_NS - ASSOC_NEW_NSD_VERSION - MOVE_VNF - ADD_VNFFG - REMOVE_VNFFG - UPDATE_VNFFG - CHANGE_NS_DF - ADD_PNF - MODIFY_PNF - REMOVE_PNF addVnfIstance: type: array description: "Identifies an existing VNF instance to be added to the NS instance. It shall be present only if updateType = \"ADD_VNF\". \n" items: $ref: '#/definitions/VnfInstanceData' removeVnfInstanceId: type: array description: | Identifies an existing VNF instance to be removed from the NS instance. It contains the identifier(s) of the VNF instances to be removed. It shall be present only if updateType = "REMOVE_VNF." Note: If a VNF instance is removed from a NS and this NS was the last one for which this VNF instance was a part, the VNF instance is terminated by the NFVO. items: $ref: '#/definitions/Identifier' instantiateVnfData: type: array description: | Identifies the new VNF to be instantiated. It can be used e.g. for the bottom-up NS creation. It shall be present only if updateType = "INSTANTIATE_VNF". items: $ref: '#/definitions/InstantiateVnfData' changeVnfFlavourData: type: array description: | Identifies the new DF of the VNF instance to be changed to. It shall be present only if updateType = "CHANGE_VNF_DF". items: $ref: '#/definitions/ChangeVnfFlavourData' operateVnfData: type: array description: | Identifies the state of the VNF instance to be changed. It shall be present only if updateType = "OPERATE_VNF". items: $ref: '#/definitions/OperateVnfData' modifyVnfInfoData: type: array description: | Identifies the VNF information parameters and/or the configurable properties of VNF instance to be modified. It shall be present only if updateType = "MODIFY_VNF_INFORMATION". items: $ref: '#/definitions/ModifyVnfInfoData' changeExtVnfConnectivityData: type: array description: | Specifies the new external connectivity data of the VNF instance to be changed. It shall be present only if updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY". items: $ref: '#/definitions/ChangeExtVnfConnectivityData' addSap: type: array description: | Identifies a new SAP to be added to the NS instance. It shall be present only if updateType = "ADD_SAP." items: $ref: '#/definitions/SapData' removeSapId: type: array description: | The identifier an existing SAP to be removed from the NS instance. It shall be present only if updateType = "REMOVE_SAP." items: $ref: '#/definitions/Identifier' addNestedNsData: type: array description: | The identifier of an existing nested NS instance to be added to (nested within) the NS instance. It shall be present only if updateType = "ADD_NESTED_NS". items: $ref: '#/definitions/NestedNsInstanceData' removeNestedNsId: type: array description: | The identifier of an existing nested NS instance to be removed from the NS instance. It shall be present only if updateType = "REMOVE_NESTED_NS". items: $ref: '#/definitions/IdentifierInNs' assocNewNsdVersionData: description: | Specify the new NSD to be used for the NS instance. It shall be present only if updateType = ASSOC_NEW_NSD_VERSION". $ref: '#/definitions/AssocNewNsdVersionData' moveVnfInstanceData: type: array description: | Specify existing VNF instance to be moved from one NS instance to another NS instance. It shall be present only if updateType = MOVE_VNF". items: $ref: '#/definitions/MoveVnfInstanceData' addVnffg: type: array description: | Specify the new VNFFG to be created to the NS Instance. It shall be present only if updateType = "ADD_VNFFG". items: $ref: '#/definitions/AddVnffgData' removeVnffgId: type: array description: | Identifier of an existing VNFFG to be removed from the NS Instance. It shall be present only if updateType = "REMOVE_VNFFG". items: $ref: '#/definitions/Identifier' updateVnffg: type: array description: | Specify the new VNFFG Information data to be updated for a VNFFG of the NS Instance. It shall be present only if updateType = "UPDATE_VNFFG". items: $ref: '#/definitions/UpdateVnffgData' changeNsFlavourData: description: | Specifies the new DF to be applied to the NS instance. It shall be present only if updateType = "CHANGE_NS_DF". $ref: '#/definitions/ChangeNsFlavourData' addPnfData: type: array description: | specifies the PNF to be added into the NS instance. It shall be present only if updateType = "ADD_PNF". items: $ref: '#/definitions/AddPnfData' modifyPnfData: type: array description: | Specifies the PNF to be modified in the NS instance. It shall be present only if updateType = "MODIFY_PNF". items: $ref: '#/definitions/ModifyPnfData' removePnfId: type: array description: | Identifier of the PNF to be deleted from the NS instance. It shall be present only if updateType = "REMOVE_PNF". items: $ref: '#/definitions/Identifier' updateTime: description: | Timestamp indicating the update time of the NS, i.e. the NS will be updated at this timestamp. Cardinality "0" indicates the NS update takes place immediately. $ref: '#/definitions/DateTime' description: | This operation supports the update of a NS instance, It shall comply with the provisions defined in Table 6.5.2.12-1. InstantiateVnfData: type: object required: - vnfFlavourId - vnfdId properties: vnfdId: description: | Information sufficient to identify the VNFD which defines the VNF to be instantiated. $ref: '#/definitions/Identifier' vnfFlavourId: description: | Identifier of the VNF deployment flavor to be instantiated. $ref: '#/definitions/IdentifierInVnfd' vnfInstantiationLevelId: description: | Identifier of the instantiation level of the deployment flavor to be instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. $ref: '#/definitions/IdentifierInVnfd' vnfInstanceName: type: string description: | Human-readable name of the VNF instance to be created. vnfInstanceDescription: type: string description: | Human-readable description of the VNF instance to be created. extVirtualLinks: type: array description: | Information about external VLs to connect the VNF to. items: $ref: '#/definitions/ExtVirtualLinkData' extManagedVirtualLinks: type: array description: | Information about internal VLs that are managed by other entities than the VNFM. items: $ref: '#/definitions/ExtManagedVirtualLinkData' localizationLanguage: type: string description: | Localization language of the VNF to be instantiated. The value shall comply with the format defined in IETF RFC 5646. vnfConfigurableProperties: description: | Values for the "vnfConfigurableProperties" input parameter of the Instantiate VNF operation defined in ETSI GS NFV-SOL 003 [4]. $ref: '#/definitions/KeyValuePairs' additionalParams: description: | Additional input parameters for the instantiation process, specific to the VNF being instantiated. $ref: '#/definitions/KeyValuePairs' metadata: description: | This attribute provides values for the "metadata" input parameter of the Create VNF Identifier operation. $ref: '#/definitions/KeyValuePairs' extensions: description: | This attribute provides values for the "extensions" input parameter of the Instantiate VNF operation. $ref: '#/definitions/KeyValuePairs' locationConstraints: description: | Defines the location constraints for the VNF to be instantiated as part of the NS Update. An example can be a constraint for the VNF to be in a specific geographic location. $ref: '#/definitions/VnfLocationConstraint' description: | This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the provisions defined in Table 6.5.3.24-1. ExtManagedVirtualLinkData: type: object required: - resourceId - vnfVirtualLinkDescId properties: extManagedVirtualLinkId: description: | The identifier of the externally-managed internal VL instance, if provided. $ref: '#/definitions/Identifier' vnfVirtualLinkDescId: description: | The identifier of the VLD in the VNFD for this VL. $ref: '#/definitions/IdentifierInVnfd' vimId: description: | Identifier of the VIM that manage this resource. This attribute shall only be supported and present if VNFrelated resource management in direct mode is applicable. $ref: '#/definitions/Identifier' resourceProviderId: description: | Identifies the entity responsible for the management of this resource. This attribute shall only be supported and present if VNF-related resource management in indirect mode is applicable. The identification scheme is outside the scope of the present document. $ref: '#/definitions/Identifier' resourceId: description: | The identifier of the resource in the scope of the VIM or the resource provider. $ref: '#/definitions/IdentifierInVim' description: | This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1. ChangeVnfFlavourData: type: object required: - newFlavourId - vnfInstanceId properties: vnfInstanceId: description: | Identifier of the VNF instance to be modified. $ref: '#/definitions/Identifier' newFlavourId: description: | Identifier of the VNF deployment flavor to be instantiated. $ref: '#/definitions/IdentifierInVnfd' instantiationLevelId: description: | Identifier of the instantiation level of the deployment flavor to be instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. $ref: '#/definitions/IdentifierInVnfd' extVirtualLinks: type: array description: | Information about external VLs to connect the VNF to. items: $ref: '#/definitions/ExtVirtualLinkData' extManagedVirtualLinks: type: array description: | information about internal VLs that are managed by NFVO. items: $ref: '#/definitions/ExtManagedVirtualLinkData' additionalParams: description: | Additional input parameters for the flavor change process, specific to the VNF being modified, as declared in the VNFD as part of "ChangeVnfFlavourOpConfig". $ref: '#/definitions/KeyValuePairs' description: | The type represents the information that is requested to be changed deployment flavor for an existing VNF instance. It shall comply with the provisions defined in Table 6.5.3.25-1. OperateVnfData: type: object required: - changeStateTo - vnfInstanceId properties: vnfInstanceId: description: | Identifier of the VNF instance. $ref: '#/definitions/Identifier' changeStateTo: description: | The desired operational state (i.e. started or stopped) to change the VNF to. $ref: '#/definitions/OperationalStates' stopType: description: "It signals whether forceful or graceful stop is requested. \n" $ref: '#/definitions/StopType' gracefulStopTimeout: type: integer description: | The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF. additionalParam: description: | Additional parameters passed by the OSS/BSS as input to the Operate VNF operation, specific to the VNF being operated. $ref: '#/definitions/KeyValuePairs' description: | This type represents a VNF instance for which the operational state needs to be changed and the requested new state. It shall comply with the provisions defined in Table 6.5.3.31-1. OperationalStates: type: string description: | STARTED - The VNF instance is up and running. STOPPED - The VNF instance has been shut down. enum: - STARTED - STOPPED StopType: type: string description: | * FORCEFUL: The VNFM will stop the VNF immediately after accepting the request. * GRACEFUL: The VNFM will first arrange to take the VNF out of service after accepting the request. Once that operation is successful or once the timer value specified in the "gracefulStopTimeout" attribute expires, the VNFM will stop the VNF. enum: - FORCEFUL - GRACEFUL ModifyVnfInfoData: type: object required: - vnfInstanceId properties: vnfInstanceId: description: | Identifier of the VNF instance. $ref: '#/definitions/Identifier' vnfInstanceName: type: string description: | New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute. vnfInstanceDescription: type: string description: | New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute. vnfdId: description: | New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted $ref: '#/definitions/Identifier' vnfConfigurableProperties: description: | Modifications to entries in the "vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57. $ref: '#/definitions/KeyValuePairs' metadata: description: | Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57. $ref: '#/definitions/KeyValuePairs' extensions: description: | Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57. $ref: '#/definitions/KeyValuePairs' description: | This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD. ChangeExtVnfConnectivityData: type: object required: - extVirtualLinks - vnfInstanceId properties: vnfInstanceId: description: | Identifier of the VNF instance. $ref: '#/definitions/Identifier' extVirtualLinks: type: array description: | Information about external VLs to change (e.g. connect the VNF to). items: $ref: '#/definitions/ExtVirtualLinkData' additionalParams: description: | Additional parameters passed by the OSS as input to the external connectivity change process, specific to the VNF instance being changed. $ref: '#/definitions/KeyValuePairs' description: | This type describes the information invoked by the NFVO to change the external VNF connectivity information maintained by the VNFM. The types of changes that this operation supports are: 1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different external VL. 2) Change the connectivity parameters of the existing external CPs, including changing addresses. NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP address assignment) might not be supported without deleting the resource and creating another one with the modified configuration. This type shall comply with the provisions defined in Table 6.5.3.33-1. AssocNewNsdVersionData: type: object required: - newNsdId properties: newNsdId: description: | Identifier of the new NSD version that is to be associated to the NS instance. $ref: '#/definitions/Identifier' sync: type: boolean description: | Specify whether the NS instance shall be automatically synchronized to the new NSD by the NFVO (in case of true value) or the NFVO shall not do any action (in case of a false value) and wait for further guidance from OSS/BSS (i.e. waiting for OSS/BSS to issue NS lifecycle management operation to explicitly add/remove VNFs and modify information of VNF instances according to the new NSD). The synchronization to the new NSD means e.g. instantiating/adding those VNFs whose VNFD is referenced by the new NSD version but not referenced by the old one, terminating/removing those VNFs whose VNFD is referenced by the old NSD version but not referenced by the new NSD version, modifying information of VNF instances to the new applicable VNFD provided in the new NSD version. A cardinality of 0 indicates that synchronization shall not be done. description: | This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance. Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This data type shall comply with the provisions defined in Table 6.5.3.34-1. MoveVnfInstanceData: type: object required: - targetNsInstanceId properties: targetNsInstanceId: description: | Specify the target NS instance where the VNF instances are moved to. $ref: '#/definitions/Identifier' vnfInstanceId: type: array description: | Specify the VNF instance that is moved. items: $ref: '#/definitions/Identifier' description: | This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination NS instance is specified in this data type (referred to targetNsInstanceId). It shall comply with the provisions defined in Table 6.5.3.35-1. AddVnffgData: type: object required: - description - vnffgName properties: targetNsInstanceId: description: | Identifier of the VNFFGD used to create this VNFFG instance. $ref: '#/definitions/IdentifierInNsd' vnffgName: type: string description: | Human readable name for the VNFFG. description: type: string description: | Human readable description for the VNFFG. description: | This type specifies the parameters used for the creation of a new VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.36-1. UpdateVnffgData: type: object required: - vnffgInfoId properties: vnffgInfoId: description: | Identifier of an existing VNFFG to be updated for the NS Instance. $ref: '#/definitions/IdentifierInNs' nfp: type: array description: | Indicate the desired new NFP(s) for a given VNFFG after the operations of addition/removal of NS components (e.g. VNFs, VLs, etc.) have been completed, or indicate the updated or newly created NFP classification and selection rule which applied to an existing NFP. items: $ref: '#/definitions/NfpData' nfpInfoId: type: array description: | Identifier(s) of the NFP to be deleted from a given VNFFG. items: $ref: '#/definitions/IdentifierInNs' description: | This type specifies the parameters used for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.37-1. NfpData: type: object properties: nfpInfoId: description: | Identifier of the NFP to be modified. It shall be present for modified NFPs and shall be absent for the new NFP. It shall be present for modified NFPs and shall be absent for the new NFP. $ref: '#/definitions/IdentifierInNs' nfpName: type: string description: | Human readable name for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise. description: type: string description: | Human readable description for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise. cpGroup: type: array description: | Group(s) of CPs and/or SAPs which the NFP passes by. Cardinality can be 0 if only updated or newly created NFP classification and selection rule which applied to an existing NFP is provided. At least a CP or an nfpRule shall be present. When multiple identifiers are included, the position of the identifier in the cpGroup value specifies the position of the group in the path. items: $ref: '#/definitions/CpGroupInfo' nfpRule: description: | NFP classification and selection rule. See note 1. $ref: '#/definitions/NfpRule' description: | This type contains information used to create or modify NFP instance parameters for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.38-1. CpGroupInfo: type: object properties: cpPairInfo: type: array description: | One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by. All CP or SAP pairs in a group shall be instantiated from connection point descriptors or service access point descriptors referenced in the corresponding NfpPositionDesc. items: $ref: '#/definitions/CpPairInfo' minItems: 1 forwardingBehaviour: type: string description: | Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of the group. Permitted values: * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs of the group. * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected based on a loadbalancing algorithm. enum: - ALL - LB forwardingBehaviourInputParameters: description: | Provides input parameters to configure the forwarding behaviour (e.g. identifies a load balancing algorithm and criteria). $ref: '#/definitions/ForwardingBehaviourInputParameters' description: | This type represents describes a group of CPs and/or SAPs pairs associated to the same position in an NFP. It shall comply with the provisions defined in Table 6.5.3.71-1. CpPairInfo: type: object properties: vnfExtCpIds: type: array description: | Identifier(s) of the VNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position. items: $ref: '#/definitions/IdentifierInVnf' maxItems: 2 pnfExtCpIds: type: array description: | Identifier(s) of the PNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position. items: $ref: '#/definitions/IdentifierInPnf' maxItems: 2 sapIds: type: array description: | Identifier(s) of the SAP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position. items: $ref: '#/definitions/IdentifierInNs' maxItems: 2 description: | This type represents describes a pair of ingress and egress CPs or SAPs which the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1. ForwardingBehaviourInputParameters: type: object properties: algortihmName: type: string description: | May be included if forwarding behaviour is equal to LB. Shall not be included otherwise. Permitted values: * ROUND_ROBIN * LEAST_CONNECTION * LEAST_TRAFFIC * LEAST_RESPONSE_TIME * CHAINED_FAILOVER * SOURCE_IP_HASH * SOURCE_MAC_HASH enum: - ROUND_ROBIN - LEAST_CONNECTION - LEAST_TRAFFIC - LEAST_RESPONSE_TIME - CHAINED_FAILOVER - SOURCE_IP_HASH - SOURCE_MAC_HASH algorithmWeights: type: array description: | Percentage of messages sent to a CP instance. May be included if applicable to the algorithm. If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used. Weight applies to the CP instances in the order they have been created. items: type: integer description: | This type represents provides input parameters to configure the forwarding behaviour. It shall comply with the provisions defined in Table 6.5.3.73-1. NfpRule: type: object properties: etherDestinationAddress: description: | Indicates a destination Mac address. $ref: '#/definitions/MacAddress' etherSourceAddress: description: | Indicates a source Mac address. $ref: '#/definitions/MacAddress' etherType: type: string description: | Human readable description for the VNFFG. enum: - IPV4 - IPV6 vlanTag: type: array description: | Indicates a VLAN identifier in an IEEE 802.1Q-2018 tag [6] Multiple tags can be included for QinQ stacking. See note. items: $ref: '#/definitions/String' protocol: type: string description: | Indicates the L4 protocol, For IPv4 [7] this corresponds to the field called "Protocol" to identify the next level protocol. For IPv6 [28] this corresponds to the field is called the "Next Header" field. Permitted values: Any keyword defined in the IANA protocol registry [1], e.g.: TCP UDP ICMP enum: - TCP - UDP - ICMP dscp: type: string description: | For IPv4 [7] a string of "0" and "1" digits that corresponds to the 6-bit Differentiated Services Code Point (DSCP) field of the IP header. For IPv6 [28] a string of "0" and "1" digits that corresponds to the 6 differentiated services bits of the traffic class header field sourcePortRange: description: | Indicates a range of source ports $ref: '#/definitions/PortRange' destinationPortRange: description: | Indicates a range of destination ports. $ref: '#/definitions/PortRange' sourceIpAddressPrefix: description: | Indicates the source IP address range in CIDR format. $ref: '#/definitions/IpAddressPrefix' destinationIpAddressPrefix: description: | Indicates the destination IP address range in CIDR format. $ref: '#/definitions/IpAddressPrefix' extendedCriteria: type: array description: | Indicates values of specific bits in a frame. items: $ref: '#/definitions/Mask' description: | The NfpRule data type is an expression of the conditions that shall be met in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and it is met only if all the values expressed in the condition are matched by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1. String: type: string description: | A string as defined in IETF RFC 8259. PortRange: type: object required: - lowerPort - upperPort properties: lowerPort: type: integer description: | Identifies the lower bound of the port range. upperPort Integer minimum: 0 upperPort: type: integer description: | Identifies the upper bound of the port range. minimum: 0 description: | The PortRange data type provides the lower and upper bounds of a range of Internet ports. It shall comply with the provisions defined in Table 6.5.3.42-1. IpAddressPrefix: type: string description: | An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12]. For IPV6 address range, refer to IETF RFC 4291. Mask: type: object required: - length - startingPoint - value properties: startingPoint: type: integer description: | Indicates the offset between the last bit of the source mac address and the first bit of the sequence of bits to be matched. length: type: integer description: | Indicates the number of bits to be matched. value: type: string description: | Provide the sequence of bit values to be matched. description: | The Mask data type identifies the value to be matched for a sequence of bits at a particular location in a frame. It shall comply with the provisions defined in Table 6.5.3.41-1. ChangeNsFlavourData: type: object required: - newNsFlavourId properties: newNsFlavourId: description: | Identifier of the new NS DF to apply to this NS instance. $ref: '#/definitions/IdentifierInNsd' instantiationLevelId: description: | Identifier of the instantiation level of the deployment flavour to be instantiated. If not present, the default instantiation level as declared in the NSD is instantiated. $ref: '#/definitions/IdentifierInNsd' description: | This type specifies an existing NS instance for which the DF needs to be changed. This specifies the new DF, the instantiationLevel of the new DF that may be used and the additional parameters as input for the flavour change. It shall comply with the provisions defined in Table 6.5.3.39-1. ModifyPnfData: type: object required: - pnfId properties: pnfId: description: | Identifier of the PNF. This identifier is allocated by the OSS/BSS. $ref: '#/definitions/Identifier' pnfName: type: string description: | Name of the PNF. cpData: type: array description: | Address assigned for the PNF external CP(s). items: $ref: '#/definitions/PnfExtCpData' description: | This type specifies an PNF to be modified in the NS instance. It shall comply with the provisions defined in Table 6.5.3.15-1. HealNsRequest: type: object properties: healNsData: description: | Provides the information needed to heal an NS. See note $ref: '#/definitions/HealNsData' healVnfData: type: array description: | Provides the information needed to heal a VNF. See note. items: $ref: '#/definitions/HealVnfData' description: | This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS instance, either by healing the complete NS instance or by healing one of more of the VNF instances that are part of this NS. It shall comply with the provisions defined in Table 6.5.2.13-1. Either the parameter healNsData or the parameter healVnfData, but not both shall be provided. HealNsData: type: object required: - degreeHealing properties: degreeHealing: type: string description: | Indicates the degree of healing. Possible values include: - HEAL_RESTORE: Complete the healing of the NS restoring the state of the NS before the failure occurred. Equivalent to Recreate - HEAL_QOS: Complete the healing of the NS based on the newest QoS values - HEAL_RESET: Complete the healing of the NS resetting to the original instantiation state of the NS Equivalent to Restart - PARTIAL_HEALING. enum: - HEAL_RESTORE - HEAL_QOS - HEAL_RESET - PARTIAL_HEALING actionsHealing: type: array description: | Used to specify dedicated healing actions in a particular order (e.g. as a script). The actionsHealing attribute can be used to provide a specific script whose content and actions might only be possible to be derived during runtime. items: $ref: '#/definitions/String' healScript: description: | Reference to a script from the NSD that shall be used to execute dedicated healing actions in a particular order. The healScript, since it refers to a script in the NSD, can be used to execute healing actions which are defined during NS design time. $ref: '#/definitions/IdentifierInNsd' additionalParamsforNs: description: | Allows the OSS/BSS to provide additional parameter(s) to the healing process at the NS level. $ref: '#/definitions/HealAdditionalParams' description: | This type represents the information used to heal a NS. It shall comply with the provisions defined in Table 6.5.3.43-1. HealAdditionalParams: type: object properties: lcmInterfaces: type: object example: lcmInterfaces: heal_start: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 heal_end: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 properties: {} healParam: type: object example: cause: error description: Svnfm heal properties properties: {} HealVnfData: type: object required: - vnfInstanceId properties: vnfInstanceId: description: | Identifies the VNF instance, part of the NS, requiring a healing action. $ref: '#/definitions/Identifier' cause: type: string description: | Indicates the reason why a healing procedure is required. additionalParams: description: | Additional parameters passed by the NFVO as input to the healing process, specific to the VNF being healed. EXAMPLE: Input parameters to VNF-specific healing procedures. $ref: '#/definitions/HealAdditionalParams' description: | This type represents the information to heal a VNF that is part of an NS. The NFVO shall then invoke the HealVNF operation towards the appropriate VNFM. It shall comply with the provisions defined in Table 6.5.3.44-1. TerminateNsRequest: type: object properties: terminationTime: description: | Timestamp indicating the end time of the NS, i.e. the NS will be terminated automatically at this timestamp. Cardinality "0" indicates the NS termination takes place immediately $ref: '#/definitions/DateTime' additionalParamsforNs: description: Extra parameters added to support cnf termination. $ref: '#/definitions/TerminateAdditionalParamsforNs' description: | This type represents a NS termination request. It shall comply with the provisions defined in Table 6.5.2.15-1. TerminateAdditionalParamsforNs: type: object properties: vnfLcmInterfaces: type: array items: $ref: '#/definitions/TerminateAdditionalParamsforNs_vnfLcmInterfaces' lcmInterfaces: type: object example: lcmInterfaces: terminate_start: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 terminate_end: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 description: lcmInterfaces for NS properties: {} NsLcmOpOcc: type: object required: - _links - id - isAutomaticInvocation - isCancelPending - lcmOperationType - nsInstanceId - operationState - startTime - stateEnteredTime properties: id: description: | Identifier of this NS lifecycle operation occurrence. $ref: '#/definitions/Identifier' operationState: description: | The state of the NS LCM operation. $ref: '#/definitions/NsLcmOperationStateType' stateEnteredTime: description: | Date-time when the current state has been entered. $ref: '#/definitions/DateTime' nsInstanceId: description: | Identifier of the NS instance to which the operation applies. $ref: '#/definitions/Identifier' lcmOperationType: description: | Type of the actual LCM operation represented by this lcm operation occurrence. $ref: '#/definitions/NsLcmOpType' startTime: description: | Date-time of the start of the operation. $ref: '#/definitions/DateTime' isAutomaticInvocation: type: boolean description: | Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise. operationParams: type: object description: | Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource. properties: {} isCancelPending: type: boolean description: | If the LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false. cancelMode: description: | The mode of an ongoing cancellation. Shall be present when isCancelPending=true, and shall be absent otherwise. $ref: '#/definitions/CancelModeType' error: description: | If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" is "PROCESSING" or "ROLLING_BACK" and previous value of "operationState" was "FAILED_TEMP", this attribute shall be present and contain error information, unless it has been requested to be excluded via an attribute selector. $ref: '#/definitions/ProblemDetails' resourceChanges: $ref: '#/definitions/NsLcmOpOcc_resourceChanges' _links: $ref: '#/definitions/NsLcmOpOcc__links' description: | This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1. NsLcmOperationStateType: type: string description: | The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible. enum: - PROCESSING - COMPLETED - FAILED_TEMP - FAILED - ROLLING_BACK - ROLLED_BACK NsLcmOpType: type: string description: | The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the "Instantiate NS" LCM operation. SCALE | Represents the "Scale NS" LCM operation. UPDATE | Represents the "Update NS" LCM operation. TERMINATE | Represents the "Terminate NS" LCM operation. HEAL | Represents the "Heal NS" LCM operation. enum: - INSTANTIATE - SCALE - UPDATE - TERMINATE - HEAL CancelModeType: type: string description: | Cancellation mode. The NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. The NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. enum: - GRACEFUL - FORCEFUL AffectedVnf: type: object required: - changeResult - changeType - vnfInstanceId - vnfName - vnfProfileId - vnfdId properties: vnfInstanceId: description: "Identifier of the VNF instance. \n" $ref: '#/definitions/Identifier' vnfdId: description: | Identifier of the VNFD of the VNF Instance. $ref: '#/definitions/Identifier' vnfProfileId: description: | Identifier of the VNF profile of the NSD. $ref: '#/definitions/IdentifierInNsd' vnfName: type: string description: | Name of the VNF Instance. changeType: type: string description: | Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY enum: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY changeResult: type: string description: | Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED enum: - COMPLETED - ROLLED_BACK - FAILED changedInfo: $ref: '#/definitions/AffectedVnf_changedInfo' description: | This type provides information about added, deleted and modified VNFs. It shall comply with the provisions in Table 6.5.3.2-1. AffectedPnf: type: object required: - cpInstanceId - pnfId - pnfProfileId - pnfdId properties: pnfId: description: | Identifier of the affected PNF. This identifier is allocated by the OSS/BSS. $ref: '#/definitions/Identifier' pnfdId: description: | Identifier of the PNFD on which the PNF is based. $ref: '#/definitions/IdentifierInNsd' pnfProfileId: description: | Identifier of the VNF profile of the NSD. $ref: '#/definitions/IdentifierInNsd' pnfName: type: string description: | Name of the PNF. cpInstanceId: type: array description: | Identifier of the CP in the scope of the PNF. items: $ref: '#/definitions/IdentifierInPnf' changeType: type: string description: | Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY enum: - ADD - REMOVE - MODIFY changeResult: type: string description: | Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED enum: - COMPLETED - ROLLED_BACK - FAILED description: | This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1. AffectedVirtualLink: type: object required: - changeType - id - networkResource - virtualLinkDescId properties: id: description: | Identifier of the virtual link instance, identifying the applicable "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. $ref: '#/definitions/IdentifierInVnf' virtualLinkDescId: description: | Identifier of the related VLD in the VNFD. $ref: '#/definitions/IdentifierInVnfd' changeType: type: string description: | Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists. enum: - ADDED - REMOVED - MODIFIED - TEMPORARY - LINK_PORT_ADDED - LINK_PORT_REMOVED networkResource: description: | Reference to the VirtualNetwork resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. $ref: '#/definitions/ResourceHandle' metadata: description: | Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the VnfVirtualLinkResourceInfo structure. $ref: '#/definitions/KeyValuePairs' description: | This type provides information about added, deleted, modified and temporary VLs. AffectedVnffg: type: object required: - vnffgInstanceId - vnffgdId properties: vnffgInstanceId: description: | Identifier of the VNFFG instance. $ref: '#/definitions/IdentifierInNs' vnffgdId: description: | Identifier of the VNFFGD of the VNFFG instance. $ref: '#/definitions/IdentifierInNsd' changeType: type: string description: | Signals the type of change. Permitted values: - ADD - DELETE - MODIFY enum: - ADD - DELETE - MODIFY changeResult: type: string description: | Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED enum: - COMPLETED - ROLLED_BACK - FAILED description: | This type provides information about added, deleted and modified VNFFG instances. It shall comply with the provisions in Table 6.5.3.5-1. AffectedNs: type: object required: - changeResult - changeType - nsInstanceId - nsdId properties: nsInstanceId: description: | Identifier of the nested NS instance. $ref: '#/definitions/Identifier' nsdId: description: | Identifier of the NSD of the nested NS instance. $ref: '#/definitions/Identifier' changeType: type: string description: | Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE enum: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE changeResult: type: string description: | Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED enum: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED description: | This type provides information about added, deleted and modified nested NSs. It shall comply with the provisions in Table 6.5.3.6-1. AffectedSap: type: object required: - sapInstanceId - sapdId properties: sapInstanceId: description: | Identifier of the nested NS instance. $ref: '#/definitions/Identifier' sapdId: description: | Identifier of the NSD of the nested NS instance. $ref: '#/definitions/Identifier' sapName: type: string description: | Human readable name for the SAP. changeType: type: string description: | Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY enum: - ADD - REMOVE - MODIFY changeResult: type: string description: | Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED enum: - COMPLETED - ROLLED_BACK - FAILED description: | This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1. LccnSubscription: type: object required: - _links - callbackUri - id properties: id: description: | Identifier of this subscription resource. $ref: '#/definitions/Identifier' filter: description: | Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: '#/definitions/LifecycleChangeNotificationsFilter' callbackUri: description: | The URI of the endpoint to send the notification to. $ref: '#/definitions/Uri' _links: $ref: '#/definitions/LccnSubscription__links' description: | This type represents a subscription related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.4-1. LifecycleChangeNotificationsFilter: type: object properties: nsInstanceSubscriptionFilter: description: | Filter criteria to select NS instances about which to notify. $ref: '#/definitions/NsInstanceSubscriptionFilter' notificationTypes: type: array description: | Match particular notification types. Permitted values: - NsLcmOperationOccurenceNotification - NsIdentifierCreationNotification - NsIdentifierDeletionNotification - NsChangeNotification items: type: string operationTypes: type: array description: | Match particular NS lifecycle operation types for the notification of type NsLcmOperationOccurrenceNotification. May be present if the "notificationTypes" attribute contains the value "NsLcmOperationOccurrenceNotification", and shall be absent otherwise. items: $ref: '#/definitions/NsLcmOpType' operationStates: type: array description: | Match particular LCM operation state values as reported in notifications of type NsLcmOperationOccurrenceNotification. May be present if the "notificationTypes" attribute contains the value "NsLcmOperationOccurrenceNotification", and shall be absent otherwise. items: $ref: '#/definitions/LcmOperationStateType' nsComponentTypes: type: array description: | Match particular NS component types for the notification of type NsChangeNotification. May be present if the "notificationTypes" attribute contains the value "NsChang. items: $ref: '#/definitions/NsComponentType' lcmOpNameImpactingNsComponent: type: array description: | Match particular LCM operation names for the notification of type NsChangeNotification. May be present if the "notificationTypes" attribute contains the value "NsChangeNotification", and shall be absent otherwise. items: $ref: '#/definitions/LcmOpNameForChangeNotificationType' lcmOpOccStatusImpactingNsComponent: type: array description: | Match particular LCM operation status values as reported in notifications of type NsChangeNotification. May be present if the "notificationTypes" attribute contains the value "NsChangeNotification", and shall be absent otherwise. items: $ref: '#/definitions/LcmOpOccStatusForChangeNotificationType' description: | This type represents a subscription filter related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.3.8-1. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NsInstanceSubscriptionFilter: type: object properties: nsdIds: type: array description: | If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute. items: $ref: '#/definitions/Identifier' vnfdIds: type: array description: | If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. items: $ref: '#/definitions/Identifier' pnfdIds: type: array description: | If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute. items: $ref: '#/definitions/Identifier' nsInstanceIds: type: array description: | If present, match NS instances with an instance identifier listed in this attribute. items: $ref: '#/definitions/Identifier' nsInstanceNames: type: array description: | If present, match NS instances with a NS Instance Name listed in this attribute. items: $ref: '#/definitions/String' description: | This type represents subscription filter criteria to match NS instances. NOTE 1: The attributes "nsdIds", "vnfdIds" and "pnfdIds" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen. NOTE 2: The attributes "nsInstanceIds" and "nsInstanceNames" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. LcmOperationStateType: type: string description: | Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible. enum: - PROCESSING - COMPLETED - PARTIALLY_COMPLETED - FAILED_TEMP - FAILED - ROLLING_BACK - ROLLED_BACK NsComponentType: type: string description: | The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1. Value | Description ------|------------ VNF | Represents the impacted NS component is a VNF. PNF | Represents the impacted NS component is a PNF. NS | Represents the impacted NS component is a nested NS. enum: - VNF - PNF - NS LcmOpNameForChangeNotificationType: type: string description: | The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. Value | Description ------|------------ VNF_INSTANTIATE | Represents the "Instantiate VNF" LCM operation. VNF_SCALE | Represents the "Scale VNF" LCM operation. VNF_SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation. VNF_CHANGE_FLAVOUR | Represents the "Change VNF Flavor" LCM operation. VNF_TERMINATE | Represents the "Terminate VNF" LCM operation. VNF_HEAL | Represents the "Heal VNF" LCM operation. VNF_OPERATE | Represents the "Operate VNF" LCM operation. VNF_CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation. VNF_MODIFY_INFO | Represents the "Modify VNF Information" LCM operation. NS_INSTANTIATE | Represents the "Instantiate NS" LCM operation NS_SCALE | Represents the "Scale NS" LCM operation. NS_UPDATE | Represents the "Update NS" LCM operation. NS_TERMINATE | Represents the "Terminate NS" LCM operation. NS_HEAL | Represents the "Heal NS" LCM operation. enum: - VNF_INSTANTIATE - VNF_SCALE - VNF_SCALE_TO_LEVEL - VNF_CHANGE_FLAVOUR - VNF_TERMINATE - VNF_HEAL - VNF_OPERATE - VNF_CHANGE_EXT_CONN - VNF_MODIFY_INFO - NS_INSTANTIATE - NS_SCALE - NS_UPDATE - NS_TERMINATE - NS_HEAL LcmOpOccStatusForChangeNotificationType: type: string description: | The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the provisions defined in Table 6.5.4.7-1. Value | Description ------|------------ START | The impact on the NS component is identified. COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully. PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component. FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component. ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back. enum: - START - COMPLETED - PARTIALLY_COMPLETED - FAILED - ROLLED_BACK Uri: type: string format: uri description: | String formatted according to IETF RFC 3986. LccnSubscriptionRequest: type: object required: - callbackUri properties: filter: description: | Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: '#/definitions/LifecycleChangeNotificationsFilter' callbackUri: description: | The URI of the endpoint to send the notification to. $ref: '#/definitions/Uri' authentication: description: | Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: '#/definitions/SubscriptionAuthentication' description: | This type represents a subscription request related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.2-1.. SubscriptionAuthentication: type: object required: - authType properties: authType: type: array description: | Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: - BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. - OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type. - TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup. items: type: string paramsBasic: $ref: '#/definitions/SubscriptionAuthentication_paramsBasic' paramsOauth2ClientCredentials: $ref: '#/definitions/SubscriptionAuthentication_paramsOauth2ClientCredentials' inline_response_200: type: object properties: NsInstance: $ref: '#/definitions/NsInstance' inline_response_200_1: type: object properties: NsLcmOpOcc: $ref: '#/definitions/NsLcmOpOcc' NsInstance__links: type: object required: - self properties: self: description: | URI of this resource. $ref: '#/definitions/Link' nestedNsInstances: type: array description: | Links to resources related to this notification. items: $ref: '#/definitions/Link' instantiate: description: | Link to the "instantiate" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance in NOT_INSTANTIATED state). $ref: '#/definitions/Link' terminate: description: | Link to the "terminate" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). $ref: '#/definitions/Link' update: description: | Link to the "update" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). $ref: '#/definitions/Link' scale: description: | Link to the "scale" task resource, if the related operation is supported for this NS instance, and is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). $ref: '#/definitions/Link' heal: description: | Link to the "heal" task resource, if the related operation is supported for this NS instance, and is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). $ref: '#/definitions/Link' description: Links to resources related to this resource. VnfInstance_instantiatedVnfInfo: type: object required: - extCpInfo - flavourId - vnfState properties: flavourId: description: | Identifier of the VNF deployment flavor applied to this VNF instance. $ref: '#/definitions/IdentifierInVnfd' vnfState: description: | The state of the VNF instance. $ref: '#/definitions/VnfOperationalStateType' scaleStatus: type: array description: | Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. items: $ref: '#/definitions/VnfScaleInfo' maxScaleLevels: type: array description: | Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling. items: $ref: '#/definitions/VnfScaleInfo' extCpInfo: type: array description: | Information about the external CPs exposed by the VNF instance. items: $ref: '#/definitions/VnfExtCpInfo' minItems: 1 extVirtualLinkInfo: type: array description: | Information about the external VLs the VNF instance is connected to. items: $ref: '#/definitions/ExtVirtualLinkInfo' extManagedVirtualLinkInfo: type: array description: | External virtual links the VNF instance is connected to. items: $ref: '#/definitions/ExtManagedVirtualLinkInfo' monitoringParameters: type: array description: | Performance metrics tracked by the VNFM (e.g. for auto-scaling purposes) as identified by the VNF provider in the VNFD. items: $ref: '#/definitions/VnfMonitoringParameter' localizationLanguage: type: string description: | Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646. vnfcResourceInfo: type: array description: | Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance. items: $ref: '#/definitions/VnfcResourceInfo' virtualLinkResourceInfo: type: array description: | Information about the virtualised network resources used by the VLs of the VNF instance. items: $ref: '#/definitions/VnfVirtualLinkResourceInfo' virtualStorageResourceInfo: type: array description: | Information on the virtualised storage resource(s) used as storage for the VNF instance. items: $ref: '#/definitions/VirtualStorageResourceInfo' description: | Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED. IpOverEthernetAddressInfo_addressRange: type: object required: - maxAddress - minAddress properties: minAddress: description: | Lowest IP address belonging to the range. $ref: '#/definitions/IpAddress' maxAddress: description: | Highest IP address belonging to the range $ref: '#/definitions/IpAddress' description: | An IP address range used, e.g., in case of egress connections. Exactly one of "addresses" or "addressRange" shall be present. IpOverEthernetAddressInfo_ipAddresses: type: object required: - type properties: type: type: string description: | The type of the IP addresses. Permitted values: IPV4, IPV6. enum: - IPV4 - IPV6 addresses: type: array description: | Fixed addresses assigned (from the subnet defined by "subnetId" if provided). items: $ref: '#/definitions/IpAddress' isDynamic: type: boolean description: | Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if "addresses" is present and shall be absent otherwise. addressRange: $ref: '#/definitions/IpOverEthernetAddressInfo_addressRange' subnetId: description: | Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses are bound to that subnet. $ref: '#/definitions/IdentifierInVim' IpOverEthernetAddressInfo_addressRange_1: type: object required: - maxAddress - minAddress properties: minAddress: description: | Lowest IP address belonging to the range. $ref: '#/definitions/IpAddress' maxAddress: description: | Highest IP address belonging to the range $ref: '#/definitions/IpAddress' description: | An IP address range used, e.g. in case of egress connections. See note. VnfcResourceInfo_vnfcCpInfo: type: object required: - cpdId - id properties: id: description: | Identifier of this VNFC CP instance and the associated array entry. $ref: '#/definitions/IdentifierInVnf' cpdId: description: | Identifier of the VDU CPD, cpdId, in the VNFD. $ref: '#/definitions/IdentifierInVnfd' vnfExtCpId: description: | When the VNFC CP is exposed as external CP of the VNF, the identifier of this external VNF CP. $ref: '#/definitions/IdentifierInVnf' cpProtocolInfo: type: array description: | Network protocol information for this CP. items: $ref: '#/definitions/CpProtocolInfo' vnfLinkPortId: description: | Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if the CP is associated to a link port. $ref: '#/definitions/IdentifierInVnf' metadata: description: | Metadata about this CP. $ref: '#/definitions/KeyValuePairs' VnfInstanceExtensions_managedBy: type: object properties: extensionSubtype: type: string extensionName: type: string VnfInstanceExtensions_networks: type: object properties: resourceId: type: string networkName: type: string vl_id: type: string key_name: type: string IpOverEthernetAddressData_addressRange: type: object required: - maxAddress - minAddress properties: minAddress: description: | Lowest IP address belonging to the range. $ref: '#/definitions/IpAddress' maxAddress: description: | Highest IP address belonging to the range. $ref: '#/definitions/IpAddress' description: | An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used. IpOverEthernetAddressData_ipAddresses: type: object required: - type properties: type: type: string description: | The type of the IP addresses. Permitted values: IPV4, IPV6. enum: - IPV4 - IPV6 fixedAddresses: type: array description: | Fixed addresses to assign (from the subnet defined by "subnetId" if provided). Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present. items: $ref: '#/definitions/IpAddress' numDynamicAddresses: type: integer description: | Number of dynamic addresses to assign (from the subnet defined by "subnetId" if provided). Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present. addressRange: $ref: '#/definitions/IpOverEthernetAddressData_addressRange' subnetId: description: | Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses from that subnet will be assigned; otherwise, IP addresses not bound to a subnet will be assigned. $ref: '#/definitions/IdentifierInVim' LocationConstraints_civicAddressElement: type: object required: - caType - caValue properties: caType: type: integer description: | Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13]. caValue: type: string description: | Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13]. TerminateAdditionalParamsforNs_vnfLcmInterfaces: type: object properties: vnfId: type: string lcmInterfaces: type: object example: lcmInterfaces: terminate_start: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 terminate_end: - name: USER type: string value: root - name: PWD type: password value: pass - name: HOSTNAME type: string value: 10.176.160.54 - name: CMD type: string value: uptime - name: VIM_LOCATION type: location value: vmware_641917F756584A7FA21F455F775D5F66 description: lcmInterfaces for NF properties: {} NsLcmOpOcc_resourceChanges: type: object properties: affectedVnfs: type: array description: | Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. items: $ref: '#/definitions/AffectedVnf' affectedPnfs: type: array description: | Information about the PNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. items: $ref: '#/definitions/AffectedPnf' affectedVls: type: array description: | Information about the VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. items: $ref: '#/definitions/AffectedVirtualLink' affectedVnffgs: type: array description: | Information about the VNFFG instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note items: $ref: '#/definitions/AffectedVnffg' affectedNss: type: array description: | Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note. items: $ref: '#/definitions/AffectedNs' affectedSaps: type: array description: | Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note. items: $ref: '#/definitions/AffectedSap' description: | This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable NsLcmOpOcc__links: type: object required: - nsInstance - self properties: self: description: | URI of this resource. $ref: '#/definitions/Link' nsInstance: description: | Link to the NS instance that the operation applies to. $ref: '#/definitions/Link' cancel: description: | Link to the task resource that represents the "cancel" operation for this LCM operation occurrence, if cancelling is currently allowed. $ref: '#/definitions/Link' retry: description: | Link to the task resource that represents the "cancel" operation for this LCM operation occurrence, if cancelling is currently allowed. $ref: '#/definitions/Link' rollback: description: | Link to the task resource that represents the "rollback" operation for this LCM operation occurrence, if rolling back is currently allowed. $ref: '#/definitions/Link' continue: description: | Link to the task resource that represents the "continue" operation for this LCM operation occurrence, if rolling back is currently allowed. $ref: '#/definitions/Link' fail: description: | Link to the task resource that represents the "fail" operation for this LCM operation occurrence, if rolling back is currently allowed. $ref: '#/definitions/Link' description: | Links to resources related to this resource. AffectedVnf_changedInfo: type: object properties: changedVnfInfo: description: | Information about the changed VNF instance information, including configurable properties, if applicable. $ref: '#/definitions/ModifyVnfInfoData' changedExtConnectivity: description: | Information about changed external connectivity, if applicable. $ref: '#/definitions/ExtVirtualLinkInfo' description: | Information about the changed VNF instance information, including VNF configurable properties,if applicable. When the "changedInfo" attribute is present, either the "changedVnfInfo" attribute or the "changedExtConnectivity" attribute or both shall be present. LccnSubscription__links: type: object required: - self properties: self: description: | URI of this resource. $ref: '#/definitions/Link' description: | Links to resources related to this resource. SubscriptionAuthentication_paramsBasic: type: object properties: userName: type: string description: | Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. password: type: string description: | Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. description: | Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise. SubscriptionAuthentication_paramsOauth2ClientCredentials: type: object properties: clientId: type: string description: | Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. clientPassword: type: string description: | Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. tokenEndpoint: description: | The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. $ref: '#/definitions/Uri' description: | Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise. externalDocs: description: ETSI GS NFV-SOL 005 V2.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf