/
CPS APIs

CPS APIs

1. Details of Config DB APIs supported in Guilin

Please refer to below ConfigDB API swagger document for a full list of API's supported: ConfigDB Swagger JSON

Following API's are currently used to support RAN Network Slicing and OOF SON use case:

S.NoUse caseAPI endpointHTTP MethodDescriptionAPI input/Request PayloadResult obtained for API call (in case of GET)Yang sub-tree/element(s) accessed (for GET), or updated (for UPDATE)Consuming ComponentPriorityComments
1.E2E Network Slicing/api​/sdnc-config-db​/v4​/nearrtric-list​/{trackingArea}GET

Get ​complete details associated with a list of NearRT RIC's and

corresponding managed elements

trackingArea - String

<Changes at consumer end> - trackingArea should be an int

[
{
"gNBCUCPList": [
{
"cellCUList": [
{
"cellLocalId": 0,
"pLMNInfoList": [
{
"pLMNId": "string",
"sNSSAI": {
"configData": {
"dLThptPerSlice": 0,
"maxNumberOfConns": 0,
"uLThptPerSlice": 0
},
"globalSubscriberId": "string",
"sNSSAI": "string",
"status": "string",
"subscriptionServiceType": "string"
}
}
],
"resourceType": "string"
}
],
"gNBCUName": "string",
"gNBId": 0,
"gNBIdLength": 0,
"nFType": "string",
"nearRTRICId": 0,
"pLMNId": "string"
}
],
"gNBCUUPList": [
{
"gNBCUUPId": 0,
"gNBId": 0,
"gNBIdLength": 0,
"nearRTRICId": 0,
"pLMNInfoList": [
{
"pLMNId": "string",
"sNSSAI": {
"configData": {
"dLThptPerSlice": 0,
"maxNumberOfConns": 0,
"uLThptPerSlice": 0
},
"globalSubscriberId": "string",
"sNSSAI": "string",
"status": "string",
"subscriptionServiceType": "string"
}
}
],
"resourceType": "string"
}
],
"gNBDUList": [
{
"cellDUList": [
{
"administrativeState": "string",
"cellLocalId": 0,
"cellState": "string",
"nRPCI": 0,
"nRTAC": 0,
"operationalState": "string",
"pLMNInfoList": [
{
"pLMNId": "string",
"sNSSAI": {
"configData": {
"dLThptPerSlice": 0,
"maxNumberOfConns": 0,
"uLThptPerSlice": 0
},
"globalSubscriberId": "string",
"sNSSAI": "string",
"status": "string",
"subscriptionServiceType": "string"
}
}
],
"resourceType": "string"
}
],
"gNBDUId": 0,
"gNBDUName": "string",
"gNBId": 0,
"gNBIdLength": 0,
"nFType": "string",
"nearRTRICId": 0,
"pLMNId": "string"
}
],
"gNBId": 0,
"nearRTRICId": 0,
"pLMNInfoList": [
{
"pLMNId": "string",
"sNSSAI": {
"configData": {
"dLThptPerSlice": 0,
"maxNumberOfConns": 0,
"uLThptPerSlice": 0
},
"globalSubscriberId": "string",
"sNSSAI": "string",
"status": "string",
"subscriptionServiceType": "string"
}
}
],
"ranNFNSSIList": [
"string"
],
"resourceType": "string",
"trackingArea": [
"string"
]
}
]

Complete Yang model. Refer CPS-196


cps-ran-schema-model

SDN-R1

The result seems to be a a combination of many queries from differnt data sources


Several elements not clear in model?!:

  • TrackingArea = Tac? not string but 32bit int?
  • gNBCUCPList, 0x
  • cellCUList, 0x
  • pLMNInfoList, 4x

Tac is a type, used by nRTAC, which is normal (normal not key) leaf for NRCellDUGroup which is used by NRCellDU (Yang List)

Proposed CPS query:
get all elelements (with children?) in list (NRCellDU) fiter on one attribue vale (nRTAC)

<Ahila> Please note the below:

  1. Fetch the List of Cells using API #2
  2. Fetch the parents and grandparents pertaining to those cells
2.E2E Network Slicing/api/sdnc-config-db/v4/cell-list/{trackingArea}GETGet a list of cells that correspond to a specific tracking area

trackingArea - String

<Changes at consumer end> - trackingArea should be an int

[
  "15289",
"15290",
"15296"
]

cps-cavsta-onap-internal

+--rw taCellsList* [cellLocalId]
+--rw cellLocalId int32

SDN-R

1

Proposed CPS query:
get all elelements in list (NRCellDU) fiter on one attribue vale (nRTAC)

Same as #1 except without children

Refer cps-cavsta-onap-internal

In scope of H-release

