Post V271 Vnflcm V2 Vnf Instances
Create VNF Identifier. The POST method creates a new VNF instance resource. This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, a new "Individual VNF instance" resource as defined in clause 5.4.3 shall have been created, and the value of the "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification of type VnfIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 5.5.2.18.
The tenant identifier
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
The authorization token for the request. Reference: IETF RFC 7235
The MIME type of the body of the request. Reference: IETF RFC 7231
Version of the API requested to use when responding to this request.
The VNF creation parameters
{
"vnfdId": "string",
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"metadata": {
"tags": [
{
"name": "string",
"autoCreated": false
}
],
"extensionId": "string"
}
}Human-readable name of the VNF instance to be created.
Human-readable description of the VNF instance to be created.
201 CREATED Shall be returned when a new "Individual VNF instance" resource and the associated VNF instance identifier washas been created successfully. The response body shall contain a representation of the created VNF instance, as defined in clause 5.5.2.2. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created VNF instance.
{
"id": "string",
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string",
"vimConnectionInfo": [
{
"id": "string",
"vimId": "string",
"vimType": "string",
"extra": {
"deploymentProfileId": "string",
"nodeProfileName": "string",
"nodePoolId": "string",
"nodePoolName": "string",
"vimName": "string",
"nodePoolBatchSize": 0,
"nodePools": [
"string"
]
}
}
],
"instantiationState": "string",
"instantiatedVnfInfo": {
"flavourId": "string",
"vnfState": "string",
"scaleStatus": [
{
"aspectId": "string",
"scaleLevel": 0
}
],
"maxScaleLevels": [
{
"aspectId": "string",
"scaleLevel": 0
}
],
"extCpInfo": [
{
"id": "string",
"cpdId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
}
}
],
"extLinkPortId": "string",
"associatedVnfcCpId": "string",
"associatedVnfVirtualLinkId": "string"
}
],
"extVirtualLinkInfo": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string"
}
]
}
],
"extManagedVirtualLinkInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string"
}
]
}
],
"monitoringParameters": [
{
"id": "string",
"name": "string",
"performanceMetric": "string"
}
],
"localizationLanguage": "string",
"vnfcResourceInfo": [
{
"id": "string",
"vduId": "string",
"computeResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"zoneId": "string",
"storageResourceIds": [
"string"
],
"reservationId": "string",
"vnfcCpInfo": [
{
"id": "string",
"cpdId": "string",
"vnfExtCpId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
}
}
],
"vnfLinkPortId": "string"
}
],
"metadata": {
"dispatchType": "string",
"namespace": "string",
"chartName": "string",
"chartVersion": "string",
"repoUrl": "string",
"username": "string",
"helmVersion": "string",
"instantiationState": "string"
}
}
],
"virtualLinkResourceInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"zoneId": "string",
"reservationId": "string",
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string"
}
]
}
],
"virtualStorageResourceInfo": [
{
"id": "string",
"virtualStorageDescId": "string",
"storageResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"zoneId": "string",
"reservationId": "string"
}
]
},
"metadata": {
"vnfPkgId": "string",
"vnfCatalogName": "string",
"managedBy": {
"extensionSubtype": "string",
"extensionName": "string"
},
"nfType": "string",
"lcmOperation": "string",
"lcmOperationState": "string",
"isUsedByNS": "string",
"attachedNSCount": 0,
"isolationMode": "string",
"creationUser": "string",
"creationTenantId": "string",
"extVirtualLinks": [
{
"id": "string",
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"extCps": [
{
"cpdId": "string",
"cpConfig": [
{
"cpInstanceId": "string",
"linkPortId": "string",
"cpProtocolData": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"fixedAddresses": [
"string"
],
"numDynamicAddresses": 0,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
}
}
]
}
]
}
],
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
}
}
]
}
],
"tags": [
{
"name": "string",
"autoCreated": false
}
]
},
"_links": {
"self": {
"href": "string"
},
"indicators": {
"href": "string"
},
"instantiate": {
"href": "string"
},
"terminate": {
"href": "string"
},
"scale": {
"href": "string"
},
"scaleToLevel": {
"href": "string"
},
"changeFlavour": {
"href": "string"
},
"heal": {
"href": "string"
},
"operate": {
"href": "string"
},
"changeExtConn": {
"href": "string"
}
}
}Name of the VNF instance. This attribute can be modified with the PATCH method.
Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.
Provider of the VNF and the VNFD. The value is copied from the VNFD.
Name to identify the VNF Product. The value is copied from the VNFD.
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.
The instantiation state of the VNF.
Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.
Links to resources related to this resource.
Response Headers
The MIME type of the body of the response.
The resource URI of the created VNF instance.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.