From 2bc82978a48b80b8a8ac714e8652dd24c4dd082d Mon Sep 17 00:00:00 2001
From: mxzhao <mengxuan.zhao@eglobalmark.com>
Date: Fri, 23 Nov 2018 18:23:33 +0100
Subject: [PATCH] Update on SOL002 VNFFaultManagement-API,
VNFLifecycleManagement-API
---
.../VNFFaultManagement-API_egm/Alarms.robot | 84 +
.../EscalatePerceivedSeverityTask.robot | 52 +
.../IndividualAlarm.robot | 115 +
.../IndividualSubscription.robot | 69 +
.../NotificationEndpoint.robot | 90 +
.../SOL002-VNFFaultManagement-API.json | 4257 ++
.../SOL002-VNFFaultManagement-API.yaml | 6539 +++
.../Subscriptions.robot | 122 +
.../jsons/alarmModifications.json | 3 +
.../jsons/fmSubscriptionRequest.json | 10 +
.../schemas/alarm.schema.json | 187 +
.../alarmClearedNotification.schema.json | 80 +
.../alarmListRebuiltNotification.schema.json | 71 +
.../schemas/alarmModifications.schema.json | 16 +
.../schemas/alarmNotification.schema.json | 250 +
.../perceivedSeverityRequest.schema.json | 11 +
.../schemas/problemDetails.schema.json | 34 +
.../schemas/subscriptions.schema.json | 84 +
.../VNFFaultManagement-API_egm/variables.txt | 42 +
.../CancelOperationTask.robot | 130 +
.../ChangeExternalVNFConnectivityTask.robot | 89 +
.../ChangeVNFFlavourTask.robot | 145 +
.../FailOperationTask.robot | 132 +
.../HealVNFTask.robot | 144 +
.../IndividualSubscription.robot | 66 +
.../IndividualVNFInstance.robot | 166 +
.../IndividualVnfLcmOperationOccurence.robot | 62 +
.../InstantiateVNFTask.robot | 90 +
.../NotificationEndpoint.robot | 90 +
.../OperateVNFTask.robot | 145 +
.../RetryOperationTask.robot | 132 +
.../RollbackOperationTask.robot | 132 +
.../SOL002-VNFLifecycleManagement-API.json | 24199 +++++++++++
.../SOL002-VNFLifecycleManagement-API.yaml | 33496 ++++++++++++++++
.../ScaleVNFTask.robot | 142 +
.../ScaleVNFToLevelTask.robot | 146 +
.../Subscriptions.robot | 124 +
.../TerminateVNFTask.robot | 124 +
.../VNFInstances.robot | 101 +
.../VnfLcmOperationOccurences.robot | 80 +
.../changeExtVnfConnectivityRequest.json | 65 +
.../jsons/changeVnfFlavourRequest.json | 3 +
.../jsons/createVnfRequest.json | 5 +
.../jsons/healVnfRequest.json | 4 +
.../jsons/instantiateVnfRequest.json | 77 +
.../jsons/lccnSubscriptionRequest.json | 10 +
.../jsons/operateVnfRequest.json | 5 +
.../jsons/patchBodyRequest.json | 4 +
.../jsons/scaleVnfRequest.json | 4 +
.../jsons/scaleVnfToLevelRequest.json | 3 +
.../jsons/terminateVnfRequest.json | 4 +
...IdentifierCreationNotification.schema.json | 0
.../schemas/problemDetails.schema.json | 34 +
.../schemas/subscriptions.schema.json | 181 +
...IdentifierDeletionNotification.schema.json | 0
.../schemas/vnfInstance.schema.json | 985 +
.../schemas/vnfLcmOpOcc.schema.json | 632 +
...perationOccurrenceNotification.schema.json | 0
.../variables.txt | 38 +
TrackingStatus.txt | 29 +-
60 files changed, 74132 insertions(+), 2 deletions(-)
create mode 100644 SOL002/VNFFaultManagement-API_egm/Alarms.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/EscalatePerceivedSeverityTask.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/IndividualAlarm.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/IndividualSubscription.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/NotificationEndpoint.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.yaml
create mode 100644 SOL002/VNFFaultManagement-API_egm/Subscriptions.robot
create mode 100644 SOL002/VNFFaultManagement-API_egm/jsons/alarmModifications.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/jsons/fmSubscriptionRequest.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/alarm.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/alarmClearedNotification.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/alarmListRebuiltNotification.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/alarmModifications.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/alarmNotification.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/perceivedSeverityRequest.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/problemDetails.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/schemas/subscriptions.schema.json
create mode 100644 SOL002/VNFFaultManagement-API_egm/variables.txt
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/CancelOperationTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/ChangeExternalVNFConnectivityTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/ChangeVNFFlavourTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/FailOperationTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/HealVNFTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/IndividualSubscription.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/IndividualVNFInstance.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/IndividualVnfLcmOperationOccurence.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/InstantiateVNFTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/NotificationEndpoint.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/OperateVNFTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/RetryOperationTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/RollbackOperationTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.yaml
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/ScaleVNFTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/ScaleVNFToLevelTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/Subscriptions.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/TerminateVNFTask.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/VNFInstances.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/VnfLcmOperationOccurences.robot
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/changeExtVnfConnectivityRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/changeVnfFlavourRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/createVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/healVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/instantiateVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/lccnSubscriptionRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/operateVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/patchBodyRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfToLevelRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/jsons/terminateVnfRequest.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/VnfIdentifierCreationNotification.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/problemDetails.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/subscriptions.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/vnfIdentifierDeletionNotification.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/vnfInstance.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOpOcc.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOperationOccurrenceNotification.schema.json
create mode 100644 SOL002/VNFLifecycleManagement-API_egm/variables.txt
diff --git a/SOL002/VNFFaultManagement-API_egm/Alarms.robot b/SOL002/VNFFaultManagement-API_egm/Alarms.robot
new file mode 100644
index 00000000..b5a02f9e
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/Alarms.robot
@@ -0,0 +1,84 @@
+*** Settings ***
+# Suite setup Expect spec SOL003-VNFLifecycleManagement-API.yaml
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFFaultManagement-API.yaml
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Library OperatingSystem
+
+*** Test cases ***
+POST Alarms - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/alarms
+ Log Validate Status code
+ Integer response status 405
+
+Get information about multiple alarms
+ Log Query VNF The GET method queries information about multiple alarms.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json alarm.schema.json ${json}
+ Log Validation OK
+
+Get information about multiple alarms with filters
+ Log Query VNF The GET method queries information about multiple alarms with filters.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms?${alarm_filter}=${managedObjectId}
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json alarm.schema.json ${json}
+ Log Validation OK
+
+Get information about multiple alarms Bad Request Invalid attribute-based filtering parameters
+ Log Query VNF The GET method queries information about multiple alarm instances.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms?${invalid_alarm_filter}=${managedObjectId}
+ Log Validate Status code
+ Integer response status 400
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PUT Alarms - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/alarms
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Alarms - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/alarms
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Alarms - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/alarms
+ Log Validate Status code
+ Integer response status 405
+
diff --git a/SOL002/VNFFaultManagement-API_egm/EscalatePerceivedSeverityTask.robot b/SOL002/VNFFaultManagement-API_egm/EscalatePerceivedSeverityTask.robot
new file mode 100644
index 00000000..5e0459d5
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/EscalatePerceivedSeverityTask.robot
@@ -0,0 +1,52 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFFaultManagement-API.yaml
+Suite setup Check resource existance
+
+*** Test Cases ***
+Escalate the perceived severity
+ [Documentation] escalate the perceived severity of an alarm with the VNFM
+ Log escalate the perceived severity of an alarm with the VNFM
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}/escalate ${PerceivedSeverity}
+ Integer response status 204
+ Log Status code validated
+
+GET Escalate the perceived severity - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}/escalate
+ Log Validate Status code
+ Integer response status 405
+
+PUT Escalate the perceived severity - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}/escalate
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Escalate the perceived severity - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}/escalate
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Escalate the perceived severity - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}/escalate
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}
+ Integer response status 200
diff --git a/SOL002/VNFFaultManagement-API_egm/IndividualAlarm.robot b/SOL002/VNFFaultManagement-API_egm/IndividualAlarm.robot
new file mode 100644
index 00000000..74bc65e7
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/IndividualAlarm.robot
@@ -0,0 +1,115 @@
+*** Settings ***
+# Suite setup Expect spec SOL003-VNFLifecycleManagement-API.yaml
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFFaultManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Library DependencyLibrary
+
+*** Variables ***
+${Etag}= an etag
+${Etag_modified}= a modified etag
+
+*** Test cases ***
+POST Alarm - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+Get information about an alarm
+ Log Query VNF The GET method queries information about multiple alarms.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}
+ ${Etag}= Output response headers Etag
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json alarm.schema.json ${json}
+ Log Validation OK
+
+PUT Alarm - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH Alarm
+ [Documentation] This method modifies an individual alarm resource
+ log Trying to perform a PATCH. This method modifies an individual alarm resource
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/alarmModifications.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId} ${body}
+ Log Validate Status code
+ ${Etag_modified}= Output response headers Etag
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json alarmModifications.schema.json ${json}
+ Log Validation OK
+
+PATCH Alarm - Conflict
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the “Individual alarm” resource.
+ ... Typically, this is due to the fact that the alarm is already in the state that is requested to be set (such as trying to acknowledge an already-acknowledged alarm).
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ Depends On Test PATCH Alarm # If the previous test scceeded, it means that the alarm is in ackownledged state
+ log Trying to perform a PATCH. This method modifies an individual alarm resource
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/alarmModifications.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId} ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PATCH Alarm - Precondition failed
+ [Documentation] Precondition Failed
+ ... 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.
+ Depends On Test PATCH Alarm # If the previous test scceeded, it means that Etag has been modified
+ log Trying to perform a PATCH. This method modifies an individual alarm resource
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Set Headers {"If-Match": "${Etag}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/alarmModifications.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId} ${body}
+ Log Validate Status code
+ Integer response status 412
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+DELETE Alarm - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/alarms/${alarmId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
diff --git a/SOL002/VNFFaultManagement-API_egm/IndividualSubscription.robot b/SOL002/VNFFaultManagement-API_egm/IndividualSubscription.robot
new file mode 100644
index 00000000..e07c7f66
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/IndividualSubscription.robot
@@ -0,0 +1,69 @@
+*** Settings ***
+Resource variables.txt
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFFaultManagement-API.yaml
+Documentation This resource represents an individual subscription for VNF alarms.
+... The client can use this resource to read and to terminate a subscription to notifications related to VNF fault management.
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Individual Subscription - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+Get Information about an individual subscription
+ log Trying to get information about an individual subscription
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+PUT an individual subscription - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH an individual subscription - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+DELETE an individual subscription
+ log Try to delete an individual subscription
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Output response
+ Integer response status 204
+
+*** Key words ***
+
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Integer response status 200
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/NotificationEndpoint.robot b/SOL002/VNFFaultManagement-API_egm/NotificationEndpoint.robot
new file mode 100644
index 00000000..9a2b2069
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/NotificationEndpoint.robot
@@ -0,0 +1,90 @@
+*** Settings ***
+Resource variables.txt
+Suite Setup Create Sessions
+Suite Teardown Terminate All Processes kill=true
+Library MockServerLibrary
+Library Process
+Library OperatingSystem
+Library REST ${CONSUMER_SCHEMA}://${CONSUMER_HOST}:${notification_port}
+
+*** Variables ***
+${sleep_interval} 20s
+
+*** Test Cases ***
+Deliver a notification - Alarm
+ log The POST method delivers a notification - Information of a VNF alarm.
+ ${json}= Get File schemas/alarmNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle alarmNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Deliver a notification - Alarm Clearance
+ log The POST method delivers a notification - Information of a VNF alarm.
+ ${json}= Get File schemas/alarmClearedNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle alarmNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Deliver a notification - Alarm List Rebuilt
+ log The POST method delivers a notification - Information of a VNF alarm.
+ ${json}= Get File schemas/alarmListRebuiltNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle alarmNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Test a notification end point
+ log The GET method allows the server to test the notification endpoint
+ &{req}= Create Mock Request Matcher Schema GET ${notification_ep}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Verify Mock Expectation ${req}
+ Clear Requests ${notification_ep}
+
+PUT notification - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Put ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH subscriptions - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Patch ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+DELETE subscriptions - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Delete ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+*** Keywords ***
+Create Sessions
+ Start Process java -jar ../../mockserver-netty-5.3.0-jar-with-dependencies.jar -serverPort ${notification_port} alias=mockInstance
+ Wait For Process handle=mockInstance timeout=5s on_timeout=continue
+ Create Mock Session ${CONSUMER_SCHEMA}://${CONSUMER_HOST}:${notification_port} #The API producer is set to NFVO according to SOL003-7.3.4
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.json b/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.json
new file mode 100644
index 00000000..009e6df2
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.json
@@ -0,0 +1,4257 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.1.1",
+ "title": "DRAFT - SOL002 - VNF Fault Management interface",
+ "description": "DRAFT VNF Fault Management interface of ETSI NFV SOL002\nIMPORTANT: 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.\n\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---\n",
+ "license": {
+ "name": "ETSI Forge copyright notice",
+ "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
+ }
+ },
+ "externalDocs": {
+ "description": "ETSI GS NFV-SOL 002 V2.4.1",
+ "url": "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf"
+ },
+ "basePath": "/vnffm/v1",
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/alarms": {
+ "get": {
+ "description": "The client can use this method to retrieve information about the alarm list.\n",
+ "parameters": [
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded. The response body shall contain the list of related alarms.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The alarm data type encapsulates information about an alarm.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "managedObjectId",
+ "rootCauseFaultyResource",
+ "alarmRaisedTime",
+ "ackState",
+ "perceivedSeverity",
+ "eventTime",
+ "eventType",
+ "probableCause",
+ "isRootCause",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "managedObjectId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "rootCauseFaultyResource": {
+ "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
+ "type": "object",
+ "required": [
+ "faultyResource",
+ "faultyResourceType"
+ ],
+ "properties": {
+ "faultyResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "faultyResourceType": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ }
+ },
+ "alarmRaisedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmChangedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmClearedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ackState": {
+ "description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
+ "type": "string",
+ "enum": [
+ "UNACKNOWLEDGED",
+ "ACKNOWLEDGED"
+ ]
+ },
+ "perceivedSeverity": {
+ "type": "string"
+ },
+ "eventTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "eventType": {
+ "type": "string"
+ },
+ "faultType": {
+ "description": "Additional information to clarify the type of the fault.\n",
+ "type": "string"
+ },
+ "probableCause": {
+ "description": "Information about the probable cause of the fault.\n",
+ "type": "string"
+ },
+ "isRootCause": {
+ "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
+ "type": "boolean"
+ },
+ "correlatedAlarmIds": {
+ "description": "List of identifiers of other alarms correlated to this fault.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "faultDetails": {
+ "description": "Provides additional information about the fault.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "objectInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nInvalid attribute-based filtering parameters or Invalid attribute selector. It fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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 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. 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/alarms/{alarmId}": {
+ "parameters": [
+ {
+ "name": "alarmId",
+ "description": "Identifier of the alarm. This identifier can be retrieved from the \"id\" attribute of the \"alarm\" attribute in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the \"id\" attribute of the applicable array element in the payload body of the response to a GET request to the \"Alarms\" resource.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "get": {
+ "description": "The client can use this method to read an individual alarm.\n",
+ "parameters": [
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Information about an individual alarm was read successfully. The response body shall contain a representation of the individual alarm.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The alarm data type encapsulates information about an alarm.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "managedObjectId",
+ "rootCauseFaultyResource",
+ "alarmRaisedTime",
+ "ackState",
+ "perceivedSeverity",
+ "eventTime",
+ "eventType",
+ "probableCause",
+ "isRootCause",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "managedObjectId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "rootCauseFaultyResource": {
+ "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
+ "type": "object",
+ "required": [
+ "faultyResource",
+ "faultyResourceType"
+ ],
+ "properties": {
+ "faultyResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "faultyResourceType": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ }
+ },
+ "alarmRaisedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmChangedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmClearedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ackState": {
+ "description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
+ "type": "string",
+ "enum": [
+ "UNACKNOWLEDGED",
+ "ACKNOWLEDGED"
+ ]
+ },
+ "perceivedSeverity": {
+ "type": "string"
+ },
+ "eventTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "eventType": {
+ "type": "string"
+ },
+ "faultType": {
+ "description": "Additional information to clarify the type of the fault.\n",
+ "type": "string"
+ },
+ "probableCause": {
+ "description": "Information about the probable cause of the fault.\n",
+ "type": "string"
+ },
+ "isRootCause": {
+ "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
+ "type": "boolean"
+ },
+ "correlatedAlarmIds": {
+ "description": "List of identifiers of other alarms correlated to this fault.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "faultDetails": {
+ "description": "Provides additional information about the fault.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "objectInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "description": "This method modifies an individual alarm resource.\n",
+ "parameters": [
+ {
+ "name": "AlarmModifications",
+ "description": "The parameter for the alarm modification",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents attribute modifications for an \"Individual alarm\" resource, i.e. modifications to a resource representation based on the \"Alarm\" data type. The attributes of \"Alarm\" that can be modified are included in the \"AlarmModifications\" data type.\n",
+ "type": "object",
+ "required": [
+ "ackState"
+ ],
+ "properties": {
+ "ackState": {
+ "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: * ACKNOWLEDGED\n",
+ "type": "string",
+ "enum": [
+ "ACKNOWLEDGED"
+ ]
+ }
+ }
+ }
+ },
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The Content-Type header shall be set to \"application/mergepatch+json\" Reference: IETF RFC 7396\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nThe request was accepted and completed. The response body shall contain attribute modifications for an ‘Individual alarm’ resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents attribute modifications for an \"Individual alarm\" resource, i.e. modifications to a resource representation based on the \"Alarm\" data type. The attributes of \"Alarm\" that can be modified are included in the \"AlarmModifications\" data type.\n",
+ "type": "object",
+ "required": [
+ "ackState"
+ ],
+ "properties": {
+ "ackState": {
+ "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: * ACKNOWLEDGED\n",
+ "type": "string",
+ "enum": [
+ "ACKNOWLEDGED"
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the \"Individual alarm\" resource. Typically, this is due to the fact that the alarm is already in the state that is requested to be set (such as trying to acknowledge an already-acknowledged alarm). The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "412": {
+ "description": "Precondition Failed\nA 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/alarms/{alarmId}/escalate": {
+ "post": {
+ "description": "The POST method enables the consumer to escalate the perceived severity of an alarm that is represented by an ndividual alarm resource.\n",
+ "parameters": [
+ {
+ "name": "PerceivedSeverityRequest",
+ "description": "The proposed \"escalated perceived severity\" value",
+ "in": "body",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nThe VNFM has received the proposed \"escalated perceived severity\" value successfully. The response body shall be empty.\n"
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "412": {
+ "description": "Precondition Failed\nA 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/alarms/subscriptions": {
+ "post": {
+ "description": "The POST method creates a new subscription.\n",
+ "parameters": [
+ {
+ "name": "FmSubscriptionRequest",
+ "description": "The VNF creation parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents a subscription request related to notifications about VNF faults.\n",
+ "type": "object",
+ "required": [
+ "callbackUri"
+ ],
+ "properties": {
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF faults. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * AlarmNotification * AlarmClearedNotification * AlarmListRebuiltNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AlarmNotification",
+ "AlarmClearedNotification",
+ "AlarmListRebuiltNotification"
+ ]
+ }
+ },
+ "faultyResourceTypes": {
+ "description": "Match VNF alarms with a faulty resource type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ },
+ "perceivedSeverities": {
+ "description": "Match VNF alarms with a perceived severity listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ }
+ },
+ "eventTypes": {
+ "description": "Match VNF alarms with an event type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ }
+ },
+ "probableCauses": {
+ "description": "Match VNF alarms with a probable cause listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "The URI of the endpoint to send the notification to.\n",
+ "type": "string",
+ "format": "url"
+ },
+ "authentication": {
+ "type": "object",
+ "required": [
+ "authType"
+ ],
+ "properties": {
+ "authType": {
+ "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. \n* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n* TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "BASIC",
+ "OAUTH2_CLIENT_CREDENTIALS",
+ "TLS_CERT"
+ ]
+ }
+ },
+ "paramsBasic": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "userName": {
+ "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
+ "type": "string"
+ },
+ "password": {
+ "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
+ "type": "string"
+ }
+ }
+ },
+ "paramsOauth2ClientCredentials": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "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.\n",
+ "type": "string"
+ },
+ "clientPassword": {
+ "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.\n",
+ "type": "string"
+ },
+ "tokenEndpoint": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created\nThe subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a \"Location:\" HTTP header that points to the created subscription resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created subscription resource.\n",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF faults.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF faults. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * AlarmNotification * AlarmClearedNotification * AlarmListRebuiltNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AlarmNotification",
+ "AlarmClearedNotification",
+ "AlarmListRebuiltNotification"
+ ]
+ }
+ },
+ "faultyResourceTypes": {
+ "description": "Match VNF alarms with a faulty resource type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ },
+ "perceivedSeverities": {
+ "description": "Match VNF alarms with a perceived severity listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ }
+ },
+ "eventTypes": {
+ "description": "Match VNF alarms with an event type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ }
+ },
+ "probableCauses": {
+ "description": "Match VNF alarms with a probable cause listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "The URI of the endpoint to send the notification to.\n",
+ "type": "string",
+ "format": "url"
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "303": {
+ "description": "See Other\nA subscription with the same callbackURI and the same filter already exists and the policy of the VNFM is to not create redundant subscriptions. The HTTP response shall include a \"Location\" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty.\n"
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "description": "The client can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.\n",
+ "parameters": [
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nThe list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF faults.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF faults. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * AlarmNotification * AlarmClearedNotification * AlarmListRebuiltNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AlarmNotification",
+ "AlarmClearedNotification",
+ "AlarmListRebuiltNotification"
+ ]
+ }
+ },
+ "faultyResourceTypes": {
+ "description": "Match VNF alarms with a faulty resource type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ },
+ "perceivedSeverities": {
+ "description": "Match VNF alarms with a perceived severity listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ }
+ },
+ "eventTypes": {
+ "description": "Match VNF alarms with an event type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ }
+ },
+ "probableCauses": {
+ "description": "Match VNF alarms with a probable cause listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "The URI of the endpoint to send the notification to.\n",
+ "type": "string",
+ "format": "url"
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nInvalid attribute-based filtering parameters or Invalid attribute selector. It fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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 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. 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "412": {
+ "description": "Precondition Failed\nA 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}": {
+ "parameters": [
+ {
+ "name": "subscriptionId",
+ "description": "Identifier of this subscription. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "get": {
+ "description": "The client can use this method for reading an individual subscription for VNF alarms subscribed by the client.\n",
+ "parameters": [
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nThe operation has completed successfully. The response body shall contain a representation of the subscription resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF faults.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF faults. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * AlarmNotification * AlarmClearedNotification * AlarmListRebuiltNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AlarmNotification",
+ "AlarmClearedNotification",
+ "AlarmListRebuiltNotification"
+ ]
+ }
+ },
+ "faultyResourceTypes": {
+ "description": "Match VNF alarms with a faulty resource type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ },
+ "perceivedSeverities": {
+ "description": "Match VNF alarms with a perceived severity listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ }
+ },
+ "eventTypes": {
+ "description": "Match VNF alarms with an event type listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ }
+ },
+ "probableCauses": {
+ "description": "Match VNF alarms with a probable cause listed in this attribute.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "The URI of the endpoint to send the notification to.\n",
+ "type": "string",
+ "format": "url"
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "description": "This method terminates an individual subscription.\n",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content\nThe subscription resource was deleted successfully. The response body shall be empty.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed\nIf 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.yaml b/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.yaml
new file mode 100644
index 00000000..1d7825ff
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/SOL002-VNFFaultManagement-API.yaml
@@ -0,0 +1,6539 @@
+swagger: '2.0'
+info:
+ version: 1.1.1
+ title: DRAFT - SOL002 - VNF Fault Management interface
+ description: >
+ DRAFT VNF Fault Management interface of ETSI NFV SOL002
+
+ 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/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
+ license:
+ name: ETSI Forge copyright notice
+ url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
+externalDocs:
+ description: ETSI GS NFV-SOL 002 V2.4.1
+ url: >-
+ http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
+basePath: /vnffm/v1
+schemes:
+ - http
+ - https
+consumes:
+ - application/json
+produces:
+ - application/json
+paths:
+ /alarms:
+ get:
+ description: >
+ The client can use this method to retrieve information about the alarm
+ list.
+ parameters:
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ The request has succeeded. The response body shall contain the list
+ of related alarms.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ The alarm data type encapsulates information about an alarm.
+ type: object
+ required:
+ - id
+ - managedObjectId
+ - rootCauseFaultyResource
+ - alarmRaisedTime
+ - ackState
+ - perceivedSeverity
+ - eventTime
+ - eventType
+ - probableCause
+ - isRootCause
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ managedObjectId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ rootCauseFaultyResource:
+ description: >
+ This type represents the faulty virtual resources that have a
+ negative impact on a VNF.
+ type: object
+ required:
+ - faultyResource
+ - faultyResourceType
+ properties:
+ faultyResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance. Information about the resource is available from
+ the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or the
+ resource provider.
+ type: string
+ faultyResourceType:
+ description: >
+ The enumeration FaultyResourceType represents those types
+ of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ alarmRaisedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ alarmChangedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ alarmClearedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ ackState:
+ description: >
+ Acknowledgement state of the alarm. Permitted values: *
+ UNACKNOWLEDGED * ACKNOWLEDGED.
+ type: string
+ enum:
+ - UNACKNOWLEDGED
+ - ACKNOWLEDGED
+ perceivedSeverity:
+ type: string
+ eventTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ eventType:
+ type: string
+ faultType:
+ description: |
+ Additional information to clarify the type of the fault.
+ type: string
+ probableCause:
+ description: |
+ Information about the probable cause of the fault.
+ type: string
+ isRootCause:
+ description: >
+ Attribute indicating if this fault is the root for other
+ correlated alarms. If TRUE, then the alarms listed in the
+ attribute CorrelatedAlarmId are caused by this fault.
+ type: boolean
+ correlatedAlarmIds:
+ description: |
+ List of identifiers of other alarms correlated to this fault.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ faultDetails:
+ description: |
+ Provides additional information about the fault.
+ type: array
+ items:
+ type: string
+ _links:
+ description: |
+ Links for this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ objectInstance:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ Invalid attribute-based filtering parameters or Invalid attribute
+ selector. It fhe request is malformed or syntactically incorrect
+ (e.g. if the request URI contains incorrect query parameters or a
+ syntactically incorrect payload body), 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 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. 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/alarms/{alarmId}':
+ parameters:
+ - name: alarmId
+ description: >
+ Identifier of the alarm. This identifier can be retrieved from the
+ "id" attribute of the "alarm" attribute in the AlarmNotification or
+ AlarmClearedNotification. It can also be retrieved from the "id"
+ attribute of the applicable array element in the payload body of the
+ response to a GET request to the "Alarms" resource.
+ in: path
+ type: string
+ required: true
+ get:
+ description: |
+ The client can use this method to read an individual alarm.
+ parameters:
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ Information about an individual alarm was read successfully. The
+ response body shall contain a representation of the individual
+ alarm.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ The alarm data type encapsulates information about an alarm.
+ type: object
+ required:
+ - id
+ - managedObjectId
+ - rootCauseFaultyResource
+ - alarmRaisedTime
+ - ackState
+ - perceivedSeverity
+ - eventTime
+ - eventType
+ - probableCause
+ - isRootCause
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ managedObjectId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ rootCauseFaultyResource:
+ description: >
+ This type represents the faulty virtual resources that have a
+ negative impact on a VNF.
+ type: object
+ required:
+ - faultyResource
+ - faultyResourceType
+ properties:
+ faultyResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance. Information about the resource is available from
+ the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or the
+ resource provider.
+ type: string
+ faultyResourceType:
+ description: >
+ The enumeration FaultyResourceType represents those types
+ of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ alarmRaisedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ alarmChangedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ alarmClearedTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ ackState:
+ description: >
+ Acknowledgement state of the alarm. Permitted values: *
+ UNACKNOWLEDGED * ACKNOWLEDGED.
+ type: string
+ enum:
+ - UNACKNOWLEDGED
+ - ACKNOWLEDGED
+ perceivedSeverity:
+ type: string
+ eventTime:
+ description: >
+ Date-time stamp. Representation: String formatted according
+ to IETF RFC 3339.
+ type: string
+ format: date-time
+ eventType:
+ type: string
+ faultType:
+ description: |
+ Additional information to clarify the type of the fault.
+ type: string
+ probableCause:
+ description: |
+ Information about the probable cause of the fault.
+ type: string
+ isRootCause:
+ description: >
+ Attribute indicating if this fault is the root for other
+ correlated alarms. If TRUE, then the alarms listed in the
+ attribute CorrelatedAlarmId are caused by this fault.
+ type: boolean
+ correlatedAlarmIds:
+ description: |
+ List of identifiers of other alarms correlated to this fault.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ faultDetails:
+ description: |
+ Provides additional information about the fault.
+ type: array
+ items:
+ type: string
+ _links:
+ description: |
+ Links for this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ objectInstance:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ patch:
+ description: |
+ This method modifies an individual alarm resource.
+ parameters:
+ - name: AlarmModifications
+ description: The parameter for the alarm modification
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents attribute modifications for an "Individual
+ alarm" resource, i.e. modifications to a resource representation
+ based on the "Alarm" data type. The attributes of "Alarm" that can
+ be modified are included in the "AlarmModifications" data type.
+ type: object
+ required:
+ - ackState
+ properties:
+ ackState:
+ description: >
+ New value of the "ackState" attribute in "Alarm". Permitted
+ values: * ACKNOWLEDGED
+ type: string
+ enum:
+ - ACKNOWLEDGED
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: >
+ The Content-Type header shall be set to
+ "application/mergepatch+json" Reference: IETF RFC 7396
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ OK
+
+ The request was accepted and completed. The response body shall
+ contain attribute modifications for an ‘Individual alarm’ resource.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents attribute modifications for an "Individual
+ alarm" resource, i.e. modifications to a resource representation
+ based on the "Alarm" data type. The attributes of "Alarm" that can
+ be modified are included in the "AlarmModifications" data type.
+ type: object
+ required:
+ - ackState
+ properties:
+ ackState:
+ description: >
+ New value of the "ackState" attribute in "Alarm". Permitted
+ values: * ACKNOWLEDGED
+ type: string
+ enum:
+ - ACKNOWLEDGED
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the "Individual alarm" resource. Typically, this is due
+ to the fact that the alarm is already in the state that is requested
+ to be set (such as trying to acknowledge an already-acknowledged
+ alarm). The response body shall contain a ProblemDetails structure,
+ in which the "detail" attribute should convey more information about
+ the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '412':
+ description: >
+ Precondition Failed
+
+ 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.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/alarms/{alarmId}/escalate':
+ post:
+ description: >
+ The POST method enables the consumer to escalate the perceived severity
+ of an alarm that is represented by an ndividual alarm resource.
+ parameters:
+ - name: PerceivedSeverityRequest
+ description: The proposed "escalated perceived severity" value
+ in: body
+ schema:
+ type: string
+ responses:
+ '200':
+ description: >
+ OK
+
+ The VNFM has received the proposed "escalated perceived severity"
+ value successfully. The response body shall be empty.
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '412':
+ description: >
+ Precondition Failed
+
+ 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.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ /alarms/subscriptions:
+ post:
+ description: |
+ The POST method creates a new subscription.
+ parameters:
+ - name: FmSubscriptionRequest
+ description: The VNF creation parameters
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents a subscription request related to
+ notifications about VNF faults.
+ type: object
+ required:
+ - callbackUri
+ properties:
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF faults. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ AlarmNotification * AlarmClearedNotification *
+ AlarmListRebuiltNotification The permitted values of the
+ "notificationTypes" attribute are spelled exactly as the
+ names of the notification types to facilitate automated
+ code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - AlarmNotification
+ - AlarmClearedNotification
+ - AlarmListRebuiltNotification
+ faultyResourceTypes:
+ description: >
+ Match VNF alarms with a faulty resource type listed in
+ this attribute.
+ type: array
+ items:
+ description: >
+ The enumeration FaultyResourceType represents those
+ types of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ perceivedSeverities:
+ description: >
+ Match VNF alarms with a perceived severity listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ Indicates the relative level of urgency for operator
+ attention. * CRITICAL: The Critical severity level
+ indicates that a service
+ affecting condition has occurred and an immediate corrective action
+ is required. Such a severity can be reported, for example, when a
+ managed object becomes totally out of service and its capability needs
+ to be restored (ITU-T Recommendation X.733).
+ * MAJOR: The Major severity level indicates that a
+ service affecting
+ condition has developed and an urgent corrective action is required.
+ Such a severity can be reported, for example, when there is a severe
+ degradation in the capability of the managed object and its full
+ capability needs to be restored (ITU-T Recommendation X.733).
+ * MINOR: The Minor severity level indicates the
+ existence of a
+ non-service affecting fault condition and that corrective action
+ should be taken in order to prevent a more serious (for example,
+ service affecting) fault. Such a severity can be reported, for
+ example, when the detected alarm condition is not currently degrading
+ the capacity of the managed object (ITU-T Recommendation X.733).
+ * WARNING: The Warning severity level indicates the
+ detection of a
+ potential or impending service affecting fault, before any significant
+ effects have been felt. Action should be taken to further diagnose (if
+ necessary) and correct the problem in order to prevent it from
+ becoming a more serious service affecting fault (ITU-T Recommendation
+ X.733).
+ * INDETERMINATE: The Indeterminate severity level
+ indicates that the
+ severity level cannot be determined (ITU-T Recommendation X.733).
+ * CLEARED: The Cleared severity level indicates the
+ clearing of one or
+ more previously reported alarms. This alarm clears all alarms for this
+ managed object that have the same Alarm type, Probable cause and
+ Specific problems (if given) (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - CRITICAL
+ - MAJOR
+ - MINOR
+ - WARNING
+ - INDETERMINATE
+ - CLEARED
+ eventTypes:
+ description: >
+ Match VNF alarms with an event type listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ The enumeration EventType represents those types of
+ events that trigger an alarm. * COMMUNICATIONS_ALARM: An
+ alarm of this type is associated with the
+ procedure and/or process required conveying information from one point
+ to another (ITU-T Recommendation X.733).
+ * PROCESSING_ERROR_ALARM: An alarm of this type is
+ associated with a
+ software or processing fault (ITU-T Recommendation X.733).
+ * ENVIRONMENTAL_ALARM: An alarm of this type is
+ associated with a
+ condition related to an enclosure in which the equipment resides
+ (ITU-T Recommendation X.733).
+ * QOS_ALARM: An alarm of this type is associated with
+ degradation in the
+ quality of a service (ITU-T Recommendation X.733).
+ * EQUIPMENT_ALARM: An alarm of this type is associated
+ with an equipment
+ fault (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - COMMUNICATIONS_ALARM
+ - PROCESSING_ERROR_ALARM
+ - ENVIRONMENTAL_ALARM
+ - QOS_ALARM
+ - EQUIPMENT_ALARM
+ probableCauses:
+ description: >
+ Match VNF alarms with a probable cause listed in this
+ attribute.
+ type: array
+ items:
+ type: string
+ callbackUri:
+ description: |
+ The URI of the endpoint to send the notification to.
+ type: string
+ format: url
+ authentication:
+ type: object
+ required:
+ - authType
+ properties:
+ authType:
+ 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.
+ type: array
+ items:
+ type: string
+ enum:
+ - BASIC
+ - OAUTH2_CLIENT_CREDENTIALS
+ - TLS_CERT
+ paramsBasic:
+ 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.
+ type: object
+ properties:
+ userName:
+ description: >
+ Username to be used in HTTP Basic authentication.
+ Shall be present if it has not been provisioned out of
+ band.
+ type: string
+ password:
+ description: >
+ Password to be used in HTTP Basic authentication.
+ Shall be present if it has not been provisioned out of
+ band.
+ type: string
+ paramsOauth2ClientCredentials:
+ 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.
+ type: object
+ properties:
+ clientId:
+ 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.
+ type: string
+ clientPassword:
+ 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.
+ type: string
+ tokenEndpoint:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '201':
+ description: >
+ Created
+
+ The subscription was created successfully. The response body shall
+ contain a representation of the created subscription resource. The
+ HTTP response shall include a "Location:" HTTP header that points to
+ the created subscription resource.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: |
+ The resource URI of the created subscription resource.
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF faults.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF faults. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ AlarmNotification * AlarmClearedNotification *
+ AlarmListRebuiltNotification The permitted values of the
+ "notificationTypes" attribute are spelled exactly as the
+ names of the notification types to facilitate automated
+ code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - AlarmNotification
+ - AlarmClearedNotification
+ - AlarmListRebuiltNotification
+ faultyResourceTypes:
+ description: >
+ Match VNF alarms with a faulty resource type listed in
+ this attribute.
+ type: array
+ items:
+ description: >
+ The enumeration FaultyResourceType represents those
+ types of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ perceivedSeverities:
+ description: >
+ Match VNF alarms with a perceived severity listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ Indicates the relative level of urgency for operator
+ attention. * CRITICAL: The Critical severity level
+ indicates that a service
+ affecting condition has occurred and an immediate corrective action
+ is required. Such a severity can be reported, for example, when a
+ managed object becomes totally out of service and its capability needs
+ to be restored (ITU-T Recommendation X.733).
+ * MAJOR: The Major severity level indicates that a
+ service affecting
+ condition has developed and an urgent corrective action is required.
+ Such a severity can be reported, for example, when there is a severe
+ degradation in the capability of the managed object and its full
+ capability needs to be restored (ITU-T Recommendation X.733).
+ * MINOR: The Minor severity level indicates the
+ existence of a
+ non-service affecting fault condition and that corrective action
+ should be taken in order to prevent a more serious (for example,
+ service affecting) fault. Such a severity can be reported, for
+ example, when the detected alarm condition is not currently degrading
+ the capacity of the managed object (ITU-T Recommendation X.733).
+ * WARNING: The Warning severity level indicates the
+ detection of a
+ potential or impending service affecting fault, before any significant
+ effects have been felt. Action should be taken to further diagnose (if
+ necessary) and correct the problem in order to prevent it from
+ becoming a more serious service affecting fault (ITU-T Recommendation
+ X.733).
+ * INDETERMINATE: The Indeterminate severity level
+ indicates that the
+ severity level cannot be determined (ITU-T Recommendation X.733).
+ * CLEARED: The Cleared severity level indicates the
+ clearing of one or
+ more previously reported alarms. This alarm clears all alarms for this
+ managed object that have the same Alarm type, Probable cause and
+ Specific problems (if given) (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - CRITICAL
+ - MAJOR
+ - MINOR
+ - WARNING
+ - INDETERMINATE
+ - CLEARED
+ eventTypes:
+ description: >
+ Match VNF alarms with an event type listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ The enumeration EventType represents those types of
+ events that trigger an alarm. * COMMUNICATIONS_ALARM: An
+ alarm of this type is associated with the
+ procedure and/or process required conveying information from one point
+ to another (ITU-T Recommendation X.733).
+ * PROCESSING_ERROR_ALARM: An alarm of this type is
+ associated with a
+ software or processing fault (ITU-T Recommendation X.733).
+ * ENVIRONMENTAL_ALARM: An alarm of this type is
+ associated with a
+ condition related to an enclosure in which the equipment resides
+ (ITU-T Recommendation X.733).
+ * QOS_ALARM: An alarm of this type is associated with
+ degradation in the
+ quality of a service (ITU-T Recommendation X.733).
+ * EQUIPMENT_ALARM: An alarm of this type is associated
+ with an equipment
+ fault (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - COMMUNICATIONS_ALARM
+ - PROCESSING_ERROR_ALARM
+ - ENVIRONMENTAL_ALARM
+ - QOS_ALARM
+ - EQUIPMENT_ALARM
+ probableCauses:
+ description: >
+ Match VNF alarms with a probable cause listed in this
+ attribute.
+ type: array
+ items:
+ type: string
+ callbackUri:
+ description: |
+ The URI of the endpoint to send the notification to.
+ type: string
+ format: url
+ _links:
+ description: |
+ Links for this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '303':
+ description: >
+ See Other
+
+ A subscription with the same callbackURI and the same filter already
+ exists and the policy of the VNFM is to not create redundant
+ subscriptions. The HTTP response shall include a "Location" HTTP
+ header that contains the resource URI of the existing subscription
+ resource. The response body shall be empty.
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ get:
+ description: >
+ The client can use this method to retrieve the list of active
+ subscriptions for VNF alarms subscribed by the client. It can be used
+ e.g. for resynchronization after error situations.
+ parameters:
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ OK
+
+ The list of subscriptions was queried successfully. The response
+ body shall contain the representations of all active subscriptions
+ of the functional block that invokes the method.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF faults.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF faults. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ AlarmNotification * AlarmClearedNotification *
+ AlarmListRebuiltNotification The permitted values of the
+ "notificationTypes" attribute are spelled exactly as the
+ names of the notification types to facilitate automated
+ code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - AlarmNotification
+ - AlarmClearedNotification
+ - AlarmListRebuiltNotification
+ faultyResourceTypes:
+ description: >
+ Match VNF alarms with a faulty resource type listed in
+ this attribute.
+ type: array
+ items:
+ description: >
+ The enumeration FaultyResourceType represents those
+ types of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ perceivedSeverities:
+ description: >
+ Match VNF alarms with a perceived severity listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ Indicates the relative level of urgency for operator
+ attention. * CRITICAL: The Critical severity level
+ indicates that a service
+ affecting condition has occurred and an immediate corrective action
+ is required. Such a severity can be reported, for example, when a
+ managed object becomes totally out of service and its capability needs
+ to be restored (ITU-T Recommendation X.733).
+ * MAJOR: The Major severity level indicates that a
+ service affecting
+ condition has developed and an urgent corrective action is required.
+ Such a severity can be reported, for example, when there is a severe
+ degradation in the capability of the managed object and its full
+ capability needs to be restored (ITU-T Recommendation X.733).
+ * MINOR: The Minor severity level indicates the
+ existence of a
+ non-service affecting fault condition and that corrective action
+ should be taken in order to prevent a more serious (for example,
+ service affecting) fault. Such a severity can be reported, for
+ example, when the detected alarm condition is not currently degrading
+ the capacity of the managed object (ITU-T Recommendation X.733).
+ * WARNING: The Warning severity level indicates the
+ detection of a
+ potential or impending service affecting fault, before any significant
+ effects have been felt. Action should be taken to further diagnose (if
+ necessary) and correct the problem in order to prevent it from
+ becoming a more serious service affecting fault (ITU-T Recommendation
+ X.733).
+ * INDETERMINATE: The Indeterminate severity level
+ indicates that the
+ severity level cannot be determined (ITU-T Recommendation X.733).
+ * CLEARED: The Cleared severity level indicates the
+ clearing of one or
+ more previously reported alarms. This alarm clears all alarms for this
+ managed object that have the same Alarm type, Probable cause and
+ Specific problems (if given) (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - CRITICAL
+ - MAJOR
+ - MINOR
+ - WARNING
+ - INDETERMINATE
+ - CLEARED
+ eventTypes:
+ description: >
+ Match VNF alarms with an event type listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ The enumeration EventType represents those types of
+ events that trigger an alarm. * COMMUNICATIONS_ALARM: An
+ alarm of this type is associated with the
+ procedure and/or process required conveying information from one point
+ to another (ITU-T Recommendation X.733).
+ * PROCESSING_ERROR_ALARM: An alarm of this type is
+ associated with a
+ software or processing fault (ITU-T Recommendation X.733).
+ * ENVIRONMENTAL_ALARM: An alarm of this type is
+ associated with a
+ condition related to an enclosure in which the equipment resides
+ (ITU-T Recommendation X.733).
+ * QOS_ALARM: An alarm of this type is associated with
+ degradation in the
+ quality of a service (ITU-T Recommendation X.733).
+ * EQUIPMENT_ALARM: An alarm of this type is associated
+ with an equipment
+ fault (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - COMMUNICATIONS_ALARM
+ - PROCESSING_ERROR_ALARM
+ - ENVIRONMENTAL_ALARM
+ - QOS_ALARM
+ - EQUIPMENT_ALARM
+ probableCauses:
+ description: >
+ Match VNF alarms with a probable cause listed in this
+ attribute.
+ type: array
+ items:
+ type: string
+ callbackUri:
+ description: |
+ The URI of the endpoint to send the notification to.
+ type: string
+ format: url
+ _links:
+ description: |
+ Links for this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ Invalid attribute-based filtering parameters or Invalid attribute
+ selector. It fhe request is malformed or syntactically incorrect
+ (e.g. if the request URI contains incorrect query parameters or a
+ syntactically incorrect payload body), 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 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. 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '412':
+ description: >
+ Precondition Failed
+
+ 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.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/subscriptions/{subscriptionId}':
+ parameters:
+ - name: subscriptionId
+ description: >
+ Identifier of this subscription. This identifier can be retrieved from
+ the resource referenced by the "Location" HTTP header in the response
+ to a POST request creating a new subscription resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ get:
+ description: >
+ The client can use this method for reading an individual subscription
+ for VNF alarms subscribed by the client.
+ parameters:
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ OK
+
+ The operation has completed successfully. The response body shall
+ contain a representation of the subscription resource.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF faults.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF faults. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ AlarmNotification * AlarmClearedNotification *
+ AlarmListRebuiltNotification The permitted values of the
+ "notificationTypes" attribute are spelled exactly as the
+ names of the notification types to facilitate automated
+ code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - AlarmNotification
+ - AlarmClearedNotification
+ - AlarmListRebuiltNotification
+ faultyResourceTypes:
+ description: >
+ Match VNF alarms with a faulty resource type listed in
+ this attribute.
+ type: array
+ items:
+ description: >
+ The enumeration FaultyResourceType represents those
+ types of faulty resource.
+ type: string
+ enum:
+ - COMPUTE
+ - STORAGE
+ - NETWORK
+ perceivedSeverities:
+ description: >
+ Match VNF alarms with a perceived severity listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ Indicates the relative level of urgency for operator
+ attention. * CRITICAL: The Critical severity level
+ indicates that a service
+ affecting condition has occurred and an immediate corrective action
+ is required. Such a severity can be reported, for example, when a
+ managed object becomes totally out of service and its capability needs
+ to be restored (ITU-T Recommendation X.733).
+ * MAJOR: The Major severity level indicates that a
+ service affecting
+ condition has developed and an urgent corrective action is required.
+ Such a severity can be reported, for example, when there is a severe
+ degradation in the capability of the managed object and its full
+ capability needs to be restored (ITU-T Recommendation X.733).
+ * MINOR: The Minor severity level indicates the
+ existence of a
+ non-service affecting fault condition and that corrective action
+ should be taken in order to prevent a more serious (for example,
+ service affecting) fault. Such a severity can be reported, for
+ example, when the detected alarm condition is not currently degrading
+ the capacity of the managed object (ITU-T Recommendation X.733).
+ * WARNING: The Warning severity level indicates the
+ detection of a
+ potential or impending service affecting fault, before any significant
+ effects have been felt. Action should be taken to further diagnose (if
+ necessary) and correct the problem in order to prevent it from
+ becoming a more serious service affecting fault (ITU-T Recommendation
+ X.733).
+ * INDETERMINATE: The Indeterminate severity level
+ indicates that the
+ severity level cannot be determined (ITU-T Recommendation X.733).
+ * CLEARED: The Cleared severity level indicates the
+ clearing of one or
+ more previously reported alarms. This alarm clears all alarms for this
+ managed object that have the same Alarm type, Probable cause and
+ Specific problems (if given) (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - CRITICAL
+ - MAJOR
+ - MINOR
+ - WARNING
+ - INDETERMINATE
+ - CLEARED
+ eventTypes:
+ description: >
+ Match VNF alarms with an event type listed in this
+ attribute.
+ type: array
+ items:
+ description: >
+ The enumeration EventType represents those types of
+ events that trigger an alarm. * COMMUNICATIONS_ALARM: An
+ alarm of this type is associated with the
+ procedure and/or process required conveying information from one point
+ to another (ITU-T Recommendation X.733).
+ * PROCESSING_ERROR_ALARM: An alarm of this type is
+ associated with a
+ software or processing fault (ITU-T Recommendation X.733).
+ * ENVIRONMENTAL_ALARM: An alarm of this type is
+ associated with a
+ condition related to an enclosure in which the equipment resides
+ (ITU-T Recommendation X.733).
+ * QOS_ALARM: An alarm of this type is associated with
+ degradation in the
+ quality of a service (ITU-T Recommendation X.733).
+ * EQUIPMENT_ALARM: An alarm of this type is associated
+ with an equipment
+ fault (ITU-T Recommendation X.733).
+ type: string
+ enum:
+ - COMMUNICATIONS_ALARM
+ - PROCESSING_ERROR_ALARM
+ - ENVIRONMENTAL_ALARM
+ - QOS_ALARM
+ - EQUIPMENT_ALARM
+ probableCauses:
+ description: >
+ Match VNF alarms with a probable cause listed in this
+ attribute.
+ type: array
+ items:
+ type: string
+ callbackUri:
+ description: |
+ The URI of the endpoint to send the notification to.
+ type: string
+ format: url
+ _links:
+ description: |
+ Links for this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ delete:
+ description: |
+ This method terminates an individual subscription.
+ parameters:
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '204':
+ description: >
+ No Content
+
+ The subscription resource was deleted successfully. The response
+ body shall be empty.
+ headers:
+ Content-Type:
+ description: >
+ The MIME type of the body of the request. Reference: IETF RFC
+ 7231
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+
diff --git a/SOL002/VNFFaultManagement-API_egm/Subscriptions.robot b/SOL002/VNFFaultManagement-API_egm/Subscriptions.robot
new file mode 100644
index 00000000..6e5932f9
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/Subscriptions.robot
@@ -0,0 +1,122 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFFaultManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+
+*** Test Cases ***
+Create a new subscription
+ Log Create subscription instance by POST to ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/fmSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 201
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+Create a new Subscription - DUPLICATION
+ Log Trying to create a subscription with an already created content
+ Pass Execution If ${NVFM_DUPLICATION} == 0 NVFO is not permitting duplication. Skipping the test
+ Set Headers {"Accept": "${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ ${body}= Get File json/fmSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 201
+ Log Status code validated
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+Create a new Subscription - NO-DUPLICATION
+ Log Trying to create a subscription with an already created content
+ Pass Execution If ${NVFM_DUPLICATION} == 1 VNFM permits duplication. Skipping the test
+ Set Headers {"Accept": "${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ ${body}= Get File json/fmSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 303
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+GET Subscriptions
+ Log Get the list of active subscriptions
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 200
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+GET Subscription - Filter
+ Log Get the list of active subscriptions using a filter
+ Set Headers {"Accept": "${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/subscriptions?${sub_filter}
+ Integer response status 200
+ Log Received a 200 OK as expected
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+GET subscriptions - Bad Request Invalid attribute-based filtering parameters
+ Log Get the list of active subscriptions using an invalid filter
+ Set Headers {"Accept": "${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/subscriptions?${sub_filter_invalid}
+ Integer response status 400
+ Log Received a 400 Bad Request as expected
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PUT subscriptions - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
+PATCH subscriptions - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
+DELETE subscriptions - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/jsons/alarmModifications.json b/SOL002/VNFFaultManagement-API_egm/jsons/alarmModifications.json
new file mode 100644
index 00000000..53121e5b
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/jsons/alarmModifications.json
@@ -0,0 +1,3 @@
+{
+ "ackState": "ACKNOWLEDGED"
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/jsons/fmSubscriptionRequest.json b/SOL002/VNFFaultManagement-API_egm/jsons/fmSubscriptionRequest.json
new file mode 100644
index 00000000..e44916f8
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/jsons/fmSubscriptionRequest.json
@@ -0,0 +1,10 @@
+{
+ "filter": {
+ "vnfInstanceSubscriptionFilter": {
+ "vnfdIds": [
+ "6fc3539c-e602-4afa-8e13-962fb5a7d81f"
+ ]
+ }
+ },
+ "callbackUri": "http://127.0.0.1/subscribe"
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/alarm.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/alarm.schema.json
new file mode 100644
index 00000000..4a62fdad
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/alarm.schema.json
@@ -0,0 +1,187 @@
+{
+ "description": "The alarm data type encapsulates information about an alarm.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "managedObjectId",
+ "rootCauseFaultyResource",
+ "alarmRaisedTime",
+ "ackState",
+ "perceivedSeverity",
+ "eventTime",
+ "eventType",
+ "probableCause",
+ "isRootCause",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "managedObjectId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "rootCauseFaultyResource": {
+ "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
+ "type": "object",
+ "required": [
+ "faultyResource",
+ "faultyResourceType"
+ ],
+ "properties": {
+ "faultyResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "faultyResourceType": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ }
+ },
+ "alarmRaisedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmChangedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmClearedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ackState": {
+ "description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
+ "type": "string",
+ "enum": [
+ "UNACKNOWLEDGED",
+ "ACKNOWLEDGED"
+ ]
+ },
+ "perceivedSeverity": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ },
+ "eventTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "eventType": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ },
+ "faultType": {
+ "description": "Additional information to clarify the type of the fault.\n",
+ "type": "string"
+ },
+ "probableCause": {
+ "description": "Information about the probable cause of the fault.\n",
+ "type": "string"
+ },
+ "isRootCause": {
+ "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
+ "type": "boolean"
+ },
+ "correlatedAlarmIds": {
+ "description": "List of identifiers of other alarms correlated to this fault.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "faultDetails": {
+ "description": "Provides additional information about the fault.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "objectInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/alarmClearedNotification.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/alarmClearedNotification.schema.json
new file mode 100644
index 00000000..08131723
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/alarmClearedNotification.schema.json
@@ -0,0 +1,80 @@
+{
+ "description": "This type represents an alarm cleared notification about VNF faults. The notification shall be triggered by the VNFM when an alarm has been cleared.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "notificationType",
+ "subscriptionId",
+ "timeStamp",
+ "alarmId",
+ "alarmClearedTime",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "notificationType": {
+ "description": "Discriminator for the different notification types. Shall be set to \"AlarmClearedNotification\" for this notification type.\n",
+ "type": "string",
+ "enum": [
+ "AlarmClearedNotification"
+ ]
+ },
+ "subscriptionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "timeStamp": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "alarmClearedTime": {
+ "description": "The time stamp indicating when the alarm was cleared.\n"
+ },
+ "_links": {
+ "description": "Links to resources related to this notification.\n",
+ "type": "object",
+ "required": [
+ "subscription",
+ "alarm"
+ ],
+ "properties": {
+ "subscription": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "alarm": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/alarmListRebuiltNotification.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/alarmListRebuiltNotification.schema.json
new file mode 100644
index 00000000..bfe018df
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/alarmListRebuiltNotification.schema.json
@@ -0,0 +1,71 @@
+{
+ "description": "This type represents a notification that the alarm list has been rebuilt, e.g. if the VNFM detects its storage holding the alarm list is corrupted. The notification shall be triggered by the VNFM when the alarm list has been rebuilt.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "notificationType",
+ "subscriptionId",
+ "timeStamp",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "notificationType": {
+ "description": "Discriminator for the different notification types. Shall be set to \"AlarmListRebuiltNotification\" for this notification type.\n",
+ "type": "string",
+ "enum": [
+ "AlarmListRebuiltNotification"
+ ]
+ },
+ "subscriptionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "timeStamp": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "_links": {
+ "description": "Links to resources related to this notification.\n",
+ "type": "object",
+ "required": [
+ "subscription",
+ "alarms"
+ ],
+ "properties": {
+ "subscription": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "alarms": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/alarmModifications.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/alarmModifications.schema.json
new file mode 100644
index 00000000..460ad065
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/alarmModifications.schema.json
@@ -0,0 +1,16 @@
+{
+ "description": "This type represents attribute modifications for an \"Individual alarm\" resource, i.e. modifications to a resource representation based on the \"Alarm\" data type. The attributes of \"Alarm\" that can be modified are included in the \"AlarmModifications\" data type.\n",
+ "type": "object",
+ "required": [
+ "ackState"
+ ],
+ "properties": {
+ "ackState": {
+ "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: * ACKNOWLEDGED\n",
+ "type": "string",
+ "enum": [
+ "ACKNOWLEDGED"
+ ]
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/alarmNotification.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/alarmNotification.schema.json
new file mode 100644
index 00000000..1d31e7e3
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/alarmNotification.schema.json
@@ -0,0 +1,250 @@
+{
+ "name": "AlarmNotification",
+ "description": "Information of a VNF alarm.\n",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents an alarm notification about VNF faults. This notification shall be triggered by the VNFM when: * An alarm has been created. * An alarm has been updated, e.g. if the severity of the alarm has changed.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "notificationType",
+ "subscriptionId",
+ "timeStamp",
+ "alarm",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "notificationType": {
+ "description": "Discriminator for the different notification types. Shall be set to \"AlarmNotification\" for this notification type.\n",
+ "type": "string",
+ "enum": [
+ "AlarmNotification"
+ ]
+ },
+ "subscriptionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "timeStamp": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarm": {
+ "description": "The alarm data type encapsulates information about an alarm.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "managedObjectId",
+ "rootCauseFaultyResource",
+ "alarmRaisedTime",
+ "ackState",
+ "perceivedSeverity",
+ "eventTime",
+ "eventType",
+ "probableCause",
+ "isRootCause",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "managedObjectId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "rootCauseFaultyResource": {
+ "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
+ "type": "object",
+ "required": [
+ "faultyResource",
+ "faultyResourceType"
+ ],
+ "properties": {
+ "faultyResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "faultyResourceType": {
+ "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ }
+ },
+ "alarmRaisedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmChangedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "alarmClearedTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ackState": {
+ "description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
+ "type": "string",
+ "enum": [
+ "UNACKNOWLEDGED",
+ "ACKNOWLEDGED"
+ ]
+ },
+ "perceivedSeverity": {
+ "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+ },
+ "eventTime": {
+ "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "eventType": {
+ "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
+ "type": "string",
+ "enum": [
+ "COMMUNICATIONS_ALARM",
+ "PROCESSING_ERROR_ALARM",
+ "ENVIRONMENTAL_ALARM",
+ "QOS_ALARM",
+ "EQUIPMENT_ALARM"
+ ]
+ },
+ "faultType": {
+ "description": "Additional information to clarify the type of the fault.\n",
+ "type": "string"
+ },
+ "probableCause": {
+ "description": "Information about the probable cause of the fault.\n",
+ "type": "string"
+ },
+ "isRootCause": {
+ "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
+ "type": "boolean"
+ },
+ "correlatedAlarmIds": {
+ "description": "List of identifiers of other alarms correlated to this fault.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "faultDetails": {
+ "description": "Provides additional information about the fault.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "_links": {
+ "description": "Links for this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "objectInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "_links": {
+ "description": "Links to resources related to this notification.\n",
+ "type": "object",
+ "required": [
+ "subscription"
+ ],
+ "properties": {
+ "subscription": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/perceivedSeverityRequest.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/perceivedSeverityRequest.schema.json
new file mode 100644
index 00000000..ee370408
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/perceivedSeverityRequest.schema.json
@@ -0,0 +1,11 @@
+{
+ "type": "string",
+ "enum": [
+ "CRITICAL",
+ "MAJOR",
+ "MINOR",
+ "WARNING",
+ "INDETERMINATE",
+ "CLEARED"
+ ]
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/problemDetails.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/problemDetails.schema.json
new file mode 100644
index 00000000..62f17612
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/problemDetails.schema.json
@@ -0,0 +1,34 @@
+{
+ "definitions": {},
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "properties": {
+ "type": {
+ "type": "string",
+ "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\".\n",
+ "format": "URI"
+ },
+ "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).\n"
+ },
+ "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.\n"
+ },
+ "detail": {
+ "type": "string",
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n"
+ },
+ "instance": {
+ "type": "string",
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "format": "URI"
+ }
+ },
+ "required": [
+ "status",
+ "detail"
+ ]
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/schemas/subscriptions.schema.json b/SOL002/VNFFaultManagement-API_egm/schemas/subscriptions.schema.json
new file mode 100644
index 00000000..d691e415
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/schemas/subscriptions.schema.json
@@ -0,0 +1,84 @@
+{
+ "description": "This type represents a subscription related to notifications related to the availability of the virtualised resources quotas.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about the availability of the virtualised resources quotas. 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).\n",
+ "type": "object",
+ "properties": {
+ "vimIds": {
+ "description": "Match VIMs that were created the quota for a consumer of the virtualised resources. This attribute shall only be supported when VNF-related Resource Management in direct mode is applicable.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "resourceProviderIds": {
+ "description": "Match the entities responsible for the management of the virtualised resources that were allocated by the NFVO. This attribute shall only be supported when VNF-related Resource Management in indirect mode is applicable. The identification scheme is outside the scope of the present document.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "resourceTypes": {
+ "description": "Match particular resource types.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "COMPUTE",
+ "STORAGE",
+ "NETWORK"
+ ]
+ }
+ },
+ "resourceGroupIds": {
+ "description": "Match the \"infrastructure resource groups\" that are logical groupings of the virtualised resources assigned to a tenant within an infrastructure Domain.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ },
+ "_links": {
+ "description": "Links for this resource\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFFaultManagement-API_egm/variables.txt b/SOL002/VNFFaultManagement-API_egm/variables.txt
new file mode 100644
index 00000000..7bba5b60
--- /dev/null
+++ b/SOL002/VNFFaultManagement-API_egm/variables.txt
@@ -0,0 +1,42 @@
+*** Variables ***
+${VNFM_HOST} localhost # Hostname of the VNFM
+${VNFM_PORT} 8080 # Listening port of the VNFM
+${CONSUMER_HOST} localhost # Hostname of the NFVO
+${CONSUMER_PORT} 8081 # Listening port of the NFVO
+${VNFM_SCHEMA} https
+${CONSUMER_SCHEMA} https
+${AUTHORIZATION} Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+${CONTENT_TYPE} application/json
+${CONTENT_TYPE_PATCH} application/merge-patch+json
+${ACCEPT} application/json
+${apiRoot} /
+${apiName} vnffm
+${apiVersion} v1
+${AUTH_USAGE} 1
+${WRONG_AUTHORIZATION} Bearer XXXXXWRONGXXXXX
+${alarm_filter} managedObjectId
+${managedObjectId} 007c111c-38a1-42c0-a666-7475ecb1567c
+${invalid_alarm_filter} badFilter
+${alarmId} 6fc3539c-e602-4afa-8e13-962fb5a7d81d
+${vnfInstanceDescription} description vnf
+${vnfInstanceDescription_Update} Updated description vnf
+${SINGLE_FILE_VNFD} 1 # If VNFD is PLAIN TEXT
+${ACCEPT_PLAIN} text/plain
+${ACCEPT_ZIP} application/zip
+${vnfPkgId_processing} 007c111c-38a1-42c0-a666-7475ecb1567c
+${ARTIFACT_TYPE} application/octet-stream
+${ARTIFACT_ID} artifactId
+${WRONG_ACCEPT} application/json
+${vnfLcmOpOccId} 6fc3539c-e602-4afa-8e13-962fb5a7d81d
+${CancelMode} GRACEFUL
+${LccnSubscriptionRequest} {}
+${NVFM_DUPLICATION} 0
+${sub_filter} filter
+${sub_filter_invalid} filter_invalid
+${subscriptionId} 6fc3539c-e602-4afa-8e13-962fb5a7d81f
+${notification_ep} /notification
+${notification_port} 9091
+${AlarmNotification} {}
+${AlarmClearedNotification} {}
+${AlarmListRebuiltNotification} {}
+${PerceivedSeverity} CRITICAL
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/CancelOperationTask.robot b/SOL002/VNFLifecycleManagement-API_egm/CancelOperationTask.robot
new file mode 100644
index 00000000..0f557c96
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/CancelOperationTask.robot
@@ -0,0 +1,130 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library DependencyLibrary
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This task resource represents the "Cancel operation" operation. The client can use this resource to cancel an ongoing VNF lifecycle operation.
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Cancel operation task
+ [Documentation] The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled back, i.e.
+ ... the related "VNF LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
+ Log Cancel a VNF lifecycle operation if that operation has experienced a temporary failure
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Cancel a VNF lifecycle operation
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/cancel ${CancelMode}
+ Log Validate Status code
+ Integer response status 202
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Post Fail operation task Conflict (Not-FAILED_TEMP)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or rollback.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ Depends on test failure Check resource FAILED_TEMP
+ Log Final Fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Post Fail operation task Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or rollback.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another error handling action
+ log Final Fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Post Fail operation task Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also be returned
+ ... if the task is not supported for the VNF LCM operation occurrence represented by the parent resource,
+ ... which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check Fail not supported
+ log Final fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Fail operation task - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+PUT Fail operation task - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Fail operation task - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Fail operation task - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Integer response status 200
+
+Launch another error handling action
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Integer response status 202
+
+Check Fail not supported
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ # how to check if Fail is not supported?
+
+
+Check resource FAILED_TEMP
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ String response body operationState FAILED_TEMP
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/ChangeExternalVNFConnectivityTask.robot b/SOL002/VNFLifecycleManagement-API_egm/ChangeExternalVNFConnectivityTask.robot
new file mode 100644
index 00000000..16d4801b
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/ChangeExternalVNFConnectivityTask.robot
@@ -0,0 +1,89 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL003-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Change external VNF connectivity
+ [Documentation] The POST method changes the external connectivity of a VNF instance
+ Log Trying to change the external connectivity of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeExtVnfConnectivityRequest .json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Change external VNF connectivity Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that another LCM operation is ongoing.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to change the deployment flavour of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeExtVnfConnectivityRequest .json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+
+GET Change external VNF connectivity - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn
+ Log Validate Status code
+ Integer response status 405
+
+PUT Change external VNF connectivity - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Change external VNF connectivity - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Change external VNF connectivity - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_ext_conn
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/ChangeVNFFlavourTask.robot b/SOL002/VNFLifecycleManagement-API_egm/ChangeVNFFlavourTask.robot
new file mode 100644
index 00000000..ff237c06
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/ChangeVNFFlavourTask.robot
@@ -0,0 +1,145 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Change deployment flavour of a vnfInstance
+ [Documentation] Changes the deployment flavour of a VNF instance..
+ Log Trying to change the deployment flavour of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeVnfFlavourRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Change deployment flavour of a vnfInstance Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to change the deployment flavour of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeVnfFlavourRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Change deployment flavour of a vnfInstance Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to change the deployment flavour of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeVnfFlavourRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Change deployment flavour of a vnfInstance Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check change flavour not supported
+ Log Trying to change the deployment flavour of a VNF instance, not exist
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/changeVnfFlavourRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour ${body}
+ Integer response status 404
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+
+GET Change deployment flavour VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour
+ Log Validate Status code
+ Integer response status 405
+
+PUT Change deployment flavour VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Change deployment flavour VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Change deployment flavour VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/change_flavour
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+Check change flavour not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ # how to check if change floavour is not supported? "flavourId" doesn't exist?
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/FailOperationTask.robot b/SOL002/VNFLifecycleManagement-API_egm/FailOperationTask.robot
new file mode 100644
index 00000000..7a3e7574
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/FailOperationTask.robot
@@ -0,0 +1,132 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library DependencyLibrary
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This task resource represents the "Fail operation" operation.
+... The client can use this resource to mark a VNF lifecycle management operation occurrence as "finally failed",
+... i.e. change the state of the related VNF LCM operation occurrence resource to "FAILED", if it is not assumed that a subsequent retry or rollback will succeed.
+... Once the operation is marked as "finally failed", it cannot be retried or rolled back anymore.
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Fail operation task
+ [Documentation] The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation occurrence is in "FAILED_TEMP" state.
+ Log Final fail a VNF lifecycle operation if that operation has experienced a temporary failure
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Output response
+ Log Validate Status code
+ Integer response status 202
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Post Fail operation task Conflict (Not-FAILED_TEMP)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or rollback.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ Depends on test failure Check resource FAILED_TEMP
+ Log Final Fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Post Fail operation task Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or rollback.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another error handling action
+ log Final Fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Post Fail operation task Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also be returned
+ ... if the task is not supported for the VNF LCM operation occurrence represented by the parent resource,
+ ... which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check Fail not supported
+ log Final fail an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/fail
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Fail operation task - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+PUT Fail operation task - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Fail operation task - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Fail operation task - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/fail
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Integer response status 200
+
+Launch another error handling action
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Integer response status 202
+
+Check Fail not supported
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ # how to check if Fail is not supported?
+
+Check resource FAILED_TEMP
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ String response body operationState FAILED_TEMP
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/HealVNFTask.robot b/SOL002/VNFLifecycleManagement-API_egm/HealVNFTask.robot
new file mode 100644
index 00000000..c8ee5bc5
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/HealVNFTask.robot
@@ -0,0 +1,144 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Heal a vnfInstance
+ [Documentation] Heal a VNF instance
+ Log Trying to heal a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/healVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Heal a vnfInstance Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to heal a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/healVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Heal a vnfInstance Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to heal a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/healVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Heal a vnfInstance Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check heal not supported
+ Log Trying to heal a VNF instance, not exist
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/healVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal ${body}
+ Integer response status 404
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Heal VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal
+ Log Validate Status code
+ Integer response status 405
+
+PUT Heal VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Heal VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Heal VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/heal
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+Check heal not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ # how to check if heal is not supported? "flavourId" doesn't exist?
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/IndividualSubscription.robot b/SOL002/VNFLifecycleManagement-API_egm/IndividualSubscription.robot
new file mode 100644
index 00000000..2d2c0b79
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/IndividualSubscription.robot
@@ -0,0 +1,66 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL003-VNFLifecycleManagement-API.yaml
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This resource represents an individual subscription. The client can use this resource to read and to terminate a
+... subscription to notifications related to VNF lifecycle management
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Individual Subscription - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 405
+
+Get Information about an individual subscription
+ log Trying to get information about an individual subscription
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 200
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+PUT an individual subscription - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 405
+
+PATCH an individual subscription - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 405
+
+DELETE an individual subscription
+ log Try to delete an individual subscription
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Log Validate Status code
+ Integer response status 204
+
+*** Key words ***
+
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId}
+ Integer response status 200
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/IndividualVNFInstance.robot b/SOL002/VNFLifecycleManagement-API_egm/IndividualVNFInstance.robot
new file mode 100644
index 00000000..22b2c181
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/IndividualVNFInstance.robot
@@ -0,0 +1,166 @@
+*** Settings ***
+# Suite setup Expect spec SOL003-VNFLifecycleManagement-API.yaml
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library DependencyLibrary
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This resource represents an individual VNF instance. The client can use this resource to modify and delete the
+... underlying VNF instance, and to read information about the VNF instance.
+Suite setup Check resource existance
+
+*** Variables ***
+${Etag}= an etag
+${Etag_modified}= a modified etag
+
+*** Test Cases ***
+Post Individual VNFInstance - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Log Validate Status code
+ Integer response status 405
+
+Get Information about an individual VNF Instance
+ log Trying to get information about an individual VNF instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Log Validate Status code
+ ${Etag}= Output response headers Etag
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json vnfInstance.schema.json ${json}
+ Log Validation OK
+
+PUT Individual VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Individual VNFInstance
+ [Documentation] Modify VNF Information
+ ... This method modifies an individual VNF instance resource.
+ ... Changes to the VNF configurable properties are applied to the configuration in the VNF instance, and are reflected in the representation of this resource.
+ ... Other changes are applied to the VNF instance information managed by the VNFM, and are reflected in the representation of this resource
+ log Trying to modify an individual VNF instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/patchBodyRequest.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId} ${body}
+ Log Validate Status code
+ ${Etag_modified}= Output response headers Etag
+ Integer response status 202
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+PATCH Individual VNFInstance Precondition failed
+ [Documentation] Precondition Failed
+ ... 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.
+ Depends On Test PATCH Individual VNFInstance # If the previous test scceeded, it means that Etag has been modified
+ log Trying to modify an individual VNF instance Precondition failed
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Set Headers {"If-Match": "${Etag}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/patchBodyRequest.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId} ${body}
+ Log Validate Status code
+ Integer response status 412
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PATCH Individual VNFInstance Conflict
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that another LCM operation is ongoing. The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to modify an individual VNF instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/patchBodyRequest.json
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId} ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+DELETE Individual VNFInstance
+ [Documentation] Delete VNF Identifier This method deletes an individual VNF instance resource.
+ log Trying to delete an individual VNF instance
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Log Validate Status code
+ Integer response status 204
+ Log Validation OK
+
+DELETE Individual VNFInstance Conflict
+ # TODO: Need to set the pre-condition of the test. The VnfInstance shall in INSTANTIATED state
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Check resource instantiated
+ log Trying to delete an individual VNF instance Conflict
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Log Validate Status code
+ Integer response status 409
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+*** Key words ***
+
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState INSTANTIATED
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Integer response status 202
+
diff --git a/SOL002/VNFLifecycleManagement-API_egm/IndividualVnfLcmOperationOccurence.robot b/SOL002/VNFLifecycleManagement-API_egm/IndividualVnfLcmOperationOccurence.robot
new file mode 100644
index 00000000..de9168d5
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/IndividualVnfLcmOperationOccurence.robot
@@ -0,0 +1,62 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This resource represents a VNF lifecycle management operation occurrence. The client can use this resource to read
+... status information about an individual VNF lifecycle management operation occurrence. Further, the client can use task
+... resources which are children of this resource to request cancellation of an operation in progress, and to request the
+... handling of operation errors via retrying the operation, rolling back the operation, or permanently failing the operation
+
+*** Test Cases ***
+
+Post Individual VNF LCM OP occurences - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Log Validate Status code
+ Integer response status 405
+
+Get stauts information about multiple VNF instances
+ [Documentation] Get Operation Status
+ ... The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence
+ ... by reading an individual “VNF LCM operation occurrence” resource.
+ Log Query status information about multiple VNF lifecycle management operation occurrences.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json vnfLcmOpOcc.schema.json ${json}
+ Log Validation OK
+
+PUT stauts information about multiple VNF instances - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Log Validate Status code
+ Integer response status 405
+
+PATCH stauts information about multiple VNF instances - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Log Validate Status code
+ Integer response status 405
+
+DELETE stauts information about multiple VNF instances - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Log Validate Status code
+ Integer response status 405
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/InstantiateVNFTask.robot b/SOL002/VNFLifecycleManagement-API_egm/InstantiateVNFTask.robot
new file mode 100644
index 00000000..df787395
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/InstantiateVNFTask.robot
@@ -0,0 +1,90 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library DependencyLibrary
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+
+*** Test Cases ***
+Instantiate a vnfInstance
+ [Documentation] Instantiate VNF The POST method instantiates a VNF instance.
+ Log Trying to Instantiate a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/instantiateVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Instantiate a vnfInstance Conflict
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Check resource instantiated
+ Log Trying to Instantiate a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/instantiateVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate ${body}
+ Integer response status 409
+ Log Status code validated
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Instantiate VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate
+ Log Validate Status code
+ Integer response status 405
+
+PUT Instantiate VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Instantiate VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Instantiate VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/instantiate
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState INSTANTIATED
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/NotificationEndpoint.robot b/SOL002/VNFLifecycleManagement-API_egm/NotificationEndpoint.robot
new file mode 100644
index 00000000..cf467e51
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/NotificationEndpoint.robot
@@ -0,0 +1,90 @@
+*** Settings ***
+Suite Setup Create Sessions
+Suite Teardown Terminate All Processes kill=true
+Resource variables.txt
+Library MockServerLibrary
+Library Process
+Library OperatingSystem
+Library REST ${NFVO_SCHEMA}://${NFVO_HOST}:${notification_port}
+
+*** Variables ***
+${sleep_interval} 20s
+
+*** Test Cases ***
+Deliver a notification - Operation Occurence
+ log The POST method delivers a notification from the server to the client.
+ ${json}= Get File schemas/vnfLcmOperationOccurrenceNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle vnfLcmOperationOccurrenceNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Deliver a notification - Id Creation
+ log The POST method delivers a notification from the server to the client.
+ ${json}= Get File schemas/vnfIdentifierCreationNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle vnfLcmOperationOccurrenceNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Deliver a notification - Id deletion
+ log The POST method delivers a notification from the server to the client.
+ ${json}= Get File schemas/vnfIdentifierCreationNotification.schema.json
+ ${BODY}= evaluate json.loads('''${json}''') json
+ Log Creating mock request and response to handle vnfLcmOperationOccurrenceNotification
+ &{req}= Create Mock Request Matcher Schema POST ${notification_ep} body=${BODY}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Log Verifying results
+ Verify Mock Expectation ${req}
+ Log Cleaning the endpoint
+ Clear Requests ${notification_ep}
+
+Test a notification end point
+ log The GET method allows the server to test the notification endpoint
+ &{req}= Create Mock Request Matcher Schema GET ${notification_ep}
+ &{rsp}= Create Mock Response Schema headers="Content-Type: application/json" status_code=204
+ Create Mock Expectation ${req} ${rsp}
+ Sleep ${sleep_interval}
+ Verify Mock Expectation ${req}
+ Clear Requests ${notification_ep}
+
+PUT notification - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Put ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH subscriptions - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Patch ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+DELETE subscriptions - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Delete ${notification_ep}
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+*** Keywords ***
+Create Sessions
+ Start Process java -jar ../../mockserver-netty-5.3.0-jar-with-dependencies.jar -serverPort ${notification_port} alias=mockInstance
+ Wait For Process handle=mockInstance timeout=5s on_timeout=continue
+ Create Mock Session ${NFVO_SCHEMA}://${NFVO_HOST}:${notification_port} #The API producer is set to NFVO according to SOL003-5.3.9
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/OperateVNFTask.robot b/SOL002/VNFLifecycleManagement-API_egm/OperateVNFTask.robot
new file mode 100644
index 00000000..ba563c03
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/OperateVNFTask.robot
@@ -0,0 +1,145 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Operate a vnfInstance
+ [Documentation] Change the operational state of a VNF instance
+ Log Trying to change the operational state of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/operateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Operate a vnfInstance Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to change the operational state of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/operateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Operate a vnfInstance Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to change the operational state of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/operateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Operate a vnfInstance Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check operate not supported
+ Log Trying to change the operational state of a VNF instance, not exist
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/operateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate ${body}
+ Integer response status 404
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Operate VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate
+ Log Validate Status code
+ Integer response status 405
+
+PUT Operate VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH Operate VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Operate VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/operate
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+Check operate not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ # how to check if operate is not supported? "flavourId" doesn't exist?
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/RetryOperationTask.robot b/SOL002/VNFLifecycleManagement-API_egm/RetryOperationTask.robot
new file mode 100644
index 00000000..f5e72145
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/RetryOperationTask.robot
@@ -0,0 +1,132 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library DependencyLibrary
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This task resource represents the "Retry operation" operation. The client can use this resource to initiate retrying a VNF lifecycle operation.
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Retry operation task
+ [Documentation] The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary failure,
+ ... i.e. the related "VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
+ Depends on test Check resource FAILED_TEMP
+ Log Retry a VNF lifecycle operation if that operation has experienced a temporary failure
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Log Validate Status code
+ Integer response status 202
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Post Retry operation task Conflict (Not-FAILED_TEMP)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as rollback or fail.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ Depends on test failure Check resource FAILED_TEMP
+ Log Retry an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Output response
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Post Retry operation task Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ Depends on test Check resource FAILED_TEMP
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as rollback or fail.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another error handling action
+ log Retry an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Post Retry operation task Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also be returned
+ ... if the task is not supported for the VNF LCM operation occurrence represented by the parent resource,
+ ... which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check retry not supported
+ log Retry an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Retry operation task - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/retry
+ Log Validate Status code
+ Integer response status 405
+
+PUT Retry operation task - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/retry
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Retry operation task - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/retry
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Retry operation task - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/retry
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Integer response status 200
+
+Launch another error handling action
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/rollback
+ Integer response status 202
+
+Check retry not supported
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ # how to check if retry is not supported?
+
+Check resource FAILED_TEMP
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ String response body operationState FAILED_TEMP
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/RollbackOperationTask.robot b/SOL002/VNFLifecycleManagement-API_egm/RollbackOperationTask.robot
new file mode 100644
index 00000000..5cc1d7e6
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/RollbackOperationTask.robot
@@ -0,0 +1,132 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library DependencyLibrary
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This task resource represents the "Rollback operation" operation. The client can use this resource to initiate rolling back a VNF lifecycle operation
+Suite setup Check resource existance
+
+*** Test Cases ***
+Post Rollback operation task
+ [Documentation] The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary failure,
+ ... i.e. the related “VNF LCM operation occurrence” resource is in “FAILED_TEMP” state.
+ Depends on test Check resource FAILED_TEMP
+ Log Rollback a VNF lifecycle operation if that operation has experienced a temporary failure
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/rollback
+ Log Validate Status code
+ Integer response status 202
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Post Rollback operation task Conflict (Not-FAILED_TEMP)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or fail.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ Depends on test failure Check resource FAILED_TEMP
+ Log Rollback an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/rollback
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Post Rollback operation task Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ Depends on test Check resource FAILED_TEMP
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state,
+ ... or another error handling action is starting, such as retry or fail.
+ ... The response body shall contain a ProblemDetails structure, in which the “detail” attribute should convey more information about the error.
+ [Setup] Launch another error handling action
+ log Rollback an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/rollback
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Post Rollback operation task Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also be returned
+ ... if the task is not supported for the VNF LCM operation occurrence represented by the parent resource,
+ ... which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check Rollback not supported
+ log Rollback an operation
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/rollback
+ Log Validate Status code
+ Output response
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Rollback operation task - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/rollback
+ Log Validate Status code
+ Integer response status 405
+
+PUT Rollback operation task - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/rollback
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Rollback operation task - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/rollback
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Rollback operation task - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfInstanceId}/rollback
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ Integer response status 200
+
+Launch another error handling action
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}/retry
+ Integer response status 202
+
+Check Rollback not supported
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ # how to check if Rollback is not supported?
+
+Check resource FAILED_TEMP
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs/${vnfLcmOpOccId}
+ String response body operationState FAILED_TEMP
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.json b/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.json
new file mode 100644
index 00000000..ea5dcd97
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.json
@@ -0,0 +1,24199 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.1.1",
+ "title": "SOL002 - VNF Configuration interface",
+ "description": "VNF Configuration interface of ETSI NFV SOL002\n\nIMPORTANT: 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.\n\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---\n",
+ "license": {
+ "name": "ETSI Forge copyright notice",
+ "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
+ }
+ },
+ "externalDocs": {
+ "description": "ETSI GS NFV-SOL 002 V2.4.1",
+ "url": "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf"
+ },
+ "basePath": "/vnfconfig/v1",
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/vnf_instances": {
+ "post": {
+ "description": "The POST method creates a new VNF instance resource.",
+ "parameters": [
+ {
+ "name": "createVnfRequest",
+ "description": "The VNF creation parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "required": [
+ "vnfdId"
+ ],
+ "properties": {
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Human-readable name of the VNF instance to be created.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance to be created.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Content-Type",
+ "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "A VNF Instance identifier was created successfully",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "type": "string",
+ "format": "url"
+ },
+ "WWW-Authenticate": {
+ "description": "Created\nChallenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "416": {
+ "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity\nIf 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. NOTE 2: This error response code is only applicable for methods that have a request body.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "description": "The GET method queries information about multiple VNF instances.\n",
+ "parameters": [
+ {
+ "name": "Accept",
+ "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Authorization",
+ "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
+ "in": "header",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nInformation about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIt fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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 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. 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "416": {
+ "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "get": {
+ "description": "Information about an individual VNF instance was queried successfully.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nInformation about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "416": {
+ "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "description": "This method modifies an individual VNF instance resource. Changes to the VNF configurable properties are applied to the configuration in the VNF instance, and are reflected in the representation of this resource. Other changes are applied to the VNF instance information managed by the VNFM, and are reflected in the representation of this resource\n",
+ "parameters": [
+ {
+ "name": "vnfInfoModifications",
+ "description": "Input parameters for VNF info modification",
+ "required": true,
+ "in": "body",
+ "schema": {
+ "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceName": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "vimConnectionInfo": {
+ "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimType": {
+ "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.\n",
+ "type": "string"
+ },
+ "interfaceInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "accessInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "extra": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfPkgId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIt fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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 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. 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that another LCM operation is ongoing. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "412": {
+ "description": "Precondition Failed\nA 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "description": "This method deletes an individual VNF instance resource.\n",
+ "responses": {
+ "204": {
+ "description": "No Content\nThe VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty.\n",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIt fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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 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. 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "412": {
+ "description": "Precondition Failed\nA 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/instantiate": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method instantiates a VNF instance.\n",
+ "parameters": [
+ {
+ "name": "InstantiateVnfRequest",
+ "description": "Parameters for the VNF instantiation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "required": [
+ "flavourId"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "instantiationLevelId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "extVirtualLinks": {
+ "description": "Information about external VLs to connect the VNF to.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceId",
+ "extCps"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "extCps": {
+ "description": "External CPs of the VNF to be connected to this external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents configuration information for external CPs created from a CPD.\n",
+ "type": "object",
+ "required": [
+ "cpdId"
+ ],
+ "properties": {
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "cpConfig": {
+ "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "linkPortId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "cpProtocolData": {
+ "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\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents network protocol data.\n",
+ "type": "object",
+ "required": [
+ "layerProtocol"
+ ],
+ "properties": {
+ "layerProtocol": {
+ "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
+ "type": "string",
+ "enum": [
+ "IP_OVER_ETHERNET"
+ ]
+ },
+ "ipOverEthernet": {
+ "description": "This type represents network address data for IP over Ethernet.\n",
+ "type": "object",
+ "properties": {
+ "macAddress": {
+ "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
+ "type": "string",
+ "format": "MAC"
+ },
+ "ipAddresses": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
+ "type": "string",
+ "enum": [
+ "IPV4",
+ "IPV6"
+ ]
+ },
+ "fixedAddresses": {
+ "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ },
+ "numDynamicAddresses": {
+ "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.\n",
+ "type": "integer"
+ },
+ "addressRange": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "minAddress",
+ "maxAddress"
+ ],
+ "properties": {
+ "minAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ },
+ "maxAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ }
+ },
+ "subnetId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinks": {
+ "description": "Information about external VLs to connect the VNF to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "resourceId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "description": "Localization language of the VNF to be instantiated. The value shall comply with the format defined in IETF RFC 5646.\n",
+ "type": "string"
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK\nInformation about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "416": {
+ "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/scale": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance to be scaled. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method requests to scale a VNF instance resource incrementally.\n",
+ "parameters": [
+ {
+ "name": "ScaleVnfRequest",
+ "description": "Parameters for the scale VNF operation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "required": [
+ "type",
+ "aspectId"
+ ],
+ "properties": {
+ "type": {
+ "description": "Indicates the type of the scale operation requested. Permitted values: * SCALE_OUT: adding additional VNFC instances to the VNF to increase capacity\n* SCALE_IN: removing VNFC instances from the VNF in order to release unused capacity.\n",
+ "type": "string",
+ "enum": [
+ "SCALE_OUT",
+ "SCALE_IN"
+ ]
+ },
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "numberOfSteps": {
+ "description": "Number of scaling steps to be executed as part of this Scale VNF operation. It shall be a positive number and the default value shall be 1.\n",
+ "type": "integer",
+ "default": 1
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF instance represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/scale_to_level": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance to be scaled to a target level. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method requests to scale a VNF instance resource to a target level.\n",
+ "parameters": [
+ {
+ "name": "ScaleVnfToLevelRequest",
+ "description": "Parameters for the scale VNF to Level operation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents request parameters for the \"Scale VNF to Level\" operation.\n",
+ "type": "object",
+ "properties": {
+ "instantiationLevelId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleInfo": {
+ "description": "For each scaling aspect of the current deployment flavour, indicates the target scale level to which the VNF is to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute shall be included.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF instance represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/change_flavour": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "The identifier of the VNF instance of which the deployment flavour is requested to be changed. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method changes the deployment flavour of a VNF instance.\n",
+ "parameters": [
+ {
+ "name": "ChangeVnfFlavourRequest",
+ "description": "Parameters for the Change VNF Flavour operation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents request parameters for the \"Change VNF flavour\" operation.\n",
+ "type": "object",
+ "required": [
+ "newFlavourId"
+ ],
+ "properties": {
+ "newFlavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "instantiationLevelId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "extVirtualLinks": {
+ "description": "Information about external VLs to connect the VNF to.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceId",
+ "extCps"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "extCps": {
+ "description": "External CPs of the VNF to be connected to this external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents configuration information for external CPs created from a CPD.\n",
+ "type": "object",
+ "required": [
+ "cpdId"
+ ],
+ "properties": {
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "cpConfig": {
+ "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "linkPortId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "cpProtocolData": {
+ "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\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents network protocol data.\n",
+ "type": "object",
+ "required": [
+ "layerProtocol"
+ ],
+ "properties": {
+ "layerProtocol": {
+ "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
+ "type": "string",
+ "enum": [
+ "IP_OVER_ETHERNET"
+ ]
+ },
+ "ipOverEthernet": {
+ "description": "This type represents network address data for IP over Ethernet.\n",
+ "type": "object",
+ "properties": {
+ "macAddress": {
+ "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
+ "type": "string",
+ "format": "MAC"
+ },
+ "ipAddresses": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
+ "type": "string",
+ "enum": [
+ "IPV4",
+ "IPV6"
+ ]
+ },
+ "fixedAddresses": {
+ "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ },
+ "numDynamicAddresses": {
+ "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.\n",
+ "type": "integer"
+ },
+ "addressRange": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "minAddress",
+ "maxAddress"
+ ],
+ "properties": {
+ "minAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ },
+ "maxAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ }
+ },
+ "subnetId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinks": {
+ "description": "Information about external VLs to connect the VNF to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "resourceId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF instance represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/terminate": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method terminates a VNF instance.\n",
+ "parameters": [
+ {
+ "name": "TerminateVnfRequest",
+ "description": "Parameters for the VNF termination.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "required": [
+ "terminationType"
+ ],
+ "properties": {
+ "terminationType": {
+ "description": "Indicates the type of termination is requested. Permitted values: * FORCEFUL: The VNFM will shut down the VNF and release the resources immediately after accepting the request.\n",
+ "type": "string",
+ "enum": [
+ "FORCEFUL"
+ ]
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/heal": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance to be healed. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method requests to heal a VNF instance resource.\n",
+ "parameters": [
+ {
+ "name": "HealVnfRequest",
+ "description": "Parameters for the Heal VNF operation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "properties": {
+ "cause": {
+ "description": "Indicates the reason why a healing procedure is required.\n",
+ "type": "string"
+ },
+ "vnfcInstanceId": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "healScript": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF instance represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/operate": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance to be operated. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method changes the operational state of a VNF instance resource.\n",
+ "parameters": [
+ {
+ "name": "OperateVnfRequest",
+ "description": "Parameters for the Operate VNF operation.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents request parameters for the \"Operate VNF\" operation.\n",
+ "type": "object",
+ "required": [
+ "changeStateTo"
+ ],
+ "properties": {
+ "changeStateTo": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "stopType": {
+ "description": "* FORCEFUL: The VNFM will stop the VNF immediately after accepting the request.\n* GRACEFUL: The VNFM will first arrange to take the VNF out of service after accepting the request. Once that operation is successful or once\n the timer value specified in the \"gracefulStopTimeout\" attribute\n expires, the VNFM will stop the VNF.\n",
+ "type": "string",
+ "enum": [
+ "FORCEFUL",
+ "GRACEFUL"
+ ]
+ },
+ "vnfcInstanceId": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF instance represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF 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 should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_instances/{vnfInstanceId}/change_ext_vls": {
+ "parameters": [
+ {
+ "name": "vnfInstanceId",
+ "description": "Identifier of the VNF instance of which the external connectivity is requested to be changed. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "post": {
+ "description": "The POST method changes the external connectivity of a VNF instance.\n",
+ "parameters": [
+ {
+ "name": "ChangeExtVnfConnectivityRequest",
+ "description": "Parameters for the Change external VNF connectivity operation.\n",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents request parameters for the \"Change external VNF connectivity\" operation to modify the external connectivity of a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "extVirtualLinks"
+ ],
+ "properties": {
+ "extVirtualLinks": {
+ "description": "Information about external VLs to change (e.g. connect the VNF to).\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceId",
+ "extCps"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "extCps": {
+ "description": "External CPs of the VNF to be connected to this external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents configuration information for external CPs created from a CPD.\n",
+ "type": "object",
+ "required": [
+ "cpdId"
+ ],
+ "properties": {
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "cpConfig": {
+ "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "linkPortId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "cpProtocolData": {
+ "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\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents network protocol data.\n",
+ "type": "object",
+ "required": [
+ "layerProtocol"
+ ],
+ "properties": {
+ "layerProtocol": {
+ "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
+ "type": "string",
+ "enum": [
+ "IP_OVER_ETHERNET"
+ ]
+ },
+ "ipOverEthernet": {
+ "description": "This type represents network address data for IP over Ethernet.\n",
+ "type": "object",
+ "properties": {
+ "macAddress": {
+ "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
+ "type": "string",
+ "format": "MAC"
+ },
+ "ipAddresses": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
+ "type": "string",
+ "enum": [
+ "IPV4",
+ "IPV6"
+ ]
+ },
+ "fixedAddresses": {
+ "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ },
+ "numDynamicAddresses": {
+ "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.\n",
+ "type": "integer"
+ },
+ "addressRange": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "minAddress",
+ "maxAddress"
+ ],
+ "properties": {
+ "minAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ },
+ "maxAddress": {
+ "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.\n",
+ "type": "string",
+ "format": "IP"
+ }
+ }
+ },
+ "subnetId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "additionalParams": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "onboardedVnfPkgInfoId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "onboardedVnfPkgInfoId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "instantiationState": {
+ "description": "The instantiation state of the VNF.\n",
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ]
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "scaleStatus": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "aspectId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "scaleLevel": {
+ "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "List of network addresses that have been configured (statically or dynamically) on the CP.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfVirtualLinkDescId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "description": "Active monitoring parameters.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification outside the scope of the present document.\n",
+ "type": "object"
+ },
+ "timeStamp": {
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "localizationLanguage": {
+ "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.\n",
+ "type": "string"
+ },
+ "vnfcResourceInfo": {
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource",
+ "vnfcCpInfo"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfcCpInfo": {
+ "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.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "cpdId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "vnfExtCpId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "addresses": {
+ "description": "This type represents information about a network address that has been assigned.\n",
+ "type": "object",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "description": "Assigned MAC address.\n",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address. Present if an IP address was assigned.\n",
+ "type": "string"
+ },
+ "subnetIpRanges": {
+ "description": "IP address ranges defining the subnet in which the IP address was assigned. May be present if the \"ipAddress\" attribute is present, and shall be absent if the \"ipAddress\" attribute is not present.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "minIpAddress",
+ "maxIpAddress"
+ ],
+ "properties": {
+ "minIpAddress": {
+ "description": "Lowest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ },
+ "maxIpAddress": {
+ "description": "Highest IP address belonging to the range.\n",
+ "type": "string",
+ "format": "ipaddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "networkResource",
+ "vnfLinkPorts"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfLinkPorts": {
+ "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPort). May be present otherwise.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "type": "array",
+ "items": {
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "reservationId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcInfo": {
+ "description": "TBD",
+ "type": "string"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that another LCM operation is ongoing. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs": {
+ "get": {
+ "description": "The client can use this method to query status information about multiple VNF lifecycle management operation occurrences.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nStatus information for zero or more VNF lifecycle management operation occurrences was queried successfully. The response body shall contain status information about zero or more VNF lifecycle operation occurrences.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF lifecycle management operation occurrence.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "operationState",
+ "stateEnteredTime",
+ "startTime",
+ "vnfInstanceId",
+ "operation",
+ "isAutomaticInvocation",
+ "operationParams",
+ "isCancelPending"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operationState": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ },
+ "stateEnteredTime": {
+ "description": "Date-time when the current state was entered.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "startTime": {
+ "description": "Date-time of the start of the operation.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "vnfInstanceId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "grantId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ },
+ "isAutomaticInvocation": {
+ "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
+ "type": "boolean"
+ },
+ "operationParams": {
+ "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.\n",
+ "type": "object"
+ },
+ "isCancelPending": {
+ "description": "If the VNF LCM operation occurrence is in \"STARTING\", \"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.\n",
+ "type": "boolean"
+ },
+ "cancelMode": {
+ "description": "Cancellation mode. GRACEFUL: The VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state.\n",
+ "type": "string",
+ "enum": [
+ "GRACEFUL",
+ "FORCEFUL"
+ ]
+ },
+ "error": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ },
+ "resourceChanges": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "affectedVnfcs": {
+ "description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "changeType",
+ "computeResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "affectedVnfcCpIds": {
+ "description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "addedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "removedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "affectedVirtualLinks": {
+ "description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VLs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "changeType",
+ "networkResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "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.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY",
+ "LINK_PORT_ADDED",
+ "LINK_PORT_REMOVED"
+ ]
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "affectedVirtualStorages": {
+ "description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "changeType",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "changedInfo": {
+ "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceName": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "vimConnectionInfo": {
+ "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimType": {
+ "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.\n",
+ "type": "string"
+ },
+ "interfaceInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "accessInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "extra": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfPkgId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ }
+ }
+ },
+ "changedExtConnectivity": {
+ "description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self",
+ "vnfInstance"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "vnfInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "grant": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "cancel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "retry": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "rollback": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "fail": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs/{vnfLcmOpOccId}": {
+ "parameters": [
+ {
+ "name": "vnfLcmOpOccId",
+ "description": "Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "get": {
+ "description": "The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an individual \"VNF LCM operation occurrence\" resource.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nInformation about an individual VNF instance was queried successfully. The response body shall contain status information about a VNF lifecycle management operation occurrence.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF lifecycle management operation occurrence.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "operationState",
+ "stateEnteredTime",
+ "startTime",
+ "vnfInstanceId",
+ "operation",
+ "isAutomaticInvocation",
+ "operationParams",
+ "isCancelPending"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operationState": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ },
+ "stateEnteredTime": {
+ "description": "Date-time when the current state was entered.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "startTime": {
+ "description": "Date-time of the start of the operation.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "vnfInstanceId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "grantId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ },
+ "isAutomaticInvocation": {
+ "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
+ "type": "boolean"
+ },
+ "operationParams": {
+ "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.\n",
+ "type": "object"
+ },
+ "isCancelPending": {
+ "description": "If the VNF LCM operation occurrence is in \"STARTING\", \"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.\n",
+ "type": "boolean"
+ },
+ "cancelMode": {
+ "description": "Cancellation mode. GRACEFUL: The VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state.\n",
+ "type": "string",
+ "enum": [
+ "GRACEFUL",
+ "FORCEFUL"
+ ]
+ },
+ "error": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ },
+ "resourceChanges": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "affectedVnfcs": {
+ "description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "changeType",
+ "computeResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "affectedVnfcCpIds": {
+ "description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "addedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "removedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "affectedVirtualLinks": {
+ "description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VLs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "changeType",
+ "networkResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "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.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY",
+ "LINK_PORT_ADDED",
+ "LINK_PORT_REMOVED"
+ ]
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "affectedVirtualStorages": {
+ "description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "changeType",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "changedInfo": {
+ "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceName": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "vimConnectionInfo": {
+ "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimType": {
+ "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.\n",
+ "type": "string"
+ },
+ "interfaceInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "accessInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "extra": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfPkgId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ }
+ }
+ },
+ "changedExtConnectivity": {
+ "description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self",
+ "vnfInstance"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "vnfInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "grant": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "cancel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "retry": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "rollback": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "fail": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry": {
+ "parameters": [
+ {
+ "name": "vnfLcmOpOccId",
+ "description": "Identifier of a VNF 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 PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "post": {
+ "description": "The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related \"VNF LCM operation occurrence\" resource is in \"FAILED_TEMP\" state.\n",
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but processing has not been completed. The response shall have an empty payload body.\n",
+ "headers": {
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state, or another error handling action is starting, such as rollback or fail. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback": {
+ "parameters": [
+ {
+ "name": "vnfLcmOpOccId",
+ "description": "Identifier of a VNF lifecycle management operation occurrence to be be rolled back. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "post": {
+ "description": "The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related \"VNF LCM operation occurrence\" resource is in \"FAILED_TEMP\" state.\n",
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but processing has not been completed. The response shall have an empty payload body.\n",
+ "headers": {
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state, or another error handling action is starting, such as rollback or fail. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail": {
+ "parameters": [
+ {
+ "name": "vnfLcmOpOccId",
+ "description": "Identifier of a VNF lifecycle management operation occurrence to be be marked as \"failed\". This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "post": {
+ "description": "The POST method marks a VNF lifecycle management operation occurrence as \"finally failed\" if that operation occurrence is in \"FAILED_TEMP\" state.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nThe state of the VNF lifecycle management operation occurrence was changed successfully. The response shall include a representation of the VNF lifecycle operation occurrence resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a VNF lifecycle management operation occurrence.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "operationState",
+ "stateEnteredTime",
+ "startTime",
+ "vnfInstanceId",
+ "operation",
+ "isAutomaticInvocation",
+ "operationParams",
+ "isCancelPending"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operationState": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ },
+ "stateEnteredTime": {
+ "description": "Date-time when the current state was entered.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "startTime": {
+ "description": "Date-time of the start of the operation.\n",
+ "type": "string",
+ "format": "date-time"
+ },
+ "vnfInstanceId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "grantId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ },
+ "isAutomaticInvocation": {
+ "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
+ "type": "boolean"
+ },
+ "operationParams": {
+ "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.\n",
+ "type": "object"
+ },
+ "isCancelPending": {
+ "description": "If the VNF LCM operation occurrence is in \"STARTING\", \"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.\n",
+ "type": "boolean"
+ },
+ "cancelMode": {
+ "description": "Cancellation mode. GRACEFUL: The VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state.\n",
+ "type": "string",
+ "enum": [
+ "GRACEFUL",
+ "FORCEFUL"
+ ]
+ },
+ "error": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ },
+ "resourceChanges": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "affectedVnfcs": {
+ "description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vduId",
+ "changeType",
+ "computeResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "vduId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "computeResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "affectedVnfcCpIds": {
+ "description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "addedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ },
+ "removedStorageResourceIds": {
+ "description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "affectedVirtualLinks": {
+ "description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary VLs.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "changeType",
+ "networkResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualLinkDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "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.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY",
+ "LINK_PORT_ADDED",
+ "LINK_PORT_REMOVED"
+ ]
+ },
+ "networkResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "affectedVirtualStorages": {
+ "description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "changeType",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ },
+ "virtualStorageDescId": {
+ "description": "An identifier that is unique within a VNF descriptor.\n",
+ "type": "string"
+ },
+ "changeType": {
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ]
+ },
+ "storageResource": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "changedInfo": {
+ "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceName": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfInstanceDescription": {
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
+ "type": "string"
+ },
+ "vnfConfigurableProperties": {
+ "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.\n",
+ "type": "object"
+ },
+ "metadata": {
+ "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.\n",
+ "type": "object"
+ },
+ "extensions": {
+ "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.\n",
+ "type": "object"
+ },
+ "vimConnectionInfo": {
+ "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
+ "type": "array",
+ "items": {
+ "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.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vimType": {
+ "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.\n",
+ "type": "string"
+ },
+ "interfaceInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "accessInfo": {
+ "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.\n",
+ "type": "object"
+ },
+ "extra": {
+ "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.\n",
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfPkgId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfdId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "vnfProvider": {
+ "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfProductName": {
+ "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId†attribute.\n",
+ "type": "string"
+ },
+ "vnfSoftwareVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ },
+ "vnfdVersion": {
+ "description": "A Version.\n",
+ "type": "string"
+ }
+ }
+ },
+ "changedExtConnectivity": {
+ "description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "description": "Link ports of this VL.\n",
+ "type": "array",
+ "items": {
+ "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",
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceHandle": {
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "properties": {
+ "vimConnectionId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceProviderId": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
+ "type": "string"
+ },
+ "vimLevelResourceType": {
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
+ "type": "string"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self",
+ "vnfInstance"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "vnfInstance": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "grant": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "cancel": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "retry": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "rollback": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ },
+ "fail": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is not in FAILED_TEMP state, or another error handling action is starting, such as rollback or fail. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel": {
+ "parameters": [
+ {
+ "name": "vnfLcmOpOccId",
+ "description": "Identifier of a VNF lifecycle management operation occurrence to be be cancelled. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "post": {
+ "description": "The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled back, i.e. the related \"VNF LCM operation occurrence\" is either in \"PROCESSING\" or \"ROLLING_BACK\" state.\n",
+ "responses": {
+ "202": {
+ "description": "Accepted\nThe request was accepted for processing, but processing has not been completed. The response shall have an empty payload body.\n",
+ "headers": {
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence resource. Typically, this is due to the fact that the operation occurrence is not in STARTING, PROCESSING or ROLLING_BACK state. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions": {
+ "post": {
+ "description": "The POST method creates a new subscription.\n",
+ "parameters": [
+ {
+ "name": "LccnSubscriptionRequest",
+ "description": "Details of the subscription to be created.\n",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "description": "This type represents a subscription request related to notifications about VNF lifecycle changes.\n",
+ "type": "object",
+ "required": [
+ "callbackUri"
+ ],
+ "properties": {
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "VnfLcmOperationOccurrenceNotification",
+ "VnfIdentifierCreationNotification",
+ "VnfIdentifierDeletionNotification"
+ ]
+ }
+ },
+ "operationTypes": {
+ "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ }
+ },
+ "operationStates": {
+ "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ },
+ "authentication": {
+ "type": "object",
+ "required": [
+ "authType"
+ ],
+ "properties": {
+ "authType": {
+ "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. \n* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n* TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "BASIC",
+ "OAUTH2_CLIENT_CREDENTIALS",
+ "TLS_CERT"
+ ]
+ }
+ },
+ "paramsBasic": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "userName": {
+ "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
+ "type": "string"
+ },
+ "password": {
+ "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
+ "type": "string"
+ }
+ }
+ },
+ "paramsOauth2ClientCredentials": {
+ "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.\n",
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "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.\n",
+ "type": "string"
+ },
+ "clientPassword": {
+ "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.\n",
+ "type": "string"
+ },
+ "tokenEndpoint": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created\nThe subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "Location": {
+ "description": "The resource URI of the created VNF instance",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "VnfLcmOperationOccurrenceNotification",
+ "VnfIdentifierCreationNotification",
+ "VnfIdentifierDeletionNotification"
+ ]
+ }
+ },
+ "operationTypes": {
+ "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ }
+ },
+ "operationStates": {
+ "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "description": "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.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nThe list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "VnfLcmOperationOccurrenceNotification",
+ "VnfIdentifierCreationNotification",
+ "VnfIdentifierDeletionNotification"
+ ]
+ }
+ },
+ "operationTypes": {
+ "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ }
+ },
+ "operationStates": {
+ "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nInvalid attribute-based filtering parameters. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}": {
+ "parameters": [
+ {
+ "name": "subscriptionId",
+ "description": "Identifier of this subscription. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
+ "in": "path",
+ "type": "string",
+ "required": true
+ }
+ ],
+ "get": {
+ "description": "The GET method retrieves information about a subscription by reading an individual subscription resource.\n",
+ "responses": {
+ "200": {
+ "description": "OK\nThe operation has completed successfully. The response body shall contain a representation of the subscription resource.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
+ "type": "object",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ },
+ "filter": {
+ "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. 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).\n",
+ "type": "object",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "type": "object",
+ "properties": {
+ "vnfdIds": {
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "description": "Name of the VNF provider to match.\n",
+ "type": "string"
+ },
+ "vnfProducts": {
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "description": "Name of the VNF product to match.\n",
+ "type": "string"
+ },
+ "versions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "description": "A version.\n",
+ "type": "string"
+ },
+ "vnfdVersions": {
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "type": "array",
+ "items": {
+ "description": "A version.\n",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "description": "An identifier with the intention of being globally unique.\n",
+ "type": "string"
+ }
+ },
+ "vnfInstanceNames": {
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "VnfLcmOperationOccurrenceNotification",
+ "VnfIdentifierCreationNotification",
+ "VnfIdentifierDeletionNotification"
+ ]
+ }
+ },
+ "operationTypes": {
+ "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ]
+ }
+ },
+ "operationStates": {
+ "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "type": "array",
+ "items": {
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n",
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ]
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "description": "String formatted according to IETF RFC 3986.\n",
+ "type": "string"
+ },
+ "_links": {
+ "description": "Links to resources related to this resource.\n",
+ "type": "object",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "description": "This type represents a link to a resource.\n",
+ "type": "object",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "description": "URI of the referenced resource.\n",
+ "type": "string",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "description": "The DELETE method terminates an individual subscription.\n",
+ "responses": {
+ "204": {
+ "description": "No Content\nThe subscription resource was deleted successfully. The response body shall be empty.\n",
+ "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.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), 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.\n ---\n\nIf 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.\n ---\n\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ },
+ "WWW-Authenticate": {
+ "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 0
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found\nIf 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. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Not Found\nIf 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.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Not Acceptable\nIf the \"Accept\" HTTP 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 in that case.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error\nIf 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 withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\nIf 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 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
+ "headers": {
+ "Content-Type": {
+ "description": "The MIME type of the body of the response.",
+ "type": "string",
+ "maximum": 1,
+ "minimum": 1
+ }
+ },
+ "schema": {
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "type": "object",
+ "required": [
+ "status",
+ "detail"
+ ],
+ "properties": {
+ "type": {
+ "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\".\n",
+ "type": "string",
+ "format": "URI"
+ },
+ "title": {
+ "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).\n",
+ "type": "string"
+ },
+ "status": {
+ "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.\n",
+ "type": "integer"
+ },
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n",
+ "type": "string"
+ },
+ "instance": {
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "type": "string",
+ "format": "URI"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.yaml b/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.yaml
new file mode 100644
index 00000000..1558df73
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/SOL002-VNFLifecycleManagement-API.yaml
@@ -0,0 +1,33496 @@
+swagger: '2.0'
+info:
+ version: 1.1.1
+ title: SOL002 - VNF Configuration interface
+ description: >
+ VNF Configuration interface of ETSI NFV SOL002
+
+
+ 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/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
+ license:
+ name: ETSI Forge copyright notice
+ url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
+externalDocs:
+ description: ETSI GS NFV-SOL 002 V2.4.1
+ url: >-
+ http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
+basePath: /vnfconfig/v1
+schemes:
+ - http
+ - https
+consumes:
+ - application/json
+produces:
+ - application/json
+paths:
+ /vnf_instances:
+ post:
+ description: The POST method creates a new VNF instance resource.
+ parameters:
+ - name: createVnfRequest
+ description: The VNF creation parameters
+ in: body
+ required: true
+ schema:
+ type: object
+ required:
+ - vnfdId
+ properties:
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: |
+ Human-readable name of the VNF instance to be created.
+ type: string
+ vnfInstanceDescription:
+ description: |
+ Human-readable description of the VNF instance to be created.
+ type: string
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ - name: Content-Type
+ description: |
+ The MIME type of the body of the request. Reference: IETF RFC 7231
+ in: header
+ required: true
+ type: string
+ responses:
+ '201':
+ description: A VNF Instance identifier was created successfully
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ type: string
+ format: url
+ WWW-Authenticate:
+ description: >
+ Created
+
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ Another request is in progress that prohibits the fulfilment of the
+ current request, or the current resource state is inconsistent with
+ the request.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '416':
+ description: >
+ Requested Range Not Satisfiable
+
+ This code is returned if the requested byte range in the Range HTTP
+ header is not present in the requested resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '422':
+ description: >
+ 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. NOTE 2:
+ This error response code is only applicable for methods that have a
+ request body.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ get:
+ description: |
+ The GET method queries information about multiple VNF instances.
+ parameters:
+ - name: Accept
+ description: >
+ Content-Types that are acceptable for the response. Reference: IETF
+ RFC 7231
+ in: header
+ required: true
+ type: string
+ - name: Authorization
+ description: |
+ The authorization token for the request. Reference: IETF RFC 7235
+ in: header
+ required: true
+ type: string
+ responses:
+ '200':
+ description: >
+ OK
+
+ Information about zero or more VNF instances was queried
+ successfully. The response body shall contain representations of
+ zero or more VNF instances.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ type: array
+ items:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified
+ with the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This
+ attribute can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from
+ the VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from
+ the VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <=
+ maxScaleLevel as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been
+ configured (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource
+ that is used by a VNF instance. Information
+ about the resource is available from the
+ VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource
+ that is used by a VNF instance. Information
+ about the resource is available from the
+ VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter,
+ as defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the
+ VNFM (e.g. obtained for autoscaling purposes). The
+ type of the "value" attribute (i.e. scalar,
+ structure (Object in JSON), or array (of scalars,
+ arrays or structures/Objects)) is assumed to be
+ defined in an external measurement specification
+ outside the scope of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should
+ be formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item
+ in the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May
+ be present if the "ipAddress" attribute
+ is present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource
+ that is used by a VNF instance. Information
+ about the resource is available from the
+ VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of
+ being globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used
+ as storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds"
+ and "vnfInstanceNames" are alternatives to reference to
+ particular VNF Instances in a filter. They should not be
+ used both in the same filter instance, but one alternative
+ should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds"
+ and "vnfInstanceNames" are alternatives to reference to
+ particular VNF Instances in a filter. They should not be
+ used both in the same filter instance, but one alternative
+ should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ It fhe request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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. 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ Another request is in progress that prohibits the fulfilment of the
+ current request, or the current resource state is inconsistent with
+ the request.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '416':
+ description: >
+ Requested Range Not Satisfiable
+
+ This code is returned if the requested byte range in the Range HTTP
+ header is not present in the requested resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance. This identifier can be retrieved from
+ the resource referenced by the "Location" HTTP header in the response
+ to a POST request creating a new VNF instance resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ get:
+ description: |
+ Information about an individual VNF instance was queried successfully.
+ responses:
+ '200':
+ description: >
+ OK
+
+ Information about zero or more VNF instances was queried
+ successfully. The response body shall contain representations of
+ zero or more VNF instances.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ Another request is in progress that prohibits the fulfilment of the
+ current request, or the current resource state is inconsistent with
+ the request.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '416':
+ description: >
+ Requested Range Not Satisfiable
+
+ This code is returned if the requested byte range in the Range HTTP
+ header is not present in the requested resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ patch:
+ description: >
+ This method modifies an individual VNF instance resource. Changes to the
+ VNF configurable properties are applied to the configuration in the VNF
+ instance, and are reflected in the representation of this resource.
+ Other changes are applied to the VNF instance information managed by the
+ VNFM, and are reflected in the representation of this resource
+ parameters:
+ - name: vnfInfoModifications
+ description: Input parameters for VNF info modification
+ required: true
+ in: body
+ schema:
+ description: >
+ This type represents attribute modifications that were performed
+ on an "Individual VNF instance" resource. The attributes that can
+ be included consist of those requested to be modified explicitly
+ in the "VnfInfoModificationRequest" data structure, and additional
+ attributes of the "VnfInstance" data structure that were modified
+ implicitly e.g. when modifying the referenced VNF package.
+ type: object
+ properties:
+ vnfInstanceName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceName" attribute in "VnfInstance".
+ type: string
+ vnfInstanceDescription:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceDescription" attribute in "VnfInstance".
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ vimConnectionInfo:
+ description: >
+ If present, this attribute signals modifications of certain
+ entries in the "vimConnectionInfo" attribute array in
+ "VnfInstance".
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - vimType
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimType:
+ 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.
+ type: string
+ interfaceInfo:
+ 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.
+ type: object
+ accessInfo:
+ 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.
+ type: object
+ extra:
+ 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.
+ type: object
+ vnfPkgId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProvider" attribute in "VnfInstance". If present, this
+ attribute (which depends on the value of the "vnfPkgId"
+ attribute) was modified implicitly following a request to
+ modify the "vnfPkgId" attribute, by copying the value of this
+ attribute from the VNFD in the VNF Package identified by the
+ "vnfPkgId†attribute.
+ type: string
+ vnfProductName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProductName" attribute in "VnfInstance". If present, this
+ attribute (which depends on the value of the "vnfPkgId"
+ attribute) was modified implicitly following a request to
+ modify the "vnfPkgId" attribute, by copying the value of this
+ attribute from the VNFD in the VNF Package identified by the
+ "vnfPkgId†attribute.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ It fhe request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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. 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that another LCM operation is ongoing. The response body
+ shall contain a ProblemDetails structure, in which the "detail"
+ attribute should convey more information about the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '412':
+ description: >
+ Precondition Failed
+
+ 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.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ delete:
+ description: |
+ This method deletes an individual VNF instance resource.
+ responses:
+ '204':
+ description: >
+ No Content
+
+ The VNF instance resource and the associated VNF identifier were
+ deleted successfully. The response body shall be empty.
+ headers:
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ It fhe request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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. 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF instance resource is in INSTANTIATED state.
+ The response body shall contain a ProblemDetails structure, in which
+ the "detail" attribute should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '412':
+ description: >
+ Precondition Failed
+
+ 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.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/instantiate':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance. This identifier can be retrieved from
+ the resource referenced by the "Location" HTTP header in the response
+ to a POST request creating a new VNF instance resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method instantiates a VNF instance.
+ parameters:
+ - name: InstantiateVnfRequest
+ description: Parameters for the VNF instantiation.
+ in: body
+ required: true
+ schema:
+ type: object
+ required:
+ - flavourId
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ instantiationLevelId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ extVirtualLinks:
+ description: |
+ Information about external VLs to connect the VNF to.
+ type: array
+ items:
+ description: |
+ This type represents an external VL.
+ type: object
+ required:
+ - id
+ - resourceId
+ - extCps
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ extCps:
+ description: >
+ External CPs of the VNF to be connected to this external
+ VL.
+ type: array
+ items:
+ description: >
+ This type represents configuration information for
+ external CPs created from a CPD.
+ type: object
+ required:
+ - cpdId
+ properties:
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ cpConfig:
+ description: >
+ List of instance data that need to be configured
+ on the CP instances created from the respective
+ CPD.
+ type: array
+ items:
+ 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.
+ type: object
+ properties:
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ linkPortId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ cpProtocolData:
+ 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".
+ type: array
+ items:
+ description: >
+ This type represents network protocol
+ data.
+ type: object
+ required:
+ - layerProtocol
+ properties:
+ layerProtocol:
+ description: >
+ Identifier of layer(s) and protocol(s).
+ This attribute allows to signal the
+ addition of further types of layer and
+ protocol in future versions of the
+ present document in a
+ backwards-compatible way. In the current
+ version of the present document, only IP
+ over Ethernet is supported.
+ type: string
+ enum:
+ - IP_OVER_ETHERNET
+ ipOverEthernet:
+ description: >
+ This type represents network address
+ data for IP over Ethernet.
+ type: object
+ properties:
+ macAddress:
+ description: >
+ A MAC address. Representation: string
+ that consists of groups of two
+ hexadecimal digits, separated by hyphens
+ or colons.
+ type: string
+ format: MAC
+ ipAddresses:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ description: >
+ The type of the IP addresses. Permitted
+ values: IPV4, IPV6.
+ type: string
+ enum:
+ - IPV4
+ - IPV6
+ fixedAddresses:
+ description: >
+ Fixed addresses to assign (from the
+ subnet defined by "subnetId" if
+ provided). Exactly one of
+ "fixedAddresses", "numDynamicAddresses"
+ or "ipAddressRange" shall be present.
+ type: array
+ items:
+ 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.
+ type: string
+ format: IP
+ numDynamicAddresses:
+ 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.
+ type: integer
+ addressRange:
+ 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.
+ type: object
+ required:
+ - minAddress
+ - maxAddress
+ properties:
+ minAddress:
+ 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.
+ type: string
+ format: IP
+ maxAddress:
+ 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.
+ type: string
+ format: IP
+ subnetId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ extLinkPorts:
+ description: >
+ Externally provided link ports to be used to connect
+ external connection points to this external VL. If this
+ attribute is not present, the VNFM shall create the link
+ ports on the external VL.
+ type: array
+ items:
+ description: >
+ This type represents an externally provided link port
+ to be used to connect an external connection point to
+ an external VL.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ extManagedVirtualLinks:
+ description: |
+ Information about external VLs to connect the VNF to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - resourceId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ localizationLanguage:
+ description: >
+ Localization language of the VNF to be instantiated. The value
+ shall comply with the format defined in IETF RFC 5646.
+ type: string
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '200':
+ description: >
+ OK
+
+ Information about zero or more VNF instances was queried
+ successfully. The response body shall contain representations of
+ zero or more VNF instances.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF instance resource is in INSTANTIATED state.
+ The response body shall contain a ProblemDetails structure, in which
+ the "detail" attribute should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '416':
+ description: >
+ Requested Range Not Satisfiable
+
+ This code is returned if the requested byte range in the Range HTTP
+ header is not present in the requested resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/scale':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance to be scaled. This identifier can be
+ retrieved from the resource referenced by the "Location" HTTP header
+ in the response to a POST request creating a new VNF instance
+ resource. It can also be retrieved from the "id" attribute in the
+ payload body of that response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method requests to scale a VNF instance resource incrementally.
+ parameters:
+ - name: ScaleVnfRequest
+ description: Parameters for the scale VNF operation.
+ in: body
+ required: true
+ schema:
+ type: object
+ required:
+ - type
+ - aspectId
+ properties:
+ type:
+ description: >
+ Indicates the type of the scale operation requested. Permitted
+ values: * SCALE_OUT: adding additional VNFC instances to the
+ VNF to increase
+ capacity
+ * SCALE_IN: removing VNFC instances from the VNF in order to
+ release
+ unused capacity.
+ type: string
+ enum:
+ - SCALE_OUT
+ - SCALE_IN
+ aspectId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ numberOfSteps:
+ description: >
+ Number of scaling steps to be executed as part of this Scale
+ VNF operation. It shall be a positive number and the default
+ value shall be 1.
+ type: integer
+ default: 1
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF
+ instance represented by the parent resource, and that the task
+ resource consequently does not exist. The "ProblemDetails" structure
+ may be provided, including in the "detail" attribute information
+ about the sourceof the problem, e.g. a wrong resource URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/scale_to_level':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance to be scaled to a target level. This
+ identifier can be retrieved from the resource referenced by the
+ "Location" HTTP header in the response to a POST request creating a
+ new VNF instance resource. It can also be retrieved from the "id"
+ attribute in the payload body of that response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: >
+ The POST method requests to scale a VNF instance resource to a target
+ level.
+ parameters:
+ - name: ScaleVnfToLevelRequest
+ description: Parameters for the scale VNF to Level operation.
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents request parameters for the "Scale VNF to
+ Level" operation.
+ type: object
+ properties:
+ instantiationLevelId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ scaleInfo:
+ description: >
+ For each scaling aspect of the current deployment flavour,
+ indicates the target scale level to which the VNF is to be
+ scaled. Either the instantiationLevelId attribute or the
+ scaleInfo attribute shall be included.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall be 0
+ and the maximum value shall be <= maxScaleLevel as
+ described in the VNFD.
+ type: integer
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF
+ instance represented by the parent resource, and that the task
+ resource consequently does not exist. The "ProblemDetails" structure
+ may be provided, including in the "detail" attribute information
+ about the sourceof the problem, e.g. a wrong resource URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/change_flavour':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ The identifier of the VNF instance of which the deployment flavour is
+ requested to be changed. This identifier can be retrieved from the
+ resource referenced by the "Location" HTTP header in the response to a
+ POST request creating a new VNF instance resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method changes the deployment flavour of a VNF instance.
+ parameters:
+ - name: ChangeVnfFlavourRequest
+ description: Parameters for the Change VNF Flavour operation.
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents request parameters for the "Change VNF
+ flavour" operation.
+ type: object
+ required:
+ - newFlavourId
+ properties:
+ newFlavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ instantiationLevelId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ extVirtualLinks:
+ description: |
+ Information about external VLs to connect the VNF to.
+ type: array
+ items:
+ description: |
+ This type represents an external VL.
+ type: object
+ required:
+ - id
+ - resourceId
+ - extCps
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ extCps:
+ description: >
+ External CPs of the VNF to be connected to this external
+ VL.
+ type: array
+ items:
+ description: >
+ This type represents configuration information for
+ external CPs created from a CPD.
+ type: object
+ required:
+ - cpdId
+ properties:
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ cpConfig:
+ description: >
+ List of instance data that need to be configured
+ on the CP instances created from the respective
+ CPD.
+ type: array
+ items:
+ 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.
+ type: object
+ properties:
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ linkPortId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ cpProtocolData:
+ 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".
+ type: array
+ items:
+ description: >
+ This type represents network protocol
+ data.
+ type: object
+ required:
+ - layerProtocol
+ properties:
+ layerProtocol:
+ description: >
+ Identifier of layer(s) and protocol(s).
+ This attribute allows to signal the
+ addition of further types of layer and
+ protocol in future versions of the
+ present document in a
+ backwards-compatible way. In the current
+ version of the present document, only IP
+ over Ethernet is supported.
+ type: string
+ enum:
+ - IP_OVER_ETHERNET
+ ipOverEthernet:
+ description: >
+ This type represents network address
+ data for IP over Ethernet.
+ type: object
+ properties:
+ macAddress:
+ description: >
+ A MAC address. Representation: string
+ that consists of groups of two
+ hexadecimal digits, separated by hyphens
+ or colons.
+ type: string
+ format: MAC
+ ipAddresses:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ description: >
+ The type of the IP addresses. Permitted
+ values: IPV4, IPV6.
+ type: string
+ enum:
+ - IPV4
+ - IPV6
+ fixedAddresses:
+ description: >
+ Fixed addresses to assign (from the
+ subnet defined by "subnetId" if
+ provided). Exactly one of
+ "fixedAddresses", "numDynamicAddresses"
+ or "ipAddressRange" shall be present.
+ type: array
+ items:
+ 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.
+ type: string
+ format: IP
+ numDynamicAddresses:
+ 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.
+ type: integer
+ addressRange:
+ 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.
+ type: object
+ required:
+ - minAddress
+ - maxAddress
+ properties:
+ minAddress:
+ 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.
+ type: string
+ format: IP
+ maxAddress:
+ 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.
+ type: string
+ format: IP
+ subnetId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ extLinkPorts:
+ description: >
+ Externally provided link ports to be used to connect
+ external connection points to this external VL. If this
+ attribute is not present, the VNFM shall create the link
+ ports on the external VL.
+ type: array
+ items:
+ description: >
+ This type represents an externally provided link port
+ to be used to connect an external connection point to
+ an external VL.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ extManagedVirtualLinks:
+ description: |
+ Information about external VLs to connect the VNF to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - resourceId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF
+ instance represented by the parent resource, and that the task
+ resource consequently does not exist. The "ProblemDetails" structure
+ may be provided, including in the "detail" attribute information
+ about the sourceof the problem, e.g. a wrong resource URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/terminate':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ The identifier of the VNF instance to be terminated. This identifier
+ can be retrieved from the resource referenced by the "Location" HTTP
+ header in the response to a POST request creating a new VNF instance
+ resource. It can also be retrieved from the "id" attribute in the
+ payload body of that response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method terminates a VNF instance.
+ parameters:
+ - name: TerminateVnfRequest
+ description: Parameters for the VNF termination.
+ in: body
+ required: true
+ schema:
+ type: object
+ required:
+ - terminationType
+ properties:
+ terminationType:
+ description: >
+ Indicates the type of termination is requested. Permitted
+ values: * FORCEFUL: The VNFM will shut down the VNF and
+ release the
+ resources immediately after accepting the request.
+ type: string
+ enum:
+ - FORCEFUL
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/heal':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance to be healed. This identifier can be
+ retrieved from the resource referenced by the "Location" HTTP header
+ in the response to a POST request creating a new VNF instance
+ resource. It can also be retrieved from the "id" attribute in the
+ payload body of that response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method requests to heal a VNF instance resource.
+ parameters:
+ - name: HealVnfRequest
+ description: Parameters for the Heal VNF operation.
+ in: body
+ required: true
+ schema:
+ type: object
+ properties:
+ cause:
+ description: |
+ Indicates the reason why a healing procedure is required.
+ type: string
+ vnfcInstanceId:
+ description: TBD
+ type: string
+ healScript:
+ description: TBD
+ type: string
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF
+ instance represented by the parent resource, and that the task
+ resource consequently does not exist. The "ProblemDetails" structure
+ may be provided, including in the "detail" attribute information
+ about the sourceof the problem, e.g. a wrong resource URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/operate':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance to be operated. This identifier can be
+ retrieved from the resource referenced by the "Location" HTTP header
+ in the response to a POST request creating a new VNF instance
+ resource. It can also be retrieved from the "id" attribute in the
+ payload body of that response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: >
+ The POST method changes the operational state of a VNF instance
+ resource.
+ parameters:
+ - name: OperateVnfRequest
+ description: Parameters for the Operate VNF operation.
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents request parameters for the "Operate VNF"
+ operation.
+ type: object
+ required:
+ - changeStateTo
+ properties:
+ changeStateTo:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ stopType:
+ 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.
+ type: string
+ enum:
+ - FORCEFUL
+ - GRACEFUL
+ vnfcInstanceId:
+ description: TBD
+ type: string
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF
+ instance represented by the parent resource, and that the task
+ resource consequently does not exist. The "ProblemDetails" structure
+ may be provided, including in the "detail" attribute information
+ about the sourceof the problem, e.g. a wrong resource URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF 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 should convey more information about the
+ error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_instances/{vnfInstanceId}/change_ext_vls':
+ parameters:
+ - name: vnfInstanceId
+ description: >
+ Identifier of the VNF instance of which the external connectivity is
+ requested to be changed. This identifier can be retrieved from the
+ resource referenced by the "Location" HTTP header in the response to a
+ POST request creating a new VNF instance resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ post:
+ description: |
+ The POST method changes the external connectivity of a VNF instance.
+ parameters:
+ - name: ChangeExtVnfConnectivityRequest
+ description: |
+ Parameters for the Change external VNF connectivity operation.
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents request parameters for the "Change external
+ VNF connectivity" operation to modify the external connectivity of
+ a VNF instance.
+ type: object
+ required:
+ - extVirtualLinks
+ properties:
+ extVirtualLinks:
+ description: >
+ Information about external VLs to change (e.g. connect the VNF
+ to).
+ type: array
+ items:
+ description: |
+ This type represents an external VL.
+ type: object
+ required:
+ - id
+ - resourceId
+ - extCps
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other resource
+ provider. It is expected to be unique within the VIM
+ instance.
+ type: string
+ extCps:
+ description: >
+ External CPs of the VNF to be connected to this external
+ VL.
+ type: array
+ items:
+ description: >
+ This type represents configuration information for
+ external CPs created from a CPD.
+ type: object
+ required:
+ - cpdId
+ properties:
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ cpConfig:
+ description: >
+ List of instance data that need to be configured
+ on the CP instances created from the respective
+ CPD.
+ type: array
+ items:
+ 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.
+ type: object
+ properties:
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but
+ may not be globally unique.
+ type: string
+ linkPortId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ cpProtocolData:
+ 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".
+ type: array
+ items:
+ description: >
+ This type represents network protocol
+ data.
+ type: object
+ required:
+ - layerProtocol
+ properties:
+ layerProtocol:
+ description: >
+ Identifier of layer(s) and protocol(s).
+ This attribute allows to signal the
+ addition of further types of layer and
+ protocol in future versions of the
+ present document in a
+ backwards-compatible way. In the current
+ version of the present document, only IP
+ over Ethernet is supported.
+ type: string
+ enum:
+ - IP_OVER_ETHERNET
+ ipOverEthernet:
+ description: >
+ This type represents network address
+ data for IP over Ethernet.
+ type: object
+ properties:
+ macAddress:
+ description: >
+ A MAC address. Representation: string
+ that consists of groups of two
+ hexadecimal digits, separated by hyphens
+ or colons.
+ type: string
+ format: MAC
+ ipAddresses:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ description: >
+ The type of the IP addresses. Permitted
+ values: IPV4, IPV6.
+ type: string
+ enum:
+ - IPV4
+ - IPV6
+ fixedAddresses:
+ description: >
+ Fixed addresses to assign (from the
+ subnet defined by "subnetId" if
+ provided). Exactly one of
+ "fixedAddresses", "numDynamicAddresses"
+ or "ipAddressRange" shall be present.
+ type: array
+ items:
+ 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.
+ type: string
+ format: IP
+ numDynamicAddresses:
+ 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.
+ type: integer
+ addressRange:
+ 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.
+ type: object
+ required:
+ - minAddress
+ - maxAddress
+ properties:
+ minAddress:
+ 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.
+ type: string
+ format: IP
+ maxAddress:
+ 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.
+ type: string
+ format: IP
+ subnetId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected
+ to be unique within the VIM instance.
+ type: string
+ extLinkPorts:
+ description: >
+ Externally provided link ports to be used to connect
+ external connection points to this external VL. If this
+ attribute is not present, the VNFM shall create the link
+ ports on the external VL.
+ type: array
+ items:
+ description: >
+ This type represents an externally provided link port
+ to be used to connect an external connection point to
+ an external VL.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ additionalParams:
+ 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.
+ type: object
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but the processing has not
+ been completed. On success, the HTTP response shall include a
+ "Location" HTTP header that contains the URI of the newly-created
+ "VNF LCM operation occurrence" resource corresponding to the
+ operation.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: |
+ This type represents a VNF instance.
+ type: object
+ required:
+ - id
+ - vnfdId
+ - vnfProvider
+ - vnfProductName
+ - vnfSoftwareVersion
+ - vnfdVersion
+ - onboardedVnfPkgInfoId
+ - instantiationState
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceName:
+ description: >
+ Name of the VNF instance. This attribute can be modified with
+ the PATCH method.
+ type: string
+ vnfInstanceDescription:
+ description: >
+ Human-readable description of the VNF instance. This attribute
+ can be modified with the PATCH method.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ Provider of the VNF and the VNFD. The value is copied from the
+ VNFD.
+ type: string
+ vnfProductName:
+ description: >
+ Name to identify the VNF Product. The value is copied from the
+ VNFD.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ onboardedVnfPkgInfoId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ instantiationState:
+ description: |
+ The instantiation state of the VNF.
+ type: string
+ enum:
+ - NOT_INSTANTIATED
+ - INSTANTIATED
+ instantiatedVnfInfo:
+ type: object
+ required:
+ - flavourId
+ - vnfState
+ properties:
+ flavourId:
+ description: |
+ An identifier that is unique within a VNF descriptor.
+ type: string
+ vnfState:
+ type: string
+ enum:
+ - STARTED
+ - STOPPED
+ scaleStatus:
+ 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.
+ type: array
+ items:
+ required:
+ - aspectId
+ - scaleLevel
+ type: object
+ properties:
+ aspectId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ scaleLevel:
+ description: >
+ Indicates the scale level. The minimum value shall
+ be 0 and the maximum value shall be <= maxScaleLevel
+ as described in the VNFD.
+ type: integer
+ extCpInfo:
+ description: >
+ Information about the external CPs exposed by the VNF
+ instance.
+ type: array
+ minItems: 1
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ addresses:
+ description: >
+ List of network addresses that have been configured
+ (statically or dynamically) on the CP.
+ type: array
+ items:
+ description: >
+ This type represents information about a network
+ address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in which
+ the IP address was assigned. May be present if
+ the "ipAddress" attribute is present, and
+ shall be absent if the "ipAddress" attribute
+ is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ extVirtualLinkInfo:
+ description: >
+ Information about the external VLs the VNF instance is
+ connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ extManagedVirtualLinkInfo:
+ description: |
+ External virtual links the VNF instance is connected to.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - vnfVirtualLinkDescId
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfVirtualLinkDescId:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ vnfLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ monitoringParameters:
+ description: |
+ Active monitoring parameters.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - value
+ - timeStamp
+ properties:
+ id:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ name:
+ description: >
+ Human readable name of the monitoring parameter, as
+ defined in the VNFD.
+ type: string
+ value:
+ description: >
+ Value of the monitoring parameter known to the VNFM
+ (e.g. obtained for autoscaling purposes). The type
+ of the "value" attribute (i.e. scalar, structure
+ (Object in JSON), or array (of scalars, arrays or
+ structures/Objects)) is assumed to be defined in an
+ external measurement specification outside the scope
+ of the present document.
+ type: object
+ timeStamp:
+ description: >
+ Represents the point in time when the measurement
+ has been performed, as known to the VNFM. Should be
+ formatted according to ETF RFC 3339.
+ type: string
+ localizationLanguage:
+ 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.
+ type: string
+ vnfcResourceInfo:
+ description: >
+ Information about the virtualised compute and storage
+ resources used by the VNFCs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information on virtualised
+ compute and storage resources used by a VNFC in a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - vduId
+ - computeResource
+ - vnfcCpInfo
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ storageResourceIds:
+ description: >
+ References to the VirtualStorage resources. The
+ value refers to a VirtualStorageResourceInfo item in
+ the VnfInstance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfcCpInfo:
+ 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.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - cpdId
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ cpdId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ vnfExtCpId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ addresses:
+ description: >
+ This type represents information about a
+ network address that has been assigned.
+ type: object
+ required:
+ - macAddress
+ properties:
+ macAddress:
+ description: |
+ Assigned MAC address.
+ type: string
+ ipAddress:
+ description: >
+ IP address. Present if an IP address was
+ assigned.
+ type: string
+ subnetIpRanges:
+ description: >
+ IP address ranges defining the subnet in
+ which the IP address was assigned. May be
+ present if the "ipAddress" attribute is
+ present, and shall be absent if the
+ "ipAddress" attribute is not present.
+ type: array
+ items:
+ type: object
+ required:
+ - minIpAddress
+ - maxIpAddress
+ properties:
+ minIpAddress:
+ description: >
+ Lowest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ maxIpAddress:
+ description: >
+ Highest IP address belonging to the
+ range.
+ type: string
+ format: ipaddress
+ metadata:
+ 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.
+ type: object
+ virtualLinkResourceInfo:
+ description: >
+ Information about the virtualised network resources used
+ by the VLs of the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by an
+ internal VL instance in a VNF instance.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - networkResource
+ - vnfLinkPorts
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfLinkPorts:
+ description: >
+ Links ports of this VL. Shall be present when the
+ linkPort is used for external connectivity by the
+ VNF (refer to VnfLinkPort). May be present
+ otherwise.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that
+ allows addressing a virtualised resource that
+ is used by a VNF instance. Information about
+ the resource is available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or
+ other resource provider. It is expected to
+ be unique within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the
+ VIM or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the
+ respective type within a VNF instance, but may
+ not be globally unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ virtualStorageResourceInfo:
+ description: >
+ Information on the virtualised storage resource(s) used as
+ storage for the VNF instance.
+ type: array
+ items:
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ reservationId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ metadata:
+ 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.
+ type: object
+ vnfcInfo:
+ description: TBD
+ type: string
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ indicators:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ instantiate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ terminate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scale:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ scaleToLevel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeFlavour:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ heal:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ operate:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ changeExtConn:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance identifier
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance Name
+ listed in this attribute. The attributes "vnfInstanceIds" and
+ "vnfInstanceNames" are alternatives to reference to particular
+ VNF Instances in a filter. They should not be used both in the
+ same filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that another LCM operation is ongoing. The response body
+ shall contain a ProblemDetails structure, in which the "detail"
+ attribute should convey more information about the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ /vnf_lcm_op_occs:
+ get:
+ description: >
+ The client can use this method to query status information about
+ multiple VNF lifecycle management operation occurrences.
+ responses:
+ '200':
+ description: >
+ OK
+
+ Status information for zero or more VNF lifecycle management
+ operation occurrences was queried successfully. The response body
+ shall contain status information about zero or more VNF lifecycle
+ operation occurrences.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a VNF lifecycle management operation
+ occurrence.
+ type: object
+ required:
+ - id
+ - operationState
+ - stateEnteredTime
+ - startTime
+ - vnfInstanceId
+ - operation
+ - isAutomaticInvocation
+ - operationParams
+ - isCancelPending
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operationState:
+ description: >
+ Value | Description ------|------------ STARTING | The LCM
+ operation is starting. PROCESSING | The LCM operation is
+ currently in execution. COMPLETED | he LCM operation has been
+ completed successfully. 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.
+ ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ stateEnteredTime:
+ description: |
+ Date-time when the current state was entered.
+ type: string
+ format: date-time
+ startTime:
+ description: |
+ Date-time of the start of the operation.
+ type: string
+ format: date-time
+ vnfInstanceId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ grantId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operation:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE |
+ Represents the "Scale VNF" LCM operation. SCALE_TO_LEVEL |
+ Represents the "Scale VNF to Level" LCM operation.
+ CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM
+ operation. TERMINATE | Represents the "Terminate VNF" LCM
+ operation. HEAL | Represents the "Heal VNF" LCM operation.
+ OPERATE | Represents the "Operate VNF" LCM operation.
+ CHANGE_EXT_CONN | Represents the "Change external VNF
+ connectivity" LCM operation. MODIFY_INFO | Represents the
+ "Modify VNF Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ isAutomaticInvocation:
+ description: >
+ Set to true if this VNF LCM operation occurrence has been
+ triggered by an automated procedure inside the VNFM (i.e.
+ ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
+ triggered by auto-heal). Set to false otherwise.
+ type: boolean
+ operationParams:
+ 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.
+ type: object
+ isCancelPending:
+ description: >
+ If the VNF LCM operation occurrence is in "STARTING",
+ "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.
+ type: boolean
+ cancelMode:
+ description: >
+ Cancellation mode. GRACEFUL: The VNFM shall not start any new
+ resource management operation and shall wait for the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, to finish execution or to time out. After
+ that, the VNFM shall put the operation occurrence into the
+ FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new
+ resource management operation, shall cancel the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, and shall wait for the cancellation to
+ finish or to time out. After that, the VNFM shall put the
+ operation occurrence into the FAILED_TEMP state.
+ type: string
+ enum:
+ - GRACEFUL
+ - FORCEFUL
+ error:
+ description: >
+ The definition of the general "ProblemDetails" data structure
+ from IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence
+ of the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of
+ the problem. It may yield further information if
+ dereferenced.
+ type: string
+ format: URI
+ resourceChanges:
+ 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.
+ type: object
+ properties:
+ affectedVnfcs:
+ description: >
+ Information about VNFC instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VNFCs.
+ type: object
+ required:
+ - id
+ - vduId
+ - changeType
+ - computeResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVnfc structure exists
+ as long as the temporary resource exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVnfcCpIds:
+ description: >
+ Identifiers of CP(s) of the VNFC instance that were
+ affected by the change. Shall be present for those
+ affected CPs of the VNFC instance that are
+ associated to an external CP of the VNF instance.
+ May be present for further affected CPs of the VNFC
+ instance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ addedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been added. Each value refers to a
+ VirtualStorageResourceInfo item in the VnfInstance
+ that was added to the VNFC. It shall be provided if
+ at least one storage resource was added to the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ removedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been removed. The value contains the identifier of a
+ VirtualStorageResourceInfo item that has been
+ removed from the VNFC, and might no longer exist in
+ the VnfInstance. It shall be provided if at least
+ one storage resource was removed from the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ affectedVirtualLinks:
+ description: >
+ Information about VL instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VLs.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - changeType
+ - networkResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ 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.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ - LINK_PORT_ADDED
+ - LINK_PORT_REMOVED
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVirtualStorages:
+ description: >
+ Information about virtualised storage instances that were
+ affected during the lifecycle operation. This allows the
+ NFVO to obtain the information contained in the latest
+ "result" notification if it has not received it due to an
+ error or a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary virtual storage resources.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - changeType
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVirtualStorage
+ structure exists as long as the temporary resource
+ exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ changedInfo:
+ description: >
+ This type represents attribute modifications that were
+ performed on an "Individual VNF instance" resource. The
+ attributes that can be included consist of those requested to
+ be modified explicitly in the "VnfInfoModificationRequest"
+ data structure, and additional attributes of the "VnfInstance"
+ data structure that were modified implicitly e.g. when
+ modifying the referenced VNF package.
+ type: object
+ properties:
+ vnfInstanceName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceName" attribute in "VnfInstance".
+ type: string
+ vnfInstanceDescription:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceDescription" attribute in "VnfInstance".
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ vimConnectionInfo:
+ description: >
+ If present, this attribute signals modifications of
+ certain entries in the "vimConnectionInfo" attribute array
+ in "VnfInstance".
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - vimType
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimType:
+ 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.
+ type: string
+ interfaceInfo:
+ 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.
+ type: object
+ accessInfo:
+ 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.
+ type: object
+ extra:
+ 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.
+ type: object
+ vnfPkgId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProvider" attribute in "VnfInstance". If present, this
+ attribute (which depends on the value of the "vnfPkgId"
+ attribute) was modified implicitly following a request to
+ modify the "vnfPkgId" attribute, by copying the value of
+ this attribute from the VNFD in the VNF Package identified
+ by the "vnfPkgId†attribute.
+ type: string
+ vnfProductName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProductName" attribute in "VnfInstance". If present,
+ this attribute (which depends on the value of the
+ "vnfPkgId" attribute) was modified implicitly following a
+ request to modify the "vnfPkgId" attribute, by copying the
+ value of this attribute from the VNFD in the VNF Package
+ identified by the "vnfPkgId†attribute.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ changedExtConnectivity:
+ description: >
+ Information about changed external connectivity, if
+ applicable. This allows the NFVO to obtain the information
+ contained in the latest "result" notification if it has not
+ received it due to an error or a wrongly configured
+ subscription filter.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance. Information about the resource is available
+ from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or the
+ resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ - vnfInstance
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstance:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ grant:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ cancel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ retry:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ rollback:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ fail:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ Another request is in progress that prohibits the fulfilment of the
+ current request, or the current resource state is inconsistent with
+ the request.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_lcm_op_occs/{vnfLcmOpOccId}':
+ parameters:
+ - name: vnfLcmOpOccId
+ description: >
+ Identifier of a VNF lifecycle management operation occurrence. This
+ identifier can be retrieved from the resource referenced by the
+ "Location" HTTP header in the response to a PATCH or POST request
+ triggering a VNF LCM operation. It can also be retrieved from the
+ "vnfLcmOpOccId" attribute in the
+ VnfLcmOperationOccurrenceNotification.
+ in: path
+ required: true
+ type: string
+ get:
+ description: >
+ The client can use this method to retrieve status information about a
+ VNF lifecycle management operation occurrence by reading an individual
+ "VNF LCM operation occurrence" resource.
+ responses:
+ '200':
+ description: >
+ OK
+
+ Information about an individual VNF instance was queried
+ successfully. The response body shall contain status information
+ about a VNF lifecycle management operation occurrence.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a VNF lifecycle management operation
+ occurrence.
+ type: object
+ required:
+ - id
+ - operationState
+ - stateEnteredTime
+ - startTime
+ - vnfInstanceId
+ - operation
+ - isAutomaticInvocation
+ - operationParams
+ - isCancelPending
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operationState:
+ description: >
+ Value | Description ------|------------ STARTING | The LCM
+ operation is starting. PROCESSING | The LCM operation is
+ currently in execution. COMPLETED | he LCM operation has been
+ completed successfully. 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.
+ ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ stateEnteredTime:
+ description: |
+ Date-time when the current state was entered.
+ type: string
+ format: date-time
+ startTime:
+ description: |
+ Date-time of the start of the operation.
+ type: string
+ format: date-time
+ vnfInstanceId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ grantId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operation:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE |
+ Represents the "Scale VNF" LCM operation. SCALE_TO_LEVEL |
+ Represents the "Scale VNF to Level" LCM operation.
+ CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM
+ operation. TERMINATE | Represents the "Terminate VNF" LCM
+ operation. HEAL | Represents the "Heal VNF" LCM operation.
+ OPERATE | Represents the "Operate VNF" LCM operation.
+ CHANGE_EXT_CONN | Represents the "Change external VNF
+ connectivity" LCM operation. MODIFY_INFO | Represents the
+ "Modify VNF Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ isAutomaticInvocation:
+ description: >
+ Set to true if this VNF LCM operation occurrence has been
+ triggered by an automated procedure inside the VNFM (i.e.
+ ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
+ triggered by auto-heal). Set to false otherwise.
+ type: boolean
+ operationParams:
+ 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.
+ type: object
+ isCancelPending:
+ description: >
+ If the VNF LCM operation occurrence is in "STARTING",
+ "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.
+ type: boolean
+ cancelMode:
+ description: >
+ Cancellation mode. GRACEFUL: The VNFM shall not start any new
+ resource management operation and shall wait for the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, to finish execution or to time out. After
+ that, the VNFM shall put the operation occurrence into the
+ FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new
+ resource management operation, shall cancel the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, and shall wait for the cancellation to
+ finish or to time out. After that, the VNFM shall put the
+ operation occurrence into the FAILED_TEMP state.
+ type: string
+ enum:
+ - GRACEFUL
+ - FORCEFUL
+ error:
+ description: >
+ The definition of the general "ProblemDetails" data structure
+ from IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence
+ of the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of
+ the problem. It may yield further information if
+ dereferenced.
+ type: string
+ format: URI
+ resourceChanges:
+ 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.
+ type: object
+ properties:
+ affectedVnfcs:
+ description: >
+ Information about VNFC instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VNFCs.
+ type: object
+ required:
+ - id
+ - vduId
+ - changeType
+ - computeResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVnfc structure exists
+ as long as the temporary resource exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVnfcCpIds:
+ description: >
+ Identifiers of CP(s) of the VNFC instance that were
+ affected by the change. Shall be present for those
+ affected CPs of the VNFC instance that are
+ associated to an external CP of the VNF instance.
+ May be present for further affected CPs of the VNFC
+ instance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ addedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been added. Each value refers to a
+ VirtualStorageResourceInfo item in the VnfInstance
+ that was added to the VNFC. It shall be provided if
+ at least one storage resource was added to the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ removedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been removed. The value contains the identifier of a
+ VirtualStorageResourceInfo item that has been
+ removed from the VNFC, and might no longer exist in
+ the VnfInstance. It shall be provided if at least
+ one storage resource was removed from the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ affectedVirtualLinks:
+ description: >
+ Information about VL instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VLs.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - changeType
+ - networkResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ 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.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ - LINK_PORT_ADDED
+ - LINK_PORT_REMOVED
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVirtualStorages:
+ description: >
+ Information about virtualised storage instances that were
+ affected during the lifecycle operation. This allows the
+ NFVO to obtain the information contained in the latest
+ "result" notification if it has not received it due to an
+ error or a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary virtual storage resources.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - changeType
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVirtualStorage
+ structure exists as long as the temporary resource
+ exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ changedInfo:
+ description: >
+ This type represents attribute modifications that were
+ performed on an "Individual VNF instance" resource. The
+ attributes that can be included consist of those requested to
+ be modified explicitly in the "VnfInfoModificationRequest"
+ data structure, and additional attributes of the "VnfInstance"
+ data structure that were modified implicitly e.g. when
+ modifying the referenced VNF package.
+ type: object
+ properties:
+ vnfInstanceName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceName" attribute in "VnfInstance".
+ type: string
+ vnfInstanceDescription:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceDescription" attribute in "VnfInstance".
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ vimConnectionInfo:
+ description: >
+ If present, this attribute signals modifications of
+ certain entries in the "vimConnectionInfo" attribute array
+ in "VnfInstance".
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - vimType
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimType:
+ 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.
+ type: string
+ interfaceInfo:
+ 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.
+ type: object
+ accessInfo:
+ 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.
+ type: object
+ extra:
+ 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.
+ type: object
+ vnfPkgId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProvider" attribute in "VnfInstance". If present, this
+ attribute (which depends on the value of the "vnfPkgId"
+ attribute) was modified implicitly following a request to
+ modify the "vnfPkgId" attribute, by copying the value of
+ this attribute from the VNFD in the VNF Package identified
+ by the "vnfPkgId†attribute.
+ type: string
+ vnfProductName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProductName" attribute in "VnfInstance". If present,
+ this attribute (which depends on the value of the
+ "vnfPkgId" attribute) was modified implicitly following a
+ request to modify the "vnfPkgId" attribute, by copying the
+ value of this attribute from the VNFD in the VNF Package
+ identified by the "vnfPkgId†attribute.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ changedExtConnectivity:
+ description: >
+ Information about changed external connectivity, if
+ applicable. This allows the NFVO to obtain the information
+ contained in the latest "result" notification if it has not
+ received it due to an error or a wrongly configured
+ subscription filter.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance. Information about the resource is available
+ from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or the
+ resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ - vnfInstance
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstance:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ grant:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ cancel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ retry:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ rollback:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ fail:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ Another request is in progress that prohibits the fulfilment of the
+ current request, or the current resource state is inconsistent with
+ the request.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry':
+ parameters:
+ - name: vnfLcmOpOccId
+ description: >
+ Identifier of a VNF 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 PATCH or POST
+ request triggering a VNF LCM operation. It can also be retrieved from
+ the "vnfLcmOpOccId" attribute in the
+ VnfLcmOperationOccurrenceNotification.
+ in: path
+ required: true
+ type: string
+ post:
+ description: >
+ The POST method initiates retrying a VNF lifecycle operation if that
+ operation has experienced a temporary failure, i.e. the related "VNF LCM
+ operation occurrence" resource is in "FAILED_TEMP" state.
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but processing has not been
+ completed. The response shall have an empty payload body.
+ headers:
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF instance resource is not in FAILED_TEMP state,
+ or another error handling action is starting, such as rollback or
+ fail. The response body shall contain a ProblemDetails structure, in
+ which the "detail" attribute should convey more information about
+ the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback':
+ parameters:
+ - name: vnfLcmOpOccId
+ description: >
+ Identifier of a VNF lifecycle management operation occurrence to be be
+ rolled back. This identifier can be retrieved from the resource
+ referenced by the "Location" HTTP header in the response to a PATCH or
+ POST request triggering a VNF LCM operation. It can also be retrieved
+ from the "vnfLcmOpOccId" attribute in the
+ VnfLcmOperationOccurrenceNotification.
+ in: path
+ required: true
+ type: string
+ post:
+ description: >
+ The POST method initiates rolling back a VNF lifecycle operation if that
+ operation has experienced a temporary failure, i.e. the related "VNF LCM
+ operation occurrence" resource is in "FAILED_TEMP" state.
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but processing has not been
+ completed. The response shall have an empty payload body.
+ headers:
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF instance resource is not in FAILED_TEMP state,
+ or another error handling action is starting, such as rollback or
+ fail. The response body shall contain a ProblemDetails structure, in
+ which the "detail" attribute should convey more information about
+ the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail':
+ parameters:
+ - name: vnfLcmOpOccId
+ description: >
+ Identifier of a VNF lifecycle management operation occurrence to be be
+ marked as "failed". This identifier can be retrieved from the resource
+ referenced by the "Location" HTTP header in the response to a PATCH or
+ POST request triggering a VNF LCM operation. It can also be retrieved
+ from the "vnfLcmOpOccId" attribute in the
+ VnfLcmOperationOccurrenceNotification.
+ in: path
+ required: true
+ type: string
+ post:
+ description: >
+ The POST method marks a VNF lifecycle management operation occurrence as
+ "finally failed" if that operation occurrence is in "FAILED_TEMP" state.
+ responses:
+ '200':
+ description: >
+ OK
+
+ The state of the VNF lifecycle management operation occurrence was
+ changed successfully. The response shall include a representation of
+ the VNF lifecycle operation occurrence resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a VNF lifecycle management operation
+ occurrence.
+ type: object
+ required:
+ - id
+ - operationState
+ - stateEnteredTime
+ - startTime
+ - vnfInstanceId
+ - operation
+ - isAutomaticInvocation
+ - operationParams
+ - isCancelPending
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operationState:
+ description: >
+ Value | Description ------|------------ STARTING | The LCM
+ operation is starting. PROCESSING | The LCM operation is
+ currently in execution. COMPLETED | he LCM operation has been
+ completed successfully. 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.
+ ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ stateEnteredTime:
+ description: |
+ Date-time when the current state was entered.
+ type: string
+ format: date-time
+ startTime:
+ description: |
+ Date-time of the start of the operation.
+ type: string
+ format: date-time
+ vnfInstanceId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ grantId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ operation:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE |
+ Represents the "Scale VNF" LCM operation. SCALE_TO_LEVEL |
+ Represents the "Scale VNF to Level" LCM operation.
+ CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM
+ operation. TERMINATE | Represents the "Terminate VNF" LCM
+ operation. HEAL | Represents the "Heal VNF" LCM operation.
+ OPERATE | Represents the "Operate VNF" LCM operation.
+ CHANGE_EXT_CONN | Represents the "Change external VNF
+ connectivity" LCM operation. MODIFY_INFO | Represents the
+ "Modify VNF Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ isAutomaticInvocation:
+ description: >
+ Set to true if this VNF LCM operation occurrence has been
+ triggered by an automated procedure inside the VNFM (i.e.
+ ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
+ triggered by auto-heal). Set to false otherwise.
+ type: boolean
+ operationParams:
+ 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.
+ type: object
+ isCancelPending:
+ description: >
+ If the VNF LCM operation occurrence is in "STARTING",
+ "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.
+ type: boolean
+ cancelMode:
+ description: >
+ Cancellation mode. GRACEFUL: The VNFM shall not start any new
+ resource management operation and shall wait for the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, to finish execution or to time out. After
+ that, the VNFM shall put the operation occurrence into the
+ FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new
+ resource management operation, shall cancel the ongoing
+ resource management operations in the underlying system,
+ typically the VIM, and shall wait for the cancellation to
+ finish or to time out. After that, the VNFM shall put the
+ operation occurrence into the FAILED_TEMP state.
+ type: string
+ enum:
+ - GRACEFUL
+ - FORCEFUL
+ error:
+ description: >
+ The definition of the general "ProblemDetails" data structure
+ from IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence
+ of the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of
+ the problem. It may yield further information if
+ dereferenced.
+ type: string
+ format: URI
+ resourceChanges:
+ 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.
+ type: object
+ properties:
+ affectedVnfcs:
+ description: >
+ Information about VNFC instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VNFCs.
+ type: object
+ required:
+ - id
+ - vduId
+ - changeType
+ - computeResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ vduId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVnfc structure exists
+ as long as the temporary resource exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ computeResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVnfcCpIds:
+ description: >
+ Identifiers of CP(s) of the VNFC instance that were
+ affected by the change. Shall be present for those
+ affected CPs of the VNFC instance that are
+ associated to an external CP of the VNF instance.
+ May be present for further affected CPs of the VNFC
+ instance.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ addedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been added. Each value refers to a
+ VirtualStorageResourceInfo item in the VnfInstance
+ that was added to the VNFC. It shall be provided if
+ at least one storage resource was added to the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ removedStorageResourceIds:
+ description: >
+ References to VirtualStorage resources that have
+ been removed. The value contains the identifier of a
+ VirtualStorageResourceInfo item that has been
+ removed from the VNFC, and might no longer exist in
+ the VnfInstance. It shall be provided if at least
+ one storage resource was removed from the VNFC.
+ type: array
+ items:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ affectedVirtualLinks:
+ description: >
+ Information about VL instances that were affected during
+ the lifecycle operation. This allows the NFVO to obtain
+ the information contained in the latest "result"
+ notification if it has not received it due to an error or
+ a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary VLs.
+ type: object
+ required:
+ - id
+ - virtualLinkDescId
+ - changeType
+ - networkResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualLinkDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ 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.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ - LINK_PORT_ADDED
+ - LINK_PORT_REMOVED
+ networkResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ affectedVirtualStorages:
+ description: >
+ Information about virtualised storage instances that were
+ affected during the lifecycle operation. This allows the
+ NFVO to obtain the information contained in the latest
+ "result" notification if it has not received it due to an
+ error or a wrongly configured subscription filter.
+ type: array
+ items:
+ description: >
+ This type provides information about added, deleted,
+ modified and temporary virtual storage resources.
+ type: object
+ required:
+ - id
+ - virtualStorageDescId
+ - changeType
+ - storageResource
+ properties:
+ id:
+ description: >
+ An identifier that is unique for the respective type
+ within a VNF instance, but may not be globally
+ unique.
+ type: string
+ virtualStorageDescId:
+ description: >
+ An identifier that is unique within a VNF
+ descriptor.
+ type: string
+ changeType:
+ description: >
+ Signals the type of change. Permitted values: *
+ ADDED * REMOVED * MODIFIED * TEMPORARY For a
+ temporary resource, an AffectedVirtualStorage
+ structure exists as long as the temporary resource
+ exists.
+ type: string
+ enum:
+ - ADDED
+ - REMOVED
+ - MODIFIED
+ - TEMPORARY
+ storageResource:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a
+ VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or
+ the resource provider.
+ type: string
+ metadata:
+ 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.
+ type: object
+ changedInfo:
+ description: >
+ This type represents attribute modifications that were
+ performed on an "Individual VNF instance" resource. The
+ attributes that can be included consist of those requested to
+ be modified explicitly in the "VnfInfoModificationRequest"
+ data structure, and additional attributes of the "VnfInstance"
+ data structure that were modified implicitly e.g. when
+ modifying the referenced VNF package.
+ type: object
+ properties:
+ vnfInstanceName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceName" attribute in "VnfInstance".
+ type: string
+ vnfInstanceDescription:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfInstanceDescription" attribute in "VnfInstance".
+ type: string
+ vnfConfigurableProperties:
+ 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.
+ type: object
+ metadata:
+ 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.
+ type: object
+ extensions:
+ 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.
+ type: object
+ vimConnectionInfo:
+ description: >
+ If present, this attribute signals modifications of
+ certain entries in the "vimConnectionInfo" attribute array
+ in "VnfInstance".
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - vimType
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vimType:
+ 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.
+ type: string
+ interfaceInfo:
+ 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.
+ type: object
+ accessInfo:
+ 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.
+ type: object
+ extra:
+ 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.
+ type: object
+ vnfPkgId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfdId:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ vnfProvider:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProvider" attribute in "VnfInstance". If present, this
+ attribute (which depends on the value of the "vnfPkgId"
+ attribute) was modified implicitly following a request to
+ modify the "vnfPkgId" attribute, by copying the value of
+ this attribute from the VNFD in the VNF Package identified
+ by the "vnfPkgId†attribute.
+ type: string
+ vnfProductName:
+ description: >
+ If present, this attribute signals modifications of the
+ "vnfProductName" attribute in "VnfInstance". If present,
+ this attribute (which depends on the value of the
+ "vnfPkgId" attribute) was modified implicitly following a
+ request to modify the "vnfPkgId" attribute, by copying the
+ value of this attribute from the VNFD in the VNF Package
+ identified by the "vnfPkgId†attribute.
+ type: string
+ vnfSoftwareVersion:
+ description: |
+ A Version.
+ type: string
+ vnfdVersion:
+ description: |
+ A Version.
+ type: string
+ changedExtConnectivity:
+ description: >
+ Information about changed external connectivity, if
+ applicable. This allows the NFVO to obtain the information
+ contained in the latest "result" notification if it has not
+ received it due to an error or a wrongly configured
+ subscription filter.
+ type: array
+ items:
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by a VNF
+ instance. Information about the resource is available
+ from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM or the
+ resource provider.
+ type: string
+ extLinkPorts:
+ description: |
+ Link ports of this VL.
+ type: array
+ items:
+ 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.
+ type: object
+ required:
+ - id
+ - resourceHandle
+ properties:
+ id:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ resourceHandle:
+ required:
+ - vimConnectionId
+ - resourceId
+ type: object
+ description: >
+ This type represents the information that allows
+ addressing a virtualised resource that is used by
+ a VNF instance. Information about the resource is
+ available from the VIM.
+ properties:
+ vimConnectionId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceProviderId:
+ description: >
+ An identifier with the intention of being
+ globally unique.
+ type: string
+ resourceId:
+ description: >
+ An identifier maintained by the VIM or other
+ resource provider. It is expected to be unique
+ within the VIM instance.
+ type: string
+ vimLevelResourceType:
+ description: >
+ Type of the resource in the scope of the VIM
+ or the resource provider.
+ type: string
+ cpInstanceId:
+ description: >
+ An identifier that is unique for the respective
+ type within a VNF instance, but may not be
+ globally unique.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ - vnfInstance
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ vnfInstance:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ grant:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ cancel:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ retry:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ rollback:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ fail:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF instance resource. Typically, this is due to
+ the fact that the VNF instance resource is not in FAILED_TEMP state,
+ or another error handling action is starting, such as rollback or
+ fail. The response body shall contain a ProblemDetails structure, in
+ which the "detail" attribute should convey more information about
+ the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel':
+ parameters:
+ - name: vnfLcmOpOccId
+ description: >
+ Identifier of a VNF lifecycle management operation occurrence to be be
+ cancelled. This identifier can be retrieved from the resource
+ referenced by the "Location" HTTP header in the response to a PATCH or
+ POST request triggering a VNF LCM operation. It can also be retrieved
+ from the "vnfLcmOpOccId" attribute in the
+ VnfLcmOperationOccurrenceNotification.
+ in: path
+ required: true
+ type: string
+ post:
+ description: >
+ The POST method initiates cancelling an ongoing VNF lifecycle operation
+ while it is being executed or rolled back, i.e. the related "VNF LCM
+ operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
+ responses:
+ '202':
+ description: >
+ Accepted
+
+ The request was accepted for processing, but processing has not been
+ completed. The response shall have an empty payload body.
+ headers:
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '409':
+ description: >
+ Conflict
+
+ The operation cannot be executed currently, due to a conflict with
+ the state of the VNF LCM operation occurrence resource. Typically,
+ this is due to the fact that the operation occurrence is not in
+ STARTING, PROCESSING or ROLLING_BACK state. The response body shall
+ contain a ProblemDetails structure, in which the "detail" attribute
+ shall convey more information about the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ /subscriptions:
+ post:
+ description: |
+ The POST method creates a new subscription.
+ parameters:
+ - name: LccnSubscriptionRequest
+ description: |
+ Details of the subscription to be created.
+ in: body
+ required: true
+ schema:
+ description: >
+ This type represents a subscription request related to
+ notifications about VNF lifecycle changes.
+ type: object
+ required:
+ - callbackUri
+ properties:
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF lifecycle changes. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ VnfLcmOperationOccurrenceNotification *
+ VnfIdentifierCreationNotification *
+ VnfIdentifierDeletionNotification The permitted values of
+ the "notificationTypes" attribute are spelled exactly as
+ the names of the notification types to facilitate
+ automated code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - VnfLcmOperationOccurrenceNotification
+ - VnfIdentifierCreationNotification
+ - VnfIdentifierDeletionNotification
+ operationTypes:
+ description: >
+ Match particular VNF lifecycle operation types for the
+ notification of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE
+ | Represents the "Scale VNF" LCM operation.
+ SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM
+ operation. CHANGE_FLAVOUR | Represents the "Change VNF
+ Flavour" LCM operation. TERMINATE | Represents the
+ "Terminate VNF" LCM operation. HEAL | Represents the
+ "Heal VNF" LCM operation. OPERATE | Represents the
+ "Operate VNF" LCM operation. CHANGE_EXT_CONN |
+ Represents the "Change external VNF connectivity" LCM
+ operation. MODIFY_INFO | Represents the "Modify VNF
+ Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ operationStates:
+ description: >
+ Match particular LCM operation state values as reported in
+ notifications of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ STARTING | The
+ LCM operation is starting. PROCESSING | The LCM
+ operation is currently in execution. COMPLETED | he LCM
+ operation has been completed successfully. 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. ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ callbackUri:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ authentication:
+ type: object
+ required:
+ - authType
+ properties:
+ authType:
+ 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.
+ type: array
+ items:
+ type: string
+ enum:
+ - BASIC
+ - OAUTH2_CLIENT_CREDENTIALS
+ - TLS_CERT
+ paramsBasic:
+ 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.
+ type: object
+ properties:
+ userName:
+ description: >
+ Username to be used in HTTP Basic authentication.
+ Shall be present if it has not been provisioned out of
+ band.
+ type: string
+ password:
+ description: >
+ Password to be used in HTTP Basic authentication.
+ Shall be present if it has not been provisioned out of
+ band.
+ type: string
+ paramsOauth2ClientCredentials:
+ 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.
+ type: object
+ properties:
+ clientId:
+ 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.
+ type: string
+ clientPassword:
+ 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.
+ type: string
+ tokenEndpoint:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ responses:
+ '201':
+ description: >
+ Created
+
+ The subscription was created successfully. The response body shall
+ contain a representation of the created subscription resource. The
+ HTTP response shall include a "Location" HTTP header that points to
+ the created subscription resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ Location:
+ description: The resource URI of the created VNF instance
+ 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF lifecycle changes.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF lifecycle changes. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ VnfLcmOperationOccurrenceNotification *
+ VnfIdentifierCreationNotification *
+ VnfIdentifierDeletionNotification The permitted values of
+ the "notificationTypes" attribute are spelled exactly as
+ the names of the notification types to facilitate
+ automated code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - VnfLcmOperationOccurrenceNotification
+ - VnfIdentifierCreationNotification
+ - VnfIdentifierDeletionNotification
+ operationTypes:
+ description: >
+ Match particular VNF lifecycle operation types for the
+ notification of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE
+ | Represents the "Scale VNF" LCM operation.
+ SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM
+ operation. CHANGE_FLAVOUR | Represents the "Change VNF
+ Flavour" LCM operation. TERMINATE | Represents the
+ "Terminate VNF" LCM operation. HEAL | Represents the
+ "Heal VNF" LCM operation. OPERATE | Represents the
+ "Operate VNF" LCM operation. CHANGE_EXT_CONN |
+ Represents the "Change external VNF connectivity" LCM
+ operation. MODIFY_INFO | Represents the "Modify VNF
+ Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ operationStates:
+ description: >
+ Match particular LCM operation state values as reported in
+ notifications of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ STARTING | The
+ LCM operation is starting. PROCESSING | The LCM
+ operation is currently in execution. COMPLETED | he LCM
+ operation has been completed successfully. 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. ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ callbackUri:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ get:
+ description: >
+ 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.
+ responses:
+ '200':
+ description: >
+ OK
+
+ The list of subscriptions was queried successfully. The response
+ body shall contain the representations of all active subscriptions
+ of the functional block that invokes the method.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF lifecycle changes.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF lifecycle changes. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ VnfLcmOperationOccurrenceNotification *
+ VnfIdentifierCreationNotification *
+ VnfIdentifierDeletionNotification The permitted values of
+ the "notificationTypes" attribute are spelled exactly as
+ the names of the notification types to facilitate
+ automated code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - VnfLcmOperationOccurrenceNotification
+ - VnfIdentifierCreationNotification
+ - VnfIdentifierDeletionNotification
+ operationTypes:
+ description: >
+ Match particular VNF lifecycle operation types for the
+ notification of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE
+ | Represents the "Scale VNF" LCM operation.
+ SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM
+ operation. CHANGE_FLAVOUR | Represents the "Change VNF
+ Flavour" LCM operation. TERMINATE | Represents the
+ "Terminate VNF" LCM operation. HEAL | Represents the
+ "Heal VNF" LCM operation. OPERATE | Represents the
+ "Operate VNF" LCM operation. CHANGE_EXT_CONN |
+ Represents the "Change external VNF connectivity" LCM
+ operation. MODIFY_INFO | Represents the "Modify VNF
+ Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ operationStates:
+ description: >
+ Match particular LCM operation state values as reported in
+ notifications of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ STARTING | The
+ LCM operation is starting. PROCESSING | The LCM
+ operation is currently in execution. COMPLETED | he LCM
+ operation has been completed successfully. 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. ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ callbackUri:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ Invalid attribute-based filtering parameters. The response body
+ shall contain a ProblemDetails structure, in which the "detail"
+ attribute should convey more information about the error.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '/subscriptions/{subscriptionId}':
+ parameters:
+ - name: subscriptionId
+ description: >
+ Identifier of this subscription. This identifier can be retrieved from
+ the resource referenced by the "Location" HTTP header in the response
+ to a POST request creating a new subscription resource. It can also be
+ retrieved from the "id" attribute in the payload body of that
+ response.
+ in: path
+ type: string
+ required: true
+ get:
+ description: >
+ The GET method retrieves information about a subscription by reading an
+ individual subscription resource.
+ responses:
+ '200':
+ description: >
+ OK
+
+ The operation has completed successfully. The response body shall
+ contain a representation of the subscription resource.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ This type represents a subscription related to notifications about
+ VNF lifecycle changes.
+ type: object
+ required:
+ - id
+ - callbackUri
+ - _links
+ properties:
+ id:
+ description: |
+ An identifier with the intention of being globally unique.
+ type: string
+ filter:
+ description: >
+ This type represents a subscription filter related to
+ notifications about VNF lifecycle changes. 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).
+ type: object
+ properties:
+ vnfInstanceSubscriptionFilter:
+ description: >
+ This type represents subscription filter criteria to match
+ VNF instances.
+ type: object
+ properties:
+ vnfdIds:
+ description: >
+ If present, match VNF instances that were created
+ based on a VNFD identified by one of the vnfdId values
+ listed in this attribute. The attributes "vnfdIds" and
+ "vnfProductsFromProviders" are alternatives to
+ reference to VNF instances that are based on certain
+ VNFDs in a filter. They should not be used both in the
+ same filter instance, but one alternative should be
+ chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfProductsFromProviders:
+ description: >
+ If present, match VNF instances that belong to VNF
+ products from certain providers. The attributes
+ "vnfdIds" and "vnfProductsFromProviders" are
+ alternatives to reference to VNF instances that are
+ based on certain VNFDs in a filter. They should not be
+ used both in the same filter instance, but one
+ alternative should be chosen.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProvider
+ properties:
+ vnfProvider:
+ description: |
+ Name of the VNF provider to match.
+ type: string
+ vnfProducts:
+ description: >
+ If present, match VNF instances that belong to
+ VNF products with certain product names, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfProductName
+ properties:
+ vnfProductName:
+ description: |
+ Name of the VNF product to match.
+ type: string
+ versions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain
+ versions and a certain product name, from
+ one particular provider.
+ type: array
+ items:
+ type: object
+ required:
+ - vnfSoftwareVersion
+ properties:
+ vnfSoftwareVersion:
+ description: |
+ A version.
+ type: string
+ vnfdVersions:
+ description: >
+ If present, match VNF instances that
+ belong to VNF products with certain VNFD
+ versions, a certain software version and
+ a certain product name, from one
+ particular provider.
+ type: array
+ items:
+ description: |
+ A version.
+ type: string
+ vnfInstanceIds:
+ description: >
+ If present, match VNF instances with an instance
+ identifier listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ description: >
+ An identifier with the intention of being globally
+ unique.
+ type: string
+ vnfInstanceNames:
+ description: >
+ If present, match VNF instances with a VNF Instance
+ Name listed in this attribute. The attributes
+ "vnfInstanceIds" and "vnfInstanceNames" are
+ alternatives to reference to particular VNF Instances
+ in a filter. They should not be used both in the same
+ filter instance, but one alternative should be chosen.
+ type: array
+ items:
+ type: string
+ notificationTypes:
+ description: >
+ Match particular notification types. Permitted values: *
+ VnfLcmOperationOccurrenceNotification *
+ VnfIdentifierCreationNotification *
+ VnfIdentifierDeletionNotification The permitted values of
+ the "notificationTypes" attribute are spelled exactly as
+ the names of the notification types to facilitate
+ automated code generation systems.
+ type: array
+ items:
+ type: string
+ enum:
+ - VnfLcmOperationOccurrenceNotification
+ - VnfIdentifierCreationNotification
+ - VnfIdentifierDeletionNotification
+ operationTypes:
+ description: >
+ Match particular VNF lifecycle operation types for the
+ notification of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ INSTANTIATE |
+ Represents the "Instantiate VNF" LCM operation. SCALE
+ | Represents the "Scale VNF" LCM operation.
+ SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM
+ operation. CHANGE_FLAVOUR | Represents the "Change VNF
+ Flavour" LCM operation. TERMINATE | Represents the
+ "Terminate VNF" LCM operation. HEAL | Represents the
+ "Heal VNF" LCM operation. OPERATE | Represents the
+ "Operate VNF" LCM operation. CHANGE_EXT_CONN |
+ Represents the "Change external VNF connectivity" LCM
+ operation. MODIFY_INFO | Represents the "Modify VNF
+ Information" LCM operation.
+ type: string
+ enum:
+ - INSTANTIATE
+ - SCALE
+ - SCALE_TO_LEVEL
+ - CHANGE_FLAVOUR
+ - TERMINATE
+ - HEAL
+ - OPERATE
+ - CHANGE_EXT_CONN
+ - MODIFY_INFO
+ operationStates:
+ description: >
+ Match particular LCM operation state values as reported in
+ notifications of type
+ VnfLcmOperationOccurrenceNotification. May be present if
+ the "notificationTypes" attribute contains the value
+ "VnfLcmOperationOccurrenceNotification", and shall be
+ absent otherwise.
+ type: array
+ items:
+ description: >
+ Value | Description ------|------------ STARTING | The
+ LCM operation is starting. PROCESSING | The LCM
+ operation is currently in execution. COMPLETED | he LCM
+ operation has been completed successfully. 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. ROLLING_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.
+ type: string
+ enum:
+ - STARTING
+ - PROCESSING
+ - COMPLETED
+ - FAILED_TEMP
+ - FAILED
+ - ROLLING_BACK
+ - ROLLED_BACK
+ callbackUri:
+ description: |
+ String formatted according to IETF RFC 3986.
+ type: string
+ _links:
+ description: |
+ Links to resources related to this resource.
+ type: object
+ required:
+ - self
+ properties:
+ self:
+ description: |
+ This type represents a link to a resource.
+ type: object
+ required:
+ - href
+ properties:
+ href:
+ description: |
+ URI of the referenced resource.
+ type: string
+ format: url
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ delete:
+ description: |
+ The DELETE method terminates an individual subscription.
+ responses:
+ '204':
+ description: >
+ No Content
+
+ The subscription resource 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.
+ type: string
+ maximum: 1
+ minimum: 0
+ '400':
+ description: >
+ Bad Request
+
+ If the request is malformed or syntactically incorrect (e.g. if the
+ request URI contains incorrect query parameters or a syntactically
+ incorrect payload body), 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 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.
+
+ ---
+
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '401':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ WWW-Authenticate:
+ description: >
+ Challenge if the corresponding HTTP request has not provided
+ authorization, or error details if the corresponding HTTP
+ request has provided an invalid authorization token.
+ type: string
+ maximum: 1
+ minimum: 0
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '403':
+ description: >
+ 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '404':
+ description: >
+ 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. Specifically in case of this task resource, the
+ reason can also be that the task is not supported for the VNF LCM
+ operation occurrence represented by the parent resource, and that
+ the task resource consequently does not exist. The "ProblemDetails"
+ structure may be provided, including in the "detail" attribute
+ information about the sourceof the problem, e.g. a wrong resource
+ URI variable.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '405':
+ description: >
+ 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.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '406':
+ description: >
+ Not Acceptable
+
+ If the "Accept" HTTP 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 in that case.
+ headers:
+ Content-Type:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '500':
+ description: >
+ 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 withthis 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+ '503':
+ description: >
+ 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 [13] 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:
+ description: The MIME type of the body of the response.
+ type: string
+ maximum: 1
+ minimum: 1
+ schema:
+ description: >
+ The definition of the general "ProblemDetails" data structure from
+ IETF RFC 7807 [19] is reproduced inthis 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].
+ type: object
+ required:
+ - status
+ - detail
+ properties:
+ type:
+ 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".
+ type: string
+ format: URI
+ title:
+ 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).
+ type: string
+ status:
+ 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.
+ type: integer
+ detail:
+ description: >
+ A human-readable explanation specific to this occurrence of
+ the problem.
+ type: string
+ instance:
+ description: >
+ A URI reference that identifies the specific occurrence of the
+ problem. It may yield further information if dereferenced.
+ type: string
+ format: URI
+
diff --git a/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFTask.robot b/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFTask.robot
new file mode 100644
index 00000000..a9290542
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFTask.robot
@@ -0,0 +1,142 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Scale a vnfInstance
+ [Documentation] Instantiate VNF The POST method instantiates a VNF instance.
+ Log Trying to Instantiate a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Scale a vnfInstance Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to Scale a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Scale a vnfInstance Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to Scale a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Scale a vnfInstance Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check scale not supported
+ Log Trying to scale a vnf Instance, not exist
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 404
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+GET Scale VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
+ Log Validate Status code
+ Integer response status 405
+
+PUT Scale VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Scale VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Scale VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+Check scale not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Missing response body instantiatedVnfInfo scaleStatus
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFToLevelTask.robot b/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFToLevelTask.robot
new file mode 100644
index 00000000..4d0a46ab
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/ScaleVNFToLevelTask.robot
@@ -0,0 +1,146 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Scale a vnfInstance to level
+ [Documentation] Instantiate VNF The POST method instantiates a VNF instance.
+ Log Trying to Instantiate a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Scale a vnfInstance to level Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to Scale a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Scale a vnfInstance to level Conflict (parallel LCM operation)
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to Scale a vnf Instance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+Scale a vnfInstance Not Found
+ # TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
+ [Documentation] Not Found
+ ... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
+ ... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
+ ... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the “detail” attribute shall convey more information about the error.
+ [Setup] Check scale to level not supported
+ Log Trying to scale a vnf Instance, not exist
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfToLevelRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
+ Integer response status 404
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+
+GET Scale to level VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PUT Scale to level VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+PATCH Scale to level VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+DELETE Scale to level VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level
+ Log Validate Status code
+ Output response
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+ Check scale to level not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Missing response body instantiatedVnfInfo scaleStatus
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/Subscriptions.robot b/SOL002/VNFLifecycleManagement-API_egm/Subscriptions.robot
new file mode 100644
index 00000000..b1e636b2
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/Subscriptions.robot
@@ -0,0 +1,124 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+
+*** Test Cases ***
+Create a new subscription
+ Log Create subscription instance by POST to ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/lccbSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 201
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+Create a new Subscription - DUPLICATION
+ Log Trying to create a subscription with an already created content
+ Pass Execution If ${NVFM_DUPLICATION} == 0 VNFM is not permitting duplication. Skipping the test
+ Set Headers {"Accept": "${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ ${body}= Get File json/lccbSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 201
+ Log Status code validated
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+Create a new Subscription - NO-DUPLICATION
+ Log Trying to create a subscription with an already created content
+ Pass Execution If ${NVFM_DUPLICATION} == 1 VNFM permits duplication. Skipping the test
+ Set Headers {"Accept": "${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ ${body}= Get File json/lccbSubscriptionRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions ${body}
+ Integer response status 303
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+GET Subscriptions
+ Log Get the list of active subscriptions
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 200
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+GET Subscription - Filter
+ Log Get the list of active subscriptions using a filter
+ Set Headers {"Accept": "${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/subscriptions?${sub_filter}
+ Integer response status 200
+ Log Received a 200 OK as expected
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json subscriptions.schema.json ${json}
+ Log Validation OK
+
+GET subscriptions - Bad Request Invalid attribute-based filtering parameters
+ Log Get the list of active subscriptions using an invalid filter
+ Set Headers {"Accept": "${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/subscriptions?${sub_filter_invalid}
+ Integer response status 400
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PUT subscriptions - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
+PATCH subscriptions - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
+DELETE subscriptions - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/subscriptions
+ Log Validate Status code
+ Integer response status 405
+
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/TerminateVNFTask.robot b/SOL002/VNFLifecycleManagement-API_egm/TerminateVNFTask.robot
new file mode 100644
index 00000000..e34651a9
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/TerminateVNFTask.robot
@@ -0,0 +1,124 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Suite setup Check resource existance
+
+*** Test Cases ***
+Terminate a vnfInstance
+ [Documentation] Terminates a VNF instance
+ Log Trying to terminate a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/terminateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate ${body}
+ Integer response status 202
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ Log Validation OK
+
+Terminate a vnfInstance Conflict (Not-Instantiated)
+ # TODO: Need to set the pre-condition of the test. VNF instance shall be in INSTANTIATED state
+ [Documentation] Conflict.
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Check resource not instantiated
+ Log Trying to terminate a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/terminateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate ${body}
+ Integer response status 409
+ Log Status code validated
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Terminate a vnfInstance Conflict (parallel LCM operation)
+ # TODO: Need to set the pre-condition of the test
+ [Documentation] Conflict
+ ... The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
+ ... Typically, this is due to the fact that the VNF 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 should convey more information about the error.
+ [Setup] Launch another LCM operation
+ log Trying to change the deployment flavour of a VNF instance.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/terminateVnFRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate ${body}
+ Log Validate Status code
+ Integer response status 409
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+ [Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished
+
+GET Terminate VNFInstance - Method not implemented
+ log Trying to perform a GET. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate
+ Log Validate Status code
+ Integer response status 405
+
+PUT Terminate VNFInstance - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate
+ Log Validate Status code
+ Integer response status 405
+
+PATCH Terminate VNFInstance - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate
+ Log Validate Status code
+ Integer response status 405
+
+DELETE Terminate VNFInstance - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/terminate
+ Log Validate Status code
+ Integer response status 405
+
+*** Key words ***
+Check resource existance
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ Integer response status 200
+
+Check resource not instantiated
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ String response body instantiationState NOT_INSTANTIATED
+
+Check change flavour not supported
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
+ # how to check if change floavour is not supported? "flavourId" doesn't exist?
+
+Launch another LCM operation
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/scaleVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
+ Integer response status 202
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/VNFInstances.robot b/SOL002/VNFLifecycleManagement-API_egm/VNFInstances.robot
new file mode 100644
index 00000000..17e836e8
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/VNFInstances.robot
@@ -0,0 +1,101 @@
+*** Settings ***
+# Suite setup Expect spec SOL003-VNFLifecycleManagement-API.yaml
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library OperatingSystem
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+
+*** Test cases ***
+
+Create a new vnfInstance
+ [Setup] #make sure the vnfInstand ${vnfInstanceId} doesn't exist
+ Log Create VNF instance by POST to ${apiRoot}/${apiName}/${apiVersion}/vnf_instances
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Set Headers {"Authorization":"${AUTHORIZATION}"}
+ ${body}= Get File json/createVnfRequest.json
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances ${body}
+ Integer response status 201
+ Log Status code validated
+ ${headers}= Output response headers
+ Should Contain ${headers} Location
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json vnfInstance.schema.json ${json}
+ Log Validation OK
+
+Get information about multiple VNF instances
+ Log Query VNF The GET method queries information about multiple VNF instances.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json vnfInstance.schema.json ${json}
+ Log Validation OK
+
+Get information about multiple VNF instances Bad Request Invalid attribute-based filtering parameters
+ Log Query VNF The GET method queries information about multiple VNF instances.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Set Headers {"Authorization":"${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/vnf_instances?attribute_not_exist=some_value
+ Log Validate Status code
+ Integer response status 400
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Get information about multiple VNF instances Bad Request Invalid attribute selector
+ Log Query VNF The GET method queries information about multiple VNF instances.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/vnf_instances?fields=wrong_field
+ Log Validate Status code
+ Integer response status 400
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PUT VNFInstances - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances
+ Log Validate Status code
+ Integer response status 405
+
+PATCH VNFInstances - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances
+ Log Validate Status code
+ Integer response status 405
+
+DELETE VNFInstances - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Set Headers {"Content-Type": "${CONTENT_TYPE}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances
+ Log Validate Status code
+ Integer response status 405
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/VnfLcmOperationOccurences.robot b/SOL002/VNFLifecycleManagement-API_egm/VnfLcmOperationOccurences.robot
new file mode 100644
index 00000000..6f8e13a4
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/VnfLcmOperationOccurences.robot
@@ -0,0 +1,80 @@
+*** Settings ***
+Resource variables.txt
+Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT}
+... spec=SOL002-VNFLifecycleManagement-API.yaml
+Library JSONLibrary
+Library JSONSchemaLibrary schemas/
+Documentation This resource represents VNF lifecycle management operation occurrences. The client can use this resource to query
+... status information about multiple VNF lifecycle management operation occurrences.
+
+*** Test Cases ***
+Post VNF LCM OP occurences - Method not implemented
+ log Trying to perform a POST. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Post ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs
+ Log Validate Status code
+ Integer response status 405
+
+Get stauts information about multiple VNF LCM OP OCC
+ Log Query status information about multiple VNF lifecycle management operation occurrences.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Log Execute Query and validate response
+ Get ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs
+ Log Validate Status code
+ Integer response status 200
+ ${contentType}= Output response headers Content-Type
+ Should Contain ${contentType} ${CONTENT_TYPE}
+ ${result}= Output response body
+ ${json}= evaluate json.loads('''${result}''') json
+ Validate Json vnfLcmOpOcc.schema.json ${json}
+ Log Validation OK
+
+Get stauts information about multiple VNF LCM OP OCC Bad Request Invalid attribute-based filtering parameters
+ Log Query status information about multiple VNF lifecycle management operation occurrences.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs?attribute_not_exist=some_value
+ Log Validate Status code
+ Integer response status 400
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+Get stauts information about multiple VNF LCM OP OCC Bad Request Invalid attribute selector
+ Log Query VNF The GET method queries information about multiple VNF instances.
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ GET ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs?fields=wrong_field
+ Log Validate Status code
+ Integer response status 400
+ ${problemDetails}= Output response body
+ ${json}= evaluate json.loads('''${problemDetails}''') json
+ Validate Json ProblemDetails.schema.json ${json}
+ Log Validation OK
+
+PUT stauts information about multiple VNF LCM OP OCC - Method not implemented
+ log Trying to perform a PUT. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Put ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs
+ Log Validate Status code
+ Integer response status 405
+
+PATCH stauts information about multiple VNF LCM OP OCC - Method not implemented
+ log Trying to perform a PATCH. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs
+ Log Validate Status code
+ Integer response status 405
+
+DELETE stauts information about multiple VNF LCM OP OCC - Method not implemented
+ log Trying to perform a DELETE. This method should not be implemented
+ Set Headers {"Accept":"${ACCEPT}"}
+ Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
+ Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_lcm_op_occs
+ Log Validate Status code
+ Integer response status 405
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/changeExtVnfConnectivityRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/changeExtVnfConnectivityRequest.json
new file mode 100644
index 00000000..b53584ee
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/changeExtVnfConnectivityRequest.json
@@ -0,0 +1,65 @@
+{
+ "extVirtualLinks": [
+ {
+ "id": "string",
+ "vimConnectionId": "string",
+ "resourceProviderId": "string",
+ "resourceId": "string",
+ "extCps": [
+ {
+ "cpdId": "string",
+ "cpConfig": [
+ {
+ "cpInstanceId": "string",
+ "linkPortId": "string",
+ "cpProtocolData": [
+ {
+ "layerProtocol": "IP_OVER_ETHERNET",
+ "ipOverEthernet": {
+ "macAddress": "string",
+ "ipAddresses": [
+ {
+ "type": "IPV4",
+ "fixedAddresses": [
+ "string"
+ ],
+ "numDynamicAddresses": 0,
+ "addressRange": {
+ "minAddress": "string",
+ "maxAddress": "string"
+ },
+ "subnetId": "string"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "extLinkPorts": [
+ {
+ "id": "string",
+ "resourceHandle": {
+ "vimConnectionId": "string",
+ "resourceProviderId": "string",
+ "resourceId": "string",
+ "vimLevelResourceType": "string"
+ }
+ }
+ ]
+ }
+ ],
+ "vimConnectionInfo": [
+ {
+ "id": "string",
+ "vimId": "string",
+ "vimType": "string",
+ "interfaceInfo": {},
+ "accessInfo": {},
+ "extra": {}
+ }
+ ],
+ "additionalParams": {}
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/changeVnfFlavourRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/changeVnfFlavourRequest.json
new file mode 100644
index 00000000..5b52927e
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/changeVnfFlavourRequest.json
@@ -0,0 +1,3 @@
+{
+ "newFlavourId": "myFlavour_new"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/createVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/createVnfRequest.json
new file mode 100644
index 00000000..8a1fda3b
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/createVnfRequest.json
@@ -0,0 +1,5 @@
+{
+ "vnfdId": "6fc3539c-e602-4afa-8e13-962fb5a7d81f",
+ "vnfInstanceName": "string",
+ "vnfInstanceDescription": "string"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/healVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/healVnfRequest.json
new file mode 100644
index 00000000..8981fa94
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/healVnfRequest.json
@@ -0,0 +1,4 @@
+{
+ "cause": "a specific cause",
+ "additionalParams": {}
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/instantiateVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/instantiateVnfRequest.json
new file mode 100644
index 00000000..3c9f8437
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/instantiateVnfRequest.json
@@ -0,0 +1,77 @@
+{
+ "flavourId": "myFlavour",
+ "instantiationLevelId": "string",
+ "extVirtualLinks": [
+ {
+ "id": "string",
+ "vimConnectionId": "string",
+ "resourceProviderId": "string",
+ "resourceId": "string",
+ "extCps": [
+ {
+ "cpdId": "string",
+ "cpConfig": [
+ {
+ "cpInstanceId": "string",
+ "linkPortId": "string",
+ "cpProtocolData": [
+ {
+ "layerProtocol": "IP_OVER_ETHERNET",
+ "ipOverEthernet": {
+ "macAddress": "string",
+ "ipAddresses": [
+ {
+ "type": "IPV4",
+ "fixedAddresses": [
+ "string"
+ ],
+ "numDynamicAddresses": 0,
+ "addressRange": {
+ "minAddress": "string",
+ "maxAddress": "string"
+ },
+ "subnetId": "string"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "extLinkPorts": [
+ {
+ "id": "string",
+ "resourceHandle": {
+ "vimConnectionId": "string",
+ "resourceProviderId": "string",
+ "resourceId": "string",
+ "vimLevelResourceType": "string"
+ }
+ }
+ ]
+ }
+ ],
+ "extManagedVirtualLinks": [
+ {
+ "id": "string",
+ "virtualLinkDescId": "string",
+ "vimConnectionId": "string",
+ "resourceProviderId": "string",
+ "resourceId": "string"
+ }
+ ],
+ "vimConnectionInfo": [
+ {
+ "id": "string",
+ "vimId": "string",
+ "vimType": "string",
+ "interfaceInfo": {},
+ "accessInfo": {},
+ "extra": {}
+ }
+ ],
+ "localizationLanguage": "English",
+ "additionalParams": {}
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/lccnSubscriptionRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/lccnSubscriptionRequest.json
new file mode 100644
index 00000000..e44916f8
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/lccnSubscriptionRequest.json
@@ -0,0 +1,10 @@
+{
+ "filter": {
+ "vnfInstanceSubscriptionFilter": {
+ "vnfdIds": [
+ "6fc3539c-e602-4afa-8e13-962fb5a7d81f"
+ ]
+ }
+ },
+ "callbackUri": "http://127.0.0.1/subscribe"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/operateVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/operateVnfRequest.json
new file mode 100644
index 00000000..92dc07fa
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/operateVnfRequest.json
@@ -0,0 +1,5 @@
+{
+ "changeStateTo": "STOPPED",
+ "stopType": "FORCEFUL"
+ "additionalParams": {}
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/patchBodyRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/patchBodyRequest.json
new file mode 100644
index 00000000..0c8845c2
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/patchBodyRequest.json
@@ -0,0 +1,4 @@
+{
+ "vnfInstanceName": "vnf new name",
+ "vnfInstanceDescription": "new description"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfRequest.json
new file mode 100644
index 00000000..09dc7dff
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfRequest.json
@@ -0,0 +1,4 @@
+{
+ "type": "SCALE_OUT",
+ "aspectId": "myAspect"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfToLevelRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfToLevelRequest.json
new file mode 100644
index 00000000..1c39a7bb
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/scaleVnfToLevelRequest.json
@@ -0,0 +1,3 @@
+{
+ "instantiationLevelId": "myNextLevel"
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/jsons/terminateVnfRequest.json b/SOL002/VNFLifecycleManagement-API_egm/jsons/terminateVnfRequest.json
new file mode 100644
index 00000000..0a4f9592
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/jsons/terminateVnfRequest.json
@@ -0,0 +1,4 @@
+{
+ "terminationType": "GRACEFUL",
+ "additionalParams": {}
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/VnfIdentifierCreationNotification.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/VnfIdentifierCreationNotification.schema.json
new file mode 100644
index 00000000..e69de29b
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/problemDetails.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/problemDetails.schema.json
new file mode 100644
index 00000000..62f17612
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/schemas/problemDetails.schema.json
@@ -0,0 +1,34 @@
+{
+ "definitions": {},
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "properties": {
+ "type": {
+ "type": "string",
+ "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\".\n",
+ "format": "URI"
+ },
+ "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).\n"
+ },
+ "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.\n"
+ },
+ "detail": {
+ "type": "string",
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n"
+ },
+ "instance": {
+ "type": "string",
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "format": "URI"
+ }
+ },
+ "required": [
+ "status",
+ "detail"
+ ]
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/subscriptions.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/subscriptions.schema.json
new file mode 100644
index 00000000..82bbcc8f
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/schemas/subscriptions.schema.json
@@ -0,0 +1,181 @@
+{
+ "type": "object",
+ "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
+ "required": [
+ "id",
+ "callbackUri",
+ "_links"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "filter": {
+ "type": "object",
+ "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. 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).\n",
+ "properties": {
+ "vnfInstanceSubscriptionFilter": {
+ "type": "object",
+ "description": "This type represents subscription filter criteria to match VNF instances.\n",
+ "properties": {
+ "vnfdIds": {
+ "type": "array",
+ "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ }
+ },
+ "vnfProductsFromProviders": {
+ "type": "array",
+ "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProvider"
+ ],
+ "properties": {
+ "vnfProvider": {
+ "type": "string",
+ "description": "Name of the VNF provider to match.\n"
+ },
+ "vnfProducts": {
+ "type": "array",
+ "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfProductName"
+ ],
+ "properties": {
+ "vnfProductName": {
+ "type": "string",
+ "description": "Name of the VNF product to match.\n"
+ },
+ "versions": {
+ "type": "array",
+ "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "vnfSoftwareVersion"
+ ],
+ "properties": {
+ "vnfSoftwareVersion": {
+ "type": "string",
+ "description": "A version.\n"
+ },
+ "vnfdVersions": {
+ "type": "array",
+ "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
+ "items": {
+ "type": "string",
+ "description": "A version.\n"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfInstanceIds": {
+ "type": "array",
+ "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ }
+ },
+ "vnfInstanceNames": {
+ "type": "array",
+ "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "notificationTypes": {
+ "type": "array",
+ "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
+ "items": {
+ "type": "string",
+ "enum": [
+ "VnfLcmOperationOccurrenceNotification",
+ "VnfIdentifierCreationNotification",
+ "VnfIdentifierDeletionNotification"
+ ]
+ }
+ },
+ "operationTypes": {
+ "type": "array",
+ "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "items": {
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ],
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n"
+ }
+ },
+ "operationStates": {
+ "type": "array",
+ "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
+ "items": {
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ],
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n"
+ }
+ }
+ }
+ },
+ "callbackUri": {
+ "type": "string",
+ "description": "String formatted according to IETF RFC 3986.\n"
+ },
+ "_links": {
+ "type": "object",
+ "description": "Links to resources related to this resource.\n",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfIdentifierDeletionNotification.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfIdentifierDeletionNotification.schema.json
new file mode 100644
index 00000000..e69de29b
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfInstance.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfInstance.schema.json
new file mode 100644
index 00000000..e0122312
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfInstance.schema.json
@@ -0,0 +1,985 @@
+{
+ "definitions": {},
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "description": "This type represents a VNF instance.\n",
+ "required": [
+ "id",
+ "vnfdId",
+ "vnfProvider",
+ "vnfProductName",
+ "vnfSoftwareVersion",
+ "vnfdVersion",
+ "vnfPkgId",
+ "instantiationState"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfInstanceName": {
+ "type": "string",
+ "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n"
+ },
+ "vnfInstanceDescription": {
+ "type": "string",
+ "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n"
+ },
+ "vnfdId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfProvider": {
+ "type": "string",
+ "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n"
+ },
+ "vnfProductName": {
+ "type": "string",
+ "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n"
+ },
+ "vnfSoftwareVersion": {
+ "type": "string",
+ "description": "A Version.\n"
+ },
+ "vnfdVersion": {
+ "type": "string",
+ "description": "A Version.\n"
+ },
+ "vnfPkgId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfConfigurableProperties": {
+ "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. \n"
+ },
+ "vimConnectionInfo": {
+ "type": "array",
+ "description": "Information about VIM connections to be used for managing the resources for the VNF instance. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. This attribute can be modified with the PATCH method.\n",
+ "items": {
+ "type": "object",
+ "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.\n",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vimId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "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.\n"
+ },
+ "interfaceInfo": {
+ "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. \n"
+ },
+ "accessInfo": {
+ "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. \n"
+ },
+ "extra": {
+ "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. \n"
+ }
+ }
+ }
+ },
+ "instantiationState": {
+ "type": "string",
+ "enum": [
+ "NOT_INSTANTIATED",
+ "INSTANTIATED"
+ ],
+ "description": "The instantiation state of the VNF.\n"
+ },
+ "instantiatedVnfInfo": {
+ "type": "object",
+ "description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
+ "required": [
+ "flavourId",
+ "vnfState"
+ ],
+ "properties": {
+ "flavourId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "vnfState": {
+ "type": "string",
+ "enum": [
+ "STARTED",
+ "STOPPED"
+ ]
+ },
+ "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.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "aspectId",
+ "scaleLevel"
+ ],
+ "properties": {
+ "aspectId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "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.\n"
+ }
+ }
+ }
+ },
+ "extCpInfo": {
+ "type": "array",
+ "description": "Information about the external CPs exposed by the VNF instance.\n",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "cpdId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "cpProtocolInfo": {
+ "type": "array",
+ "description": "Network protocol information for this CP.\n",
+ "items": {
+ "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. \n",
+ "required": [
+ "layerProtocol"
+ ],
+ "properties": {
+ "layerProtocol": {
+ "type": "string",
+ "enum": [
+ "IP_OVER_ETHERNET"
+ ],
+ "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n"
+ },
+ "ipOverEthernet": {
+ "type": "object",
+ "description": "This type represents information about a network address that has been assigned. \n",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "type": "string",
+ "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
+ "format": "MAC"
+ },
+ "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.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "IPV4",
+ "IPV6"
+ ],
+ "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n"
+ },
+ "addresses": {
+ "type": "array",
+ "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
+ "items": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ },
+ "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.\n"
+ },
+ "addressRange": {
+ "type": "object",
+ "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
+ "required": [
+ "minAddress",
+ "maxAddress"
+ ],
+ "properties": {
+ "minAddress": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ },
+ "maxAddress": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ }
+ },
+ "subnetId": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extLinkPortId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ }
+ }
+ }
+ },
+ "extVirtualLinkInfo": {
+ "type": "array",
+ "description": "Information about the external VLs the VNF instance is connected to.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "type": "array",
+ "description": "Link ports of this VL.\n",
+ "items": {
+ "type": "object",
+ "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",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "extManagedVirtualLinkInfo": {
+ "type": "array",
+ "description": "External virtual links the VNF instance is connected to.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfVirtualLinkDescId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "networkResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "vnfLinkPorts": {
+ "type": "array",
+ "description": "Link ports of this VL.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoringParameters": {
+ "type": "array",
+ "description": "Active monitoring parameters.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "value",
+ "timeStamp"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "name": {
+ "type": "string",
+ "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n"
+ },
+ "value": {
+ "type": "object",
+ "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification.\n"
+ },
+ "timeStamp": {
+ "type": "string",
+ "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n"
+ }
+ }
+ }
+ },
+ "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.\n"
+ },
+ "vnfcResourceInfo": {
+ "type": "array",
+ "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
+ "items": {
+ "type": "object",
+ "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
+ "required": [
+ "id",
+ "vduId",
+ "computeResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "vduId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "computeResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "storageResourceIds": {
+ "type": "array",
+ "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ },
+ "reservationId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "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.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "cpdId"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "cpdId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "vnfExtCpId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "cpProtocolInfo": {
+ "type": "array",
+ "description": "Network protocol information for this CP.\n",
+ "items": {
+ "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. \n",
+ "required": [
+ "layerProtocol"
+ ],
+ "properties": {
+ "layerProtocol": {
+ "type": "string",
+ "enum": [
+ "IP_OVER_ETHERNET"
+ ],
+ "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n"
+ },
+ "ipOverEthernet": {
+ "type": "object",
+ "description": "This type represents information about a network address that has been assigned. \n",
+ "required": [
+ "macAddress"
+ ],
+ "properties": {
+ "macAddress": {
+ "type": "string",
+ "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
+ "format": "MAC"
+ },
+ "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.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "IPV4",
+ "IPV6"
+ ],
+ "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n"
+ },
+ "addresses": {
+ "type": "array",
+ "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
+ "items": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ },
+ "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.\n"
+ },
+ "addressRange": {
+ "type": "object",
+ "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
+ "required": [
+ "minAddress",
+ "maxAddress"
+ ],
+ "properties": {
+ "minAddress": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ },
+ "maxAddress": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ }
+ },
+ "subnetId": {
+ "type": "string",
+ "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.\n",
+ "format": "IP"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "vnfLinkPortId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ }
+ }
+ }
+ },
+ "virtualLinkResourceInfo": {
+ "type": "array",
+ "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
+ "items": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
+ "required": [
+ "id",
+ "vnfVirtualLinkDescId",
+ "networkResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "vnfVirtualLinkDescId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "networkResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "reservationId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "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.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ }
+ }
+ }
+ },
+ "virtualStorageResourceInfo": {
+ "type": "array",
+ "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
+ "items": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "virtualStorageDescId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "storageResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "reservationId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "metadata": {
+ "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. \n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ },
+ "extensions": {
+ "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. \n"
+ },
+ "_links": {
+ "type": "object",
+ "description": "Links to resources related to this resource.\n",
+ "required": [
+ "self"
+ ],
+ "properties": {
+ "self": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "indicators": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "instantiate": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "terminate": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "scale": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "scaleToLevel": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "changeFlavour": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "heal": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "operate": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "changeExtConn": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOpOcc.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOpOcc.schema.json
new file mode 100644
index 00000000..aa8d1dcb
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOpOcc.schema.json
@@ -0,0 +1,632 @@
+{
+ "definitions": {},
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "description": "This type represents a VNF lifecycle management operation occurrence.\n",
+ "required": [
+ "id",
+ "operationState",
+ "stateEnteredTime",
+ "startTime",
+ "vnfInstanceId",
+ "operation",
+ "isAutomaticInvocation",
+ "operationParams",
+ "isCancelPending"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "operationState": {
+ "type": "string",
+ "enum": [
+ "STARTING",
+ "PROCESSING",
+ "COMPLETED",
+ "FAILED_TEMP",
+ "FAILED",
+ "ROLLING_BACK",
+ "ROLLED_BACK"
+ ],
+ "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. 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. ROLLING_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.\n"
+ },
+ "stateEnteredTime": {
+ "type": "string",
+ "description": "Date-time when the current state was entered.\n",
+ "format": "date-time"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "Date-time of the start of the operation.\n",
+ "format": "date-time"
+ },
+ "vnfInstanceId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "grantId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "operation": {
+ "type": "string",
+ "enum": [
+ "INSTANTIATE",
+ "SCALE",
+ "SCALE_TO_LEVEL",
+ "CHANGE_FLAVOUR",
+ "TERMINATE",
+ "HEAL",
+ "OPERATE",
+ "CHANGE_EXT_CONN",
+ "MODIFY_INFO"
+ ],
+ "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n"
+ },
+ "isAutomaticInvocation": {
+ "type": "boolean",
+ "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n"
+ },
+ "operationParams": {
+ "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. \n"
+ },
+ "isCancelPending": {
+ "type": "boolean",
+ "description": "If the VNF LCM operation occurrence is in \"STARTING\", \"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.\n"
+ },
+ "cancelMode": {
+ "type": "string",
+ "enum": [
+ "GRACEFUL",
+ "FORCEFUL"
+ ],
+ "description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n"
+ },
+ "error": {
+ "type": "object",
+ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n",
+ "properties": {
+ "type": {
+ "type": "string",
+ "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\".\n",
+ "format": "URI"
+ },
+ "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).\n"
+ },
+ "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.\n"
+ },
+ "detail": {
+ "type": "string",
+ "description": "A human-readable explanation specific to this occurrence of the problem.\n"
+ },
+ "instance": {
+ "type": "string",
+ "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
+ "format": "URI"
+ }
+ },
+ "required": [
+ "status",
+ "detail"
+ ]
+ },
+ "resourceChanges": {
+ "type": "object",
+ "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.\n",
+ "properties": {
+ "affectedVnfcs": {
+ "type": "array",
+ "description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "items": {
+ "type": "object",
+ "description": "This type provides information about added, deleted, modified and temporary VNFCs. \n",
+ "required": [
+ "id",
+ "vduId",
+ "changeType",
+ "computeResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "vduId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "changeType": {
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ],
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n"
+ },
+ "computeResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ },
+ "affectedVnfcCpIds": {
+ "type": "array",
+ "description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ },
+ "addedStorageResourceIds": {
+ "type": "array",
+ "description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ },
+ "removedStorageResourceIds": {
+ "type": "array",
+ "description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
+ "items": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ }
+ },
+ "affectedVirtualLinks": {
+ "type": "array",
+ "description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "items": {
+ "type": "object",
+ "description": "This type provides information about added, deleted, modified and temporary VLs.\n",
+ "required": [
+ "id",
+ "virtualLinkDescId",
+ "changeType",
+ "networkResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "virtualLinkDescId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "changeType": {
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY",
+ "LINK_PORT_ADDED",
+ "LINK_PORT_REMOVED"
+ ],
+ "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.\n"
+ },
+ "networkResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ }
+ }
+ }
+ },
+ "affectedVirtualStorages": {
+ "type": "array",
+ "description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "items": {
+ "type": "object",
+ "description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
+ "required": [
+ "id",
+ "virtualStorageDescId",
+ "changeType",
+ "storageResource"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ },
+ "virtualStorageDescId": {
+ "type": "string",
+ "description": "An identifier that is unique within a VNF descriptor.\n"
+ },
+ "changeType": {
+ "type": "string",
+ "enum": [
+ "ADDED",
+ "REMOVED",
+ "MODIFIED",
+ "TEMPORARY"
+ ],
+ "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n"
+ },
+ "storageResource": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "metadata": {
+ "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. \n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "changedInfo": {
+ "type": "object",
+ "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
+ "properties": {
+ "vnfInstanceName": {
+ "type": "string",
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n"
+ },
+ "vnfInstanceDescription": {
+ "type": "string",
+ "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n"
+ },
+ "vnfConfigurableProperties": {
+ "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. \n"
+ },
+ "metadata": {
+ "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. \n"
+ },
+ "extensions": {
+ "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. \n"
+ },
+ "vimConnectionInfo": {
+ "type": "array",
+ "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
+ "items": {
+ "type": "object",
+ "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.\n",
+ "required": [
+ "id",
+ "vimType"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vimId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "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.\n"
+ },
+ "interfaceInfo": {
+ "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. \n"
+ },
+ "accessInfo": {
+ "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. \n"
+ },
+ "extra": {
+ "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. \n"
+ }
+ }
+ }
+ },
+ "vnfPkgId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfdId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "vnfProvider": {
+ "type": "string",
+ "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId� attribute.\n"
+ },
+ "vnfProductName": {
+ "type": "string",
+ "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId� attribute.\n"
+ },
+ "vnfSoftwareVersion": {
+ "type": "string",
+ "description": "A Version.\n"
+ },
+ "vnfdVersion": {
+ "type": "string",
+ "description": "A Version.\n"
+ }
+ }
+ },
+ "changedExtConnectivity": {
+ "type": "array",
+ "description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "extLinkPorts": {
+ "type": "array",
+ "description": "Link ports of this VL.\n",
+ "items": {
+ "type": "object",
+ "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",
+ "required": [
+ "id",
+ "resourceHandle"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceHandle": {
+ "type": "object",
+ "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
+ "required": [
+ "vimConnectionId",
+ "resourceId"
+ ],
+ "properties": {
+ "vimConnectionId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceProviderId": {
+ "type": "string",
+ "description": "An identifier with the intention of being globally unique.\n"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
+ },
+ "vimLevelResourceType": {
+ "type": "string",
+ "description": "Type of the resource in the scope of the VIM or the resource provider.\n"
+ }
+ }
+ },
+ "cpInstanceId": {
+ "type": "string",
+ "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "_links": {
+ "type": "object",
+ "description": "Links to resources related to this resource.\n",
+ "required": [
+ "self",
+ "vnfInstance"
+ ],
+ "properties": {
+ "self": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "vnfInstance": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "grant": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "cancel": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "retry": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "rollback": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ },
+ "fail": {
+ "type": "object",
+ "description": "This type represents a link to a resource.\n",
+ "required": [
+ "href"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "URI of the referenced resource.\n",
+ "format": "url"
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOperationOccurrenceNotification.schema.json b/SOL002/VNFLifecycleManagement-API_egm/schemas/vnfLcmOperationOccurrenceNotification.schema.json
new file mode 100644
index 00000000..e69de29b
diff --git a/SOL002/VNFLifecycleManagement-API_egm/variables.txt b/SOL002/VNFLifecycleManagement-API_egm/variables.txt
new file mode 100644
index 00000000..8ff721ab
--- /dev/null
+++ b/SOL002/VNFLifecycleManagement-API_egm/variables.txt
@@ -0,0 +1,38 @@
+*** Variables ***
+${VNFM_HOST} localhost # Hostname of the VNFM
+${VNFM_PORT} 8080 # Listening port of the VNFM
+${NFVO_HOST} localhost # Hostname of the NFVO
+${NFVO_PORT} 8081 # Listening port of the NFVO
+${VNFM_SCHEMA} https
+${NFVO_SCHEMA} https
+${AUTHORIZATION} Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+${CONTENT_TYPE} application/json
+${CONTENT_TYPE_PATCH} application/merge-patch+json
+${ACCEPT} application/json
+${apiRoot} /
+${apiName} vnflcm
+${apiVersion} v1
+${AUTH_USAGE} 1
+${WRONG_AUTHORIZATION} Bearer XXXXXWRONGXXXXX
+${vnfInstanceId} 6fc3539c-e602-4afa-8e13-962fb5a7d81f
+${vnfInstanceName} Test-VnfInstance
+${vnfInstanceDescription} description vnf
+${vnfInstanceDescription_Update} Updated description vnf
+${SINGLE_FILE_VNFD} 1 # If VNFD is PLAIN TEXT
+${ACCEPT_PLAIN} text/plain
+${ACCEPT_ZIP} application/zip
+${vnfPkgId_processing} 007c111c-38a1-42c0-a666-7475ecb1567c
+${ARTIFACT_TYPE} application/octet-stream
+${ARTIFACT_ID} artifactId
+${WRONG_ACCEPT} application/json
+${vnfLcmOpOccId} 6fc3539c-e602-4afa-8e13-962fb5a7d81d
+${CancelMode} GRACEFUL
+${NVFM_DUPLICATION} 0
+${sub_filter} filter
+${sub_filter_invalid} filter_invalid
+${subscriptionId} 6fc3539c-e602-4afa-8e13-962fb5a7d81f
+${notification_ep} /notification
+${notification_port} 9091
+${VnfLcmOperationOccurrenceNotification} {}
+${VnfIdentifierCreationNotification} {}
+${VnfIdentifierDeletionNotification} {}
\ No newline at end of file
diff --git a/TrackingStatus.txt b/TrackingStatus.txt
index 66012e49..e0411ada 100644
--- a/TrackingStatus.txt
+++ b/TrackingStatus.txt
@@ -2,7 +2,13 @@ SOL002
- VNFConfiguration-API_egm --------------------------------> [NOT STARTED]
- - VNFFaultManagement-API_egm ------------------------------> [NOT STARTED]
+ - VNFFaultManagement-API_egm ------------------------------> [DONE]
+ * Alarms ----------------------------------------------------> [DONE]
+ * IndividualAlarm -------------------------------------------> [DONE]
+ * Subscriptions --------------------------------------------> [DONE]
+ * EscalatePerceivedSeverityTask ----------------------------> [DONE]
+ * IndividualSubscription -----------------------------------> [DONE]
+ * NotificationEndpoint -------------------------------------> [DONE]
- VNFIndicator-API_nxw ------------------------------------> [DONE]
* VNFIndicators --------------------------------------------> [DONE]
@@ -14,7 +20,26 @@ SOL002
- VNFIndicatorNotification-API_nxw ------------------------> [DONE]
* VNFIndicatorNotification ---------------------------------> [DONE]
- - VNFLifecycleManagement-API_egm --------------------------> [NOT STARTED]
+ - VNFLifecycleManagement-API_egm --------------------------> [DONE]
+ * VNFInstances ----------------------------------------------> [DONE]
+ * IndividualVNFInstance -------------------------------------> [DONE]
+ * InstantiateVNFTask ----------------------------------------> [DONE]
+ * ScaleVNFTask ----------------------------------------------> [DONE]
+ * ScaleVNFToLevelTask ---------------------------------------> [DONE]
+ * ChangeExternalVNFConnectivityTask ------------------------> [DONE]
+ * TerminateVNFTask -----------------------------------------> [DONE]
+ * HealVNFTask ----------------------------------------------> [DONE]
+ * OperateVNFTask -------------------------------------------> [DONE]
+ * ChangeExternalVNFConnectivityTask ------------------------> [DONE]
+ * VnfLcmOperationOccurences --------------------------------> [DONE]
+ * IndividualVnfLcmOperationOccurence -----------------------> [DONE]
+ * RetryOperationTask ---------------------------------------> [DONE]
+ * RollbackOperationTask ------------------------------------> [DONE]
+ * FailOperationTask ----------------------------------------> [DONE]
+ * CancelOperationTask --------------------------------------> [DONE]
+ * Subscriptions --------------------------------------------> [DONE]
+ * IndividualSubscription -----------------------------------> [DONE]
+ * NotificationEndpoint -------------------------------------> [DONE] //to change the json schemas cause they're missing on the etsi api page
- VNFPerformanceManagement-API_nxw ------------------------> [DONE]
* PMJobs ----------------------------------------------------> [DONE]
--
GitLab