3.E2E Network Slicing/api/sdnc-config-db/v4/nearRTRICPUTStore nearRTRIC details{
    "nearRTRICId":22,
    "gNBId":98763,
    "trackingArea":[
        "Kingston"
    ],
    "resourceType":"NearRTRIC",
    "ranNFNSSIList":[
        "11",
        "22"
    ],
    "pLMNInfoList":[
        {
            "pLMNId":"310-410",           
            "sNSSAI":{
                "sNSSAI":"001-010000",
                "status":"ACTIVE",
            "globalSubscriberId":"Customer-001",
                "subscriptionServiceType":"Premium",
                "configData": {
                    "dLThptPerSlice":25,
                    "uLThptPerSlice":30,
                    "maxNumberOfConns":3000
                }
            }
        }       
    ]
}

cps-ran-schema-model

+--rw NearRTRIC* [idNearRTRIC]
+--rw idNearRTRIC string
+--rw attributes
| +--rw dnPrefix? DistinguishedName
| +--rw userLabel? string
| +--ro locationName? string
| +--ro gNBId? int64
| +--rw pLMNInfoList* [mcc mnc]
| | +--rw mcc Mcc
| | +--rw mnc Mnc
| | +--rw sNSSAIList* [sNssai]
| | +--rw sNssai string
| | +--rw status? string
| | +--rw configData* [configParameter]
| | +--rw configParameter string
| | +--rw configValue? int64

SDN-R1

There is no model that defines that has a TrackingArea String

is this now the 'locationName'?

suggested CPS-action: Update DataNode with children (in this case a list) all children will be replaced! All unchanged data has to be provided too!

Note 1. SNSSAIList is a list contained within each element of PLMNInfo

Yes. Refer Section-3 for field mapping

Note 2. Please note this action replace all existing list element, it is NOT an add-to-element action

<Need to discuss>

4.E2E Network Slicing/api/sdnc-config-db/v4/gNBCUCPPUTStore gNBCUCP, NRCellCU details

{
   "gNBCUName":"cucpserver1"
   "gNBId":98763,
   "gNBIdLength":5,
   "pLMNId":"310-410",
   "nFType":"CUCP",
   "nearRTRICId":11,
   "cellCUList":[
       {
    "cellLocalId":103594000,
    "pLMNInfoList":[
        {
            "pLMNId":"310-200",
            "sNSSAI":{
                "sNSSAI":"001-00110",
                "status":"ACTIVE",
                 "configData":{
                    "maxNumberOfConns"7000
            }
            }
        }
    ]
}
   ]
}


cps-ran-schema-model

+--rw GNBCUCPFunction* [idGNBCUCPFunction]
+--rw idGNBCUCPFunction string
+--rw attributes
| +--rw gNBId? int64
| +--rw gNBIdLength? int32
| +--rw gNBCUName? string
| +--rw pLMNId* [mcc mnc]
| +--rw mcc Mcc
| +--rw mnc Mnc
+--rw NRCellCU* [idNRCellCU]
+--rw idNRCellCU string
+--rw attributes
| +--rw cellLocalId? int32
| +--rw pLMNInfoList* [mcc mnc]
| | +--rw mcc Mcc
| | +--rw mnc Mnc
| | +--rw sNSSAIList* [sNssai]
| | +--rw sNssai string
| | +--rw status? string
| | +--rw configData* [configParameter]
| | +--rw configParameter string
| | +--rw configValue? int64

SDN-R1

from CPS point of view this case is similar as previous case (#3), just different target (parent)data node.

suggested CPS-action: Update DataNode with children (in this case a list) all children will be replaced! All unchanged data has to be provided too!

<Need to discuss>

5.E2E Network Slicing/api/sdnc-config-db/v4/gNBCUUPPUTStore gNBCUUP details

{
   "gNBCUUPId":1111
   "gNBId":98763,
   "gNBIdLength":2,
   "pLMNId":"310-410",
   "resourceType":"DRB",
   "nearRTRICId":11,
    "pLMNInfoList":[
        {
            "pLMNId":"310-410",
            "sNSSAI":{
                "sNSSAI":"001-003",
                "status":"ACTIVE",
                "configData":{
                    "maxNumberOfConns"3000
            }
            }
        }
    ]
}


cps-ran-schema-model

+--rw GNBCUUPFunction* [idGNBCUUPFunction]
| +--rw idGNBCUUPFunction string
| +--rw attributes
| +--ro gNBCUUPId? uint64
| +--rw gNBId? int64
| +--rw pLMNInfoList* [mcc mnc]
| +--rw mcc Mcc
| +--rw mnc Mnc
| +--rw sNSSAIList* [sNssai]
| +--rw sNssai string
| +--rw status? string
| +--rw configData* [configParameter]
| +--rw configParameter string
| +--rw configValue? int64

SDN-R1

from CPS point of view this case is similar as previous 2 cases (#3, #4), just different target (parent)data node.

suggested CPS-action: Update DataNode with children (in this case a list) all children will be replaced! All unchanged data has to be provided too!

<Need to discuss>

6.E2E Network Slicing/api/sdnc-config-db/v4/gNBDUPUTStore gNBDU, NRCellDU details

{
   "gNBDUId":4
   "gNBId":98763,
   "gNBIdLength":5,
   "pLMNId":"310-410",
   "gNBDUName":"gnduserver4",
   "nFType":"DU",
   "nearRTRICId":22,
   "cellDUList":[
       {