API exposed by NSSMF
Allocate NSSI
Method | URL |
---|
POST | /onap/so/infra/3gppservices/v1/allocate |
Request Example for "networkType"s of "an" or "cn"
JSON Viewer |
---|
|
{
"name": "eMBB-001",
"modelInvariantUuid": "NSST-C-001-HDBNJ-NSSMF-01-A-ZX",
"modelUuid":"NSST-C-001-HDBNJ-NSSMF-01-A-ZX-UUID",
"globalSubscriberId":"5GCustomer",
"subscriptionServiceType":"5G",
"sst":"eMBB",
"networkType":"an/cn/tn",
"additionalProperties": {
"sliceProfile": {
"snssaiList": [
"001-100001"
],
"sliceProfileId": "ab9af40f13f721b5f13539d87484098",
"plmnIdListpLMNIdList": [
"460-00",
"460-01"
],
"perfReq": {
"perfReqEmbbList ": [
{
"activityFactor": 50
}
]
},
"maxNumberofUEs": 200,
"coverageAreaTAList": [
1,
2,
3,
4
],
"latency": 2,
"resourceSharingLevel": "non-shared"
},
"endPoints":{
"ipAdress": "",
"1",
"2",
"3",
"4"
],
"logicInterfaceId": "",
"nextHopInfo": ""
},
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}
|
Request Example for "networkType"s of "tn"
JSON Viewer |
---|
|
{
"name": "slice-alloc-002",
"modelInvariantUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
"modelUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
"globalSubscriberId": "5GCustomer",
"subscriptionServiceType": "5G",
"networkType": "tn",
"additionalProperties": {
"enableSdnc": "true",
"serviceInstanceID": "slice-101",
"sliceProfile": {
"snssaiList": [
"001-100001"
],
"sliceProfileId": "ab9af40f13f721b5f13539d87484098",
"pLMNIdList": [
"460-00",
"460-01"
],
"perfReq": {
},
"coverageAreaTAList": [
],
"latency": 2,
"maxBandwidth": 3000,
"resourceSharingLevel": "non-shared"
},
"transportSliceNetworks": [
{
"endPoints "connectionLinks": [
{
"nodeId":"",
"additionalInfo":{"xxx":"xxx"}
},
{
"nodeId":"",
"additionalInfo":{"xxx":"xxx"}
}],
"name": "slice-link-1",
"transportEndpointA": "tranportEp_src_ID_111_1",
"transportEndpointB": "tranportEp_dst_ID_212_1"
},
{
"name": "slice-link-2",
"transportEndpointA": "tranportEp_src_ID_111_2",
"transportEndpointB": "tranportEp_dst_ID_214_1"
},
{
"name": "slice-link-3",
"transportEndpointA": "tranportEp_src_ID_114_1",
"transportEndpointB": "tranportEp_dst_ID_212_2"
}
]
}
],
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}
|
Response Example
JSON Viewer |
---|
|
{
"jobId": "db245365e79c47ed88fcd60caa8f6549",
"status": "",
"statusDescription": {}
} |
Note : modelInvariantUuid and modelUuid corresponds to NSST Ids..
Modify NSSI
Method | URL |
---|
PUT | /onap/so/infra/3gppservices/v1/modify |
Request Example for "networkType"s of "an" or "cn"
JSON Viewer |
---|
|
{
"name": "eMBB-001",
"globalSubscriberId":"5GCustomer",
"subscriptionServiceType":"5G",
"networkType":"an/cn/tn",
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"additionalProperties": {
"modifyAction":"allocate/deallocate",
"snssaiList":["001-100001"],
"sliceProfileId":"",
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
} |
Request Example for "networkType"s of "tn"
JSON Viewer |
---|
|
{
"serviceInstanceID": "slice-101",
"name": "slice-alloc-002",
"modelInvariantUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
"modelUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
"globalSubscriberId": "5GCustomer",
"subscriptionServiceType": "5G",
"networkType": "tn",
"additionalProperties": {
"enableSdnc": "true",
"serviceInstanceID": "slice-101",
"sliceProfile": {
"snssaiList": [
"001-100001"
],
"sliceProfileId": "ab9af40f13f721b5f13539d87484098",
"pLMNIdList": [
"460-00",
"460-01"
],
"perfReq": {
},
"coverageAreaTAList": [
],
"latency": 2,
"maxBandwidth": 20000,
"resourceSharingLevel": "non-shared"
},
"transportSliceNetworks": [
{
"connectionLinks": [
{
"name": "slice-link-1",
"transportEndpointA": "tranportEp_src_ID_311_1",
"transportEndpointB": "tranportEp_dst_ID_512_1"
},
{
"name": "slice-link-2",
"transportEndpointA": "tranportEp_src_ID_314_1",
"transportEndpointB": "tranportEp_dst_ID_512_2"
},
{
"name": "slice-link-3",
"transportEndpointA": "tranportEp_src_ID_311_2",
"transportEndpointB": "tranportEp_dst_ID_514_1"
}
]
}
],
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}
|
Response Example
JSON Viewer |
---|
|
{
"jobId": "db245365e79c47ed88fcd60caa8f6549",
"status": "",
"statusDescription": {}
} |
Activate NSSI
Method | URL |
---|
POST | /onap/so/infra/3gppservices/v1/activate |
...
JSON Viewer |
---|
|
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"networkType":"an/cn/tn",
"globalSubscriberId":"5GCustomer",
"subscriptionServiceType":"5G",
"additionalProperties": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"snssaiList": [
"001-100001"
],
"sliceProfileId": ""
}
} |
Response Example
JSON Viewer |
---|
|
{
"jobId": "db245365e79c47ed88fcd60caa8f6549",
"status": "",
"statusDescription": {}
} |
Deactivate NSSI
Method | URL |
---|
POST | /onap/so/infra/3gppservices/v1/deActivate |
...
JSON Viewer |
---|
|
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"networkType":"an/cn/tn",
"globalSubscriberId":"5GCustomer",
"subscriptionServiceType":"5G",
"additionalProperties": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"snssaiList": [
"001-100001"
],
"sliceProfileId": ""
}
} |
Response Example
JSON Viewer |
---|
|
{
"jobId": "db245365e79c47ed88fcd60caa8f6549",
"status": "",
"statusDescription": {}
} |
Deallocate NSSI
Method | URL |
---|
DELETE | /onap/so/infra/3gppservices/v1/deAllocate |
...
JSON Viewer |
---|
|
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX ",
"networkType":"an/cn/tn",
"globalSubscriberId":"5GCustomer",
"subscriptionServiceType":"5G",
"additionalProperties": {
"snssaiList": [
"001-100001"
],
"sliceProfileId": "",
"scriptName": "AN1",
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX"
}
} |
...
JSON Viewer |
---|
|
{
"jobId": "db245365e79c47ed88fcd60caa8f6549",
"status": "",
"statusDescription": {}
} |
Sub-net Capability query
Method | URL |
---|
GET | /onap/so/infra/3gppservices/v1/subnetCapabilityQuery |
...
JSON Viewer |
---|
|
{
"subnetTypes": [
"TN-_FH",
"TN-_MH",
"TN-_BH"
]
} |
Response Example(TN)
JSON Viewer |
---|
|
{
"TN-_FH": {
"latency": "",
"maxThroughput": ""
},
"TN-_MH": {
"latency": "",
"maxThroughput": ""
},
"TN-_BH": {
"latency": "",
"maxThroughput": ""
}
} |
Note: Subnet capabilities are stored in a JSON properties file in so-api handler container.
Refer to swagger for allowed enum values.
API consumed by NSSMF
OOF ↔ NSSMF
1.NSSI Selection - OOF
2.NSSI Deallocation - OOF
...