openapi: 3.0.2 info: title: SOL003 - VNF Performance Management interface description: | SOL003 - VNF Performance Management interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues contact: name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 003 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf servers: - url: http://127.0.0.1/vnfpm/v2 - url: https://127.0.0.1/vnfpm/v2 paths: ############################################################################### # API Versions # ############################################################################### /api-versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # PM jobs # ############################################################################### /pm_jobs: #SOL003 location: 6.4.2 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | The POST method creates a PM job. See clause 6.4.2.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/CreatePmJobRequest' responses: 201: $ref: '#/components/responses/PmJobs.Post.201' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: '#/components/responses/PmJobs.Post.422' 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: description: | The API consumer can use this method to retrieve information about PM jobs. See clause 6.4.2.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: $ref: '#/components/responses/PmJobs.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual PM job # ############################################################################### /pm_jobs/{pmJobId}: #SOL003 location: 6.4.3 parameters: - $ref: '#/components/parameters/PmJobId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | The API consumer can use this method for reading an individual PM job. See clause 6.4.3.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: $ref: '#/components/responses/IndividualPmJob.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" patch: description: | This method allows to modify an "Individual PM job" resource. See clause 6.4.3.3.4. responses: 200: $ref: '#/components/responses/IndividualPmJob.Patch.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 412: $ref: '#/components/responses/IndividualPmJob.Patch.412' 422: $ref: '#/components/responses/IndividualPmJob.Patch.422' 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: description: | This method terminates an individual PM job. See clause 6.4.3.3.5. responses: 204: $ref: '#/components/responses/IndividualPmJob.Delete.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual performance report # ############################################################################### /pm_jobs/{pmJobId}/reports/{reportId}: #SOL003 location: 6.4.4 parameters: - $ref: '#/components/parameters/PmJobId' - $ref: '#/components/parameters/ReportId' get: description: | The API consumer can use this method for reading an individual performance report. See clause 6.4.4.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: $ref: '#/components/responses/IndividualPerformanceReport.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Thresholds # ############################################################################### /thresholds: #SOL003 location: 6.4.5 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: description: | The POST method can be used by the API consumer to create a threshold. See clause 6.4.5.3.1. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/CreateThresholdRequest' responses: 201: $ref: '#/components/responses/Thresholds.Post.201' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: '#/components/responses/Thresholds.Post.422' 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: description: | The API consumer can use this method to query information about thresholds. See clause 6.4.5.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: $ref: '#/components/responses/Thresholds.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual threshold # ############################################################################### /thresholds/{thresholdId}: #SOL003 location: 6.4.6 parameters: - $ref: '#/components/parameters/ThresholdId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: description: | The API consumer can use this method for reading an individual threshold. See clause 6.4.6.3.2. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: $ref: '#/components/responses/IndividualThreshold.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" patch: description: | This method allows to modify an "Individual threshold" resource. See clause 6.4.6.3.4. responses: 200: $ref: '#/components/responses/IndividualThreshold.Patch.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 412: $ref: '#/components/responses/IndividualThreshold.Patch.412' 422: $ref: '#/components/responses/IndividualThreshold.Patch.422' 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: description: | This method allows to delete a threshold. See clause 6.4.6.3.5. responses: 204: $ref: '#/components/responses/IndividualThreshold.Delete.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" components: parameters: PmJobId: name: pmJobId in: path description: | Identifier of the PM job. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual PM job" resource. It can also be retrieved from the "id" attribute in the payload body of that response. required: true style: simple explode: false schema: type: string ReportId: name: reportId in: path description: | Identifier of the performance report. required: true style: simple explode: false schema: type: string ThresholdId: name: thresholdId in: path description: | Identifier of the threshold. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual threshold" resource. It can also be retrieved from the "id" attribute in the payload body of that response. required: true style: simple explode: false schema: type: string requestBodies: CreatePmJobRequest: description: The VNF creation parameters content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest" required: true CreateThresholdRequest: description: Request parameters to create a threshold resource. content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest" required: true responses: PmJobs.Post.201: description: | 201 CREATED Shall be returned when the PM job has been created successfully. The response body shall contain a representation of the created "Individual PM job" resource, as defined in clause 6.5.2.7. The HTTP response shall include a "Location" HTTP header that points to the created "Individual PM job" resource. headers: Location: description: The resource URI of the created PM Job style: simple explode: false schema: type: string format: url WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" PmJobs.Post.422: description: | 422 Unprocessable Entity Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [8], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested the Notification endpoint as described in clause 6.4.9.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure sh headers: Location: description: The resource URI of the created PM Job style: simple explode: false schema: type: string format: url WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" PmJobs.Get.200: description: | 200 OK Shall be returned when information about zero or more PM jobs has been queried successfully. The response body shall contain in an array the representations of zero or more PM jobs, as defined in clause 6.5.2.7. 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, respectively. If the VNFM supports alternative 2 (paging) according to clause 5.4..2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" IndividualPmJob.Get.200: description: | 200 OK Shall be returned when information about an individual PM job has been read successfully. The response body shall contain a representation of the "Individual PM job" resource, as defined in clause 6.5.2.7. headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" IndividualPmJob.Patch.200: description: | 200 OK Shall be returned when the request has been processed successfully. The response body shall contain a data structure of type "PmJobModifications". headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications" IndividualPmJob.Patch.412: description: | 412 Precondition Failed Shall be returned upon the following 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: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string IndividualPmJob.Patch.422: description: | 422 Unprocessable Entity Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [8], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested the Notification endpoint as described in clause 6.4.9.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error. headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" IndividualPmJob.Delete.200: description: | 204 NO CONTENT Shall be returned when the PM job has been deleted successfully. The response body shall be empty. headers: WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string IndividualPerformanceReport.Get.200: description: | 200 OK Shall be returned when information of an individual performance report has been read successfully. The response body shall contain a representation of the "Individual performance report" resource, as defined in clause 6.5.2.10. headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport" Thresholds.Post.201: description: | 201 CREATED Shall be returned when a threshold has been created successfully. The response body shall contain a representation of the created "Individual threshold" resource, as defined in clause 6.5.2.9. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created threshold resource. headers: Location: description: TThe resource URI of the created VNF instance style: simple explode: false schema: type: string format: url Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" Thresholds.Post.422: description: | 422 Unprocessable Entity Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [8], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested the Notification endpoint as described in clause 6.4.9.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error headers: Location: description: TThe resource URI of the created VNF instance style: simple explode: false schema: type: string format: url Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" Thresholds.Get.200: description: | 200 OK Shall be returned when information about zero or more thresholds has been queried successfully. 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. The response body shall contain in an array the representations of zero or more thresholds, as defined in clause 6.5.2.9. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Location: description: The resource URI of the created VNF instance style: simple explode: false schema: type: string format: url Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" IndividualThreshold.Get.200: description: | 200 OK Shall be returned when information about an individual threshold has been read successfully. The response body shall contain a representation of the threshold, as defined in clause 6.5.2.9. headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" IndividualThreshold.Patch.200: description: | 200 OK Shall be returned when the request has been processed successfully. The response body shall contain a data structure of type "ThresholdModifications". headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications" IndividualThreshold.Patch.412: description: | 412 Precondition Failed Shall be returned upon the following 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: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string IndividualThreshold.Patch.422: description: | 422 Unprocessable entity Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [8], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested the Notification endpoint as described in clause 6.4.9.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error headers: Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string content: application/json: schema: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" IndividualThreshold.Delete.200: description: | 204 NO CONTENT The threshold was deleted successfully. The response body shall be empty. headers: WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string