Versions Compared

Old Version 2

changes.mady.by.user Reshmasree c

Saved on

compared with

New Version Current

changes.mady.by.user Deepika S

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Swagger link : SO Swagger

API exposed by NSSMF

Allocate NSSI

MethodURL
POST
{api-handler-url}/api/rest/provMns/v1/NSS/SliceProfiles/{network-type}
/onap/so/infra/3gppservices/v1/allocate

Request Example for "networkType"s of "an" or "cn"Request Example

JSON Viewer
modeText
{
"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",
"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,
"allocateAnNssiresourceSharingLevel": "non-shared"
},
"endPoints":{
       "nsstId     "ipAdress": "",
            "logicInterfaceId": "",
            "nextHopInfo": ""
},
"nsiInfo": {
"nsiId": "NSSTNSI-CM-001-HDBNJ-NSSMFNSMF-01-A-ZX",
"nsiName": "eMBB-001"
},
"scriptName": "AN1"
}
}


Request Example for "networkType"s of "tn"

JSON Viewer
modeText
{
  "name": "slice-alloc-002",
  "modelInvariantUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
  "modelUuid": "6790ab0e-034f-11eb-adc1-0242ac120002",
  "globalSubscriberId": "5GCustomer",
 "nssiName "subscriptionServiceType": "5G",
  "networkType": "tn",
  "additionalProperties": {
    "enableSdnc": "true",
    "serviceInstanceID": "eMBBslice-001101",
    "sliceProfile": {
      "snssaiList": [
        "001-100001"
      ],
      "sliceProfileId": "ab9af40f13f721b5f13539d87484098",
      "plmnIdListpLMNIdList": [
        "460-00",
        "460-01"
      ],
      "perfReq": {
      },
      "perfReqEmbbList coverageAreaTAList": [
      ],
      {"latency": 2,
      "maxBandwidth": 3000,
      "activityFactorresourceSharingLevel": 50
 "non-shared"
    },
    "transportSliceNetworks": [
    }
        ]{
      },
          "maxNumberofUEsconnectionLinks": 200,
[
          "coverageAreaTAList": [          {
        "1",
         "2",
       "name": "3slice-link-1",
        "4"
          ],
      "latencytransportEndpointA": 2"tranportEp_src_ID_111_1",
         "resourceSharingLevel               "transportEndpointB": "non-shared"
tranportEp_dst_ID_212_1"
                    },
          "endPoints":[{
	"nodeId":"",
	"additionalInfo":{"xxx":"xxx"}
	},
	{
	"nodeId":"",
	"additionalInfo":{"xxx":"xxx"}
	}          {
                        "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",
    "additionalProperties": {
      "XXX": "XXX"
    }
  }
}}
}


Response Example

JSON Viewer
modeText
{
  "jobId": "db245365e79c47ed88fcd60caa8f6549",
  "status": "",
  "statusDescription": {}
}

Note :  modelInvariantUuid and modelUuid corresponds to NSST Ids..

Modify NSSI

MethodURL
PUT
{api-handler-url}/api/rest/provMns/v1/NSS/{nssi}/{network-type}
/onap/so/infra/3gppservices/v1/modify

Request Example for "networkType"s of "an" or "cn"Request Example

JSON Viewer
modeText
{
    "modifyAnNSSI": {    "name": "eMBB-001",
		"globalSubscriberId":"5GCustomer",
		"subscriptionServiceType":"5G",
		"networkType":"an/cn",   
        "nssiIdserviceInstanceID": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX",
        "nssiNameadditionalProperties": "eMBB-001",
		"sNssaiList {
		   "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
modeText
{
  "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"
      ],
       "XXX": "XXX""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
modeText
{
  "jobId": "db245365e79c47ed88fcd60caa8f6549",
  "status": "",
  "statusDescription": {}
}

Activate NSSI

MethodURL
POST
{api-handler-url}/api/rest/provMns/v1/NSS/{snssai}/activation/{network-type}
/onap/so/infra/3gppservices/v1/activate

Request Example


JSON Viewer
modeText
{
  "actDeActNssi": {
    "nsiIdserviceInstanceID": "NSINSSI-MC-001-HDBNJ-NSMFNSSMF-01-A-ZX",
	"networkType":"an/cn/tn",
	"globalSubscriberId":"5GCustomer",
	"subscriptionServiceType":"5G",
    "nssiIdadditionalProperties": {
         	"nsiId": "NSSINSI-CM-001-HDBNJ-NSSMFNSMF-01-A-ZX",
			"snssaiList": [
       "additionalProperties": {			"001-100001"
   			 ],
        "XXX			"sliceProfileId": "XXX"
        }
  }
}

Response Example


JSON Viewer
modeText
{
  "jobId": "db245365e79c47ed88fcd60caa8f6549",
  "status": "",
  "statusDescription": {}
}

Deactivate NSSI

MethodURL
POST
{api-handler-url}/api/rest/provMns/v1/NSS/{snssai}/deactivation/{network-type}

/onap/so/infra/3gppservices/v1/deActivate

Request Example


JSON Viewer
modeText
{
  "actDeActNssi": {
    "nsiIdserviceInstanceID": "NSINSSI-MC-001-HDBNJ-NSMFNSSMF-01-A-ZX",
	"networkType":"an/cn/tn",
	"globalSubscriberId":"5GCustomer",
	"subscriptionServiceType":"5G",
    "nssiIdadditionalProperties": {
         	"nsiId": "NSSINSI-CM-001-HDBNJ-NSSMFNSMF-01-A-ZX",
			"snssaiList": [
       "additionalProperties": {			"001-100001"
   			 ],
        "XXX			"sliceProfileId": "XXX"
        }
  }
}

Response Example


JSON Viewer
modeText
{
  "jobId": "db245365e79c47ed88fcd60caa8f6549",
  "status": "",
  "statusDescription": {}
}

Deallocate NSSI

MethodURL
DELETE
{api-handler-url}/api/rest/provMns/v1/NSS/nssi/{nssiId}/{network-type}
/onap/so/infra/3gppservices/v1/deAllocate

Request Example


JSON Viewer
modeText
{
    "serviceInstanceID":  "deAllocateNssi"NSSI-C-001-HDBNJ-NSSMF-01-A-ZX ",
	"networkType":"an/cn/tn",
	"globalSubscriberId":"5GCustomer",
	"subscriptionServiceType":"5G",
    "additionalProperties": {
            "snssaisnssaiList": [
      			"001-100001"
    		],
			"sliceProfileId": "",
   			"scriptName": "AN1",
			"nsiId": "NSI-M-001-HDBNJ-NSMF-01-A-ZX",
    }
}

Response Example


JSON Viewer
modeText
{
  "jobId"nssiId": "NSSI-C-001-HDBNJ-NSSMF-01-A-ZX db245365e79c47ed88fcd60caa8f6549",
  "status": "",
  "terminateNssiOptionstatusDescription": 0,{}
}

Sub-net Capability query

MethodURL
GET/onap/so/infra/3gppservices/v1/subnetCapabilityQuery

Request Example (AN)

JSON Viewer
modeText
{
    "scriptNamesubnetTypes": [
      "AN1AN",
    ]
}

Response Example(AN)

JSON Viewer
modeText
{
  "AN"additionalProperties": {
    "latency": "",
    "maxNumberofUEs": "",
    "XXXmaxThroughput": "XXX",
     }"terminalDensity": ""
  }
}

Response Request Example (CN)

JSON Viewer
modeText
{
    "jobIdsubnetTypes": "db245365e79c47ed88fcd60caa8f6549"
}

Sub-net Capability query

[
      "CN"
    ]
}

Response Example(CN)

JSON Viewer
modeText
{
  "CN": {
    "latency": "",
    "maxThroughput": "",
    "maxNumberofConns": ""
  }
}

Request Example (TN)

...

Request Example

JSON Viewer
modeText
{
    "subnetCapabilityQuerysubnetTypes": {[
      "TN_FH",
    "subnetTypes":  ["ANTN_MH"],
        }"TN_BH"
    ]
}

Response Example(TN)

JSON Viewer
modeText
{"AN
  "TN_FH": {
    "latency": "",
    "maxThroughput": ""
  },
  "TN_MH": {
    "maxNumberofUEslatency": "",
    "maxThroughput": ""
  },
"terminalDensity":  "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