API exposed by NSSMF
Allocate NSSI
| Method | URL |
|---|
| POST | /onap/so/infra/3gppservices/v1/allocate |
Request Example
{
"name": "eMBB-001",
"templateId": "NSST-C-001-HDBNJ-NSSMF-01-A-ZX",
"globalSubscriberId":"5GCustomer",
"serviceType":"5G",
"networkType":"AN/CN/TN",
"additionalProperties": {
"sliceProfile": {
"snssaiList": [
"001-100001"
],
"sliceProfileId": "ab9af40f13f721b5f13539d87484098",
"plmnIdList": [
"460-00",
"460-01"
],
"perfReq": {
"perfReqEmbbList ": [
{
"activityFactor": 50
}
]
},
"maxNumberofUEs": 200,
"coverageAreaTAList": [
"1",
"2",
"3",
"4"
],
"latency": 2,
"resourceSharingLevel": "non-shared"
},
"endPoints":[{
"nodeId":"",
"additionalInfo":{"xxx":"xxx"}
},
{
"nodeId":"",
"additionalInfo":{"xxx":"xxx"}
}],
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}
Response Example
{
"jobId": "db245365e79c47ed88fcd60caa8f6549"
}
Modify NSSI
| Method | URL |
|---|
| PUT | /onap/so/infra/3gppservices/v1/modify |
Request Example
{
"name": "eMBB-001",
"globalSubscriberId":"5GCustomer",
"serviceType":"5G",
"networkType":"AN/CN/TN",
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"additionalProperties": {
"modifyAction":"allocate/deallocate",
"sNssaiList":["001-100001"],
"nsiInfo": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}
Response Example
{
"jobId": "db245365e79c47ed88fcd60caa8f6549"
}
Activate NSSI
| Method | URL |
|---|
| POST | /onap/so/infra/3gppservices/v1/activate |
Request Example
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"networkType":"AN/CN/TN",
"globalSubscriberId":"5GCustomer",
"serviceType":"5G",
"additionalProperties": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX"
}
}
Response Example
{
"jobId": "db245365e79c47ed88fcd60caa8f6549"
}
Deactivate NSSI
| Method | URL |
|---|
| POST | /onap/so/infra/3gppservices/v1/deActivate |
Request Example
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
"networkType":"AN/CN/TN",
"globalSubscriberId":"5GCustomer",
"serviceType":"5G",
"additionalProperties": {
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX"
}
}
Response Example
{
"jobId": "db245365e79c47ed88fcd60caa8f6549"
}
Deallocate NSSI
| Method | URL |
|---|
| DELETE | /onap/so/infra/3gppservices/v1/deAllocate |
Request Example
{
"serviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX ",
"networkType":"AN/CN/TN",
"globalSubscriberId":"5GCustomer",
"serviceType":"5G",
"additionalProperties": {
"snssai": [
"001-100001"
],
"scriptName": "AN1",
"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX"
}
}
Response Example
{
"jobId": "db245365e79c47ed88fcd60caa8f6549"
}
Sub-net Capability query
| Method | URL |
|---|
| GET | /onap/so/infra/3gppservices/v1/subnetCapabilityQuery |
Request Example (AN)
{
"subnetTypes": [
"AN"
]
}
Response Example(AN)
{
"AN": {
"latency": "",
"maxNumberofUEs": "",
"maxThroughput": "",
"terminalDensity": ""
}
}
Request Example (CN)
{
"subnetTypes": [
"CN"
]
}
Response Example(CN)
{
"CN": {
"latency": "",
"maxThroughput": "",
"maxNumberofConns": ""
}
}
Request Example (TN)
{
"subnetTypes": [
"TN-FH",
"TN-MH",
"TN-BH"
]
}
Response Example(TN)
{
"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.
API consumed by NSSMF
OOF ↔ NSSMF
1.NSSI Selection - OOF
2.NSSI Deallocation - OOF
