Create Ns
The POST method creates a new NS instance resource. As the result of successfully executing this method, a new "Individual NS instance" resource as defined in clause 6.4.3 shall have been created, and the value of the "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification of type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 6.5.2.6.
The authorization token for the request. Reference: IETF RFC 7235.
Version of the API requested to use when responding to this request.
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
The MIME type of the body of the request. Reference: IETF RFC 7231
The NS creation parameters, as defined in clause 6.5.2.7.
{
"nsdId": "string",
"nsName": "string",
"nsDescription": "string"
}Human-readable name of the NS instance to be created.
Human-readable description of the NS instance to be created.
201 Created Shall be returned when a new "Individual NS instance" resource and the associated NS instance identifier has been created successfully. The response body shall contain a representation of the created NS instance, as defined in clause 6.5.2.10. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NS instance.
{
"id": "string",
"nsInstanceName": "string",
"nsInstanceDescription": "string",
"nsdId": "string",
"nsdInfoId": "string",
"flavourId": "string",
"vnfInstance": [
{
"id": "string",
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string",
"vnfPkgId": "string",
"vimId": "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"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
}
],
"extLinkPortId": {
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
},
"associatedVnfcCpId": "string",
"associatedVnfVirtualLinkId": "string"
}
],
"extVirtualLinkInfo": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string"
}
]
}
],
"extManagedVirtualLinkInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "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": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "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"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
}
],
"vnfLinkPortId": "string"
}
]
}
],
"virtualLinkResourceInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"reservationId": "string",
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string"
}
]
}
],
"virtualStorageResourceInfo": [
{
"id": "string",
"virtualStorageDescId": "string",
"storageResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"reservationId": "string"
}
]
},
"extensions": {
"managedBy": {
"extensionSubtype": "string",
"extensionName": "string"
},
"type": "string",
"networks": [
{
"resourceId": "string",
"networkName": "string",
"vl_id": "string",
"key_name": "string"
}
],
"vimName": "string",
"lcmOperation": "string",
"lcmOperationState": "string",
"isOrchestrated": false
}
}
],
"pnfInfo": [
{
"pnfId": "string",
"pnfName": "string",
"pnfdId": "string",
"pnfdInfoId": "string",
"pnfProfileId": "string",
"cpInfo": {
"cpInstanceId": "string",
"cpdId": "string",
"cpProtocolData": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"fixedAddresses": [
"string"
],
"numDynamicAddresses": 0,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
}
}
]
}
}
],
"virtualLinkInfo": [
{
"id": "string",
"nsVirtualLinkDescId": "string",
"nsVirtualLinkProfileId": "string",
"resourceHandle": [
{
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
}
],
"linkPort": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"nsCpHandle": [
{
"vnfInstanceId": "string",
"vnfExtCpInstanceId": "string",
"pnfInfoId": "string",
"pnfExtCpInstanceId": "string",
"nsInstanceId": "string",
"nsSapInstanceId": "string"
}
]
}
]
}
],
"vnffgInfo": [
{
"id": "string",
"vnffgdId": "string",
"vnfInstanceId": [
"string"
],
"pnfdInfoId": [
"string"
],
"nsVirtualLinkInfoId": [
"string"
],
"nsCpHandle": [
{
"vnfInstanceId": "string",
"vnfExtCpInstanceId": "string",
"pnfInfoId": "string",
"pnfExtCpInstanceId": "string",
"nsInstanceId": "string",
"nsSapInstanceId": "string"
}
]
}
],
"sapInfo": [
{
"id": "string",
"sapdId": "string",
"sapName": "string",
"description": "string",
"sapProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
}
]
}
],
"nestedNsInstanceId": [
"string"
],
"nsState": "string",
"monitoringParameter": [
{
"id": "string",
"name": "string",
"performanceMetric": "string"
}
],
"nsScaleStatus": [
{
"nsScalingAspectId": "string",
"nsScaleLevelId": "string"
}
],
"additionalAffinityOrAntiAffinityRule": [
{
"vnfdId": [
"string"
],
"vnfProfileId": [
"string"
],
"vnfInstanceId": [
"string"
],
"affinityOrAntiAffiinty": "string",
"scope": "string"
}
],
"_links": {
"self": {
"href": "string"
},
"nestedNsInstances": [
{
"href": "string"
}
],
"instantiate": {
"href": "string"
},
"terminate": {
"href": "string"
},
"update": {
"href": "string"
},
"scale": {
"href": "string"
},
"heal": {
"href": "string"
}
}
}Human readable name of the NS instance.
Human readable description of the NS instance.
Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.
The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.
Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.
Status of each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.
Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.
Links to resources related to this resource.
Response Headers
The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body.
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.
{
"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.