You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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.NoAPI 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 ComponentUsecaseComments
1./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[
{
"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-196SDN-RSlicing
2./api/sdnc-config-db/v4/cell-list/{trackingArea}GETGet a list of cells that correspond to a specific tracking areatrackingArea - String
[
  "15289",
  "15290",
  "15296"
]
+--rw taCellsList* [cellLocalId]
+--rw cellLocalId int32		SDN-R

3./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
                }
            }
        }       
    ]
}
+--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-RSlicing
4./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
            }
            }
        }
    ]
}
   ]
}


+--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-RSlicing
5./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
            }
            }
        }
    ]
}


+--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-RSlicing
6./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":[
       {
    "cellLocalId":112951561,
    "operationalState":"ENABLED",
    "administrativeState":"UNLOCKED",
    "cellState":"ACTIVE",
    "nRPCI":12,
    "nRTAC":310,
    "resourceType":"PRB",
    "pLMNInfoList":[
        {
            "pLMNId":"310-410",            
            "sNSSAI":{
                "sNSSAI":"001-010000",
                "status":"ACTIVE",
                "configData":{
               "dLThptPerSlice": 9,
                "uLThptPerSlice": 10
                }
            }
        }
    ]
},
{
    "cellLocalId":112951562,
    "operationalState":"ENABLED",
    "administrativeState":"UNLOCKED",
    "cellState":"ACTIVE",
    "nRPCI":12,
    "nRTAC":310,
    "resourceType":"PRB",
    "pLMNInfoList":[
        {
            "pLMNId":"310-410",            
            "sNSSAI":{
                "sNSSAI":"001-010000",
                "status":"ACTIVE",
                "configData":{
               "dLThptPerSlice": 9,
                "uLThptPerSlice": 10
                }
            }
        }
    ]
},
{
    "cellLocalId":112951568,
    "operationalState":"ENABLED",
    "administrativeState":"UNLOCKED",
    "cellState":"ACTIVE",
    "nRPCI":12,
    "nRTAC":310,
    "resourceType":"PRB",
    "pLMNInfoList":[
        {
            "pLMNId":"310-410",            
            "sNSSAI":{
                "sNSSAI":"001-010000",
                "status":"ACTIVE",
                "configData":{
               "dLThptPerSlice": 9,
                "uLThptPerSlice": 10
                }
            }
        }
    ]
}
   ]
}


+--rw GNBDUFunction* [idGNBDUFunction]
| +--rw idGNBDUFunction string
| +--rw attributes
| | +--ro gNBId? int64
| | +--rw gNBIdLength? int32
| | +--rw gNBDUId? int64
| | +--rw gNBDUName? string
| +--rw NRCellDU* [idNRCellDU]
| +--rw idNRCellDU 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
| +--rw nRPCI? int32
| +--rw nRTAC? Tac		SDN-RSlicing
7./api/sdnc-config-db/v4/rrmPolicyPUTStore network elements' RRMPolicy details

{
    "rrmPolicyID":1,
    "resourceID":"113025289",
    "resourceType":"PRB",
    "sliceType":"eMBB",
    "quotaType":"STRICT",
    "rRMPolicyMaxRatio":0,
    "rRMPolicyMinRatio":10,
    "rRMPolicyDedicatedRatio":0,
    "rRMPolicyMemberList":[
        {
            "pLMNId":"310-400",
            "sNSSAI":"001-010000"
        }
    ]
}


+--rw RRMPolicyRatio* [id]
| | +--rw id string
| | +--rw attributes
| | +--rw resourceType? string
| | +--rw rRMPolicyMemberList* [idx]
| | | +--rw idx uint32
| | | +--rw mcc Mcc
| | | +--rw mnc Mnc
| | | +--rw sNSSAI? SNssai
| | +--rw quotaType? QuotaType
| | +--rw rRMPolicyMaxRatio? uint8
| | +--rw rRMPolicyMinRatio? uint8
| | +--rw rRMPolicyDedicatedRatio? uint8		SDN-RSlicing
8./api/sdnc-config-db/v4/ranslice-detailsPUTRAN Inventory. Store RAN slice details

{



    "ranNFNSSIId":"3f2f23fa-c567-4dd8-8f15-f95ae3e6fd82",

    "ranNSSIList":[

        "ran4"

    ],

    "nsiList":[

        "nsi1","nsi2"

    ],

    "nSSAIList":[

        "001-010000"

    ],

    "sliceProfilesList":[

        {

            "sliceProfileId": "878f32c0-3699-4dbd-95a3-1f01d6c763fd",

            "dLThptPerSlice": 25,

            "uLThptPerSlice": 30,

            "maxNumberofConns":3000,

            "sNSSAI":"001-010000",

            "pLMNIdList":"310-410"

        }

    ],

    "trackingAreaList":
        "Kingston" ,

    "subnetStatus":"ACTIVE",

    "nsstId":"NSSTID1",

    "sliceType":"eMBB",

    "isShareable":"true"

}
+--rw ran-inventory
+--rw rannfnssiid? string
+--rw sliceProfilesList* [sliceProfileId]
| +--rw sliceProfileId string
| +--rw sNSSAI? string
| +--rw maxNumberofUEs? int64
| +--rw latency? int64
| +--rw uLThptPerSlice? int64
| +--rw dLThptPerSlice? int64
| +--rw maxNumberofConns? int64
| +--rw uEMobilityLevel? string
| +--rw resourceSharingLevel? string
| +--rw coverageAreaList* string
| +--rw pLMNIdList* [mcc mnc]
| +--rw mcc Mcc
| +--rw mnc Mnc
+--rw subnetStatus? string
+--rw nsstid? string
+--rw slicetype? string
+--rw isshareable? string		SDN-RSlicinglittle difference can be found between the request payload and the yang model.  Yang model is final one.
9./api/sdnc-config-db/v4/du-list/{sNSSAI}GETFetch the DU functions for sNSSAIsNSSAI - String

[

{

   "gNBDUId":1,

   "gNBId":98763,

   "gNBIdLength":5,

   "pLMNId":"310-004",

   "gNBDUName":"gnduserver1",

   "nFType":"DU",

   "nearRTRICId":11,

   "cellDUList":[

       {

    "cellLocalId":1,

    "operationalState":"ENABLED",

    "administrativeState":"UNLOCKED",

    "cellState":"ACTIVE",

    "nRPCI":12,

    "nRTAC":310,

    "pLMNInfoList":[

        {

            "pLMNId":"310-004",

            "sNSSAI":{

                "sNSSAI":"001-003",

                "status":"ACTIVE",

                "configData":{

                "dLThptPerSlice": 45,

                "uLThptPerSlice": 40

                }

            }

        },

        {

            "pLMNId":"310-410",

            "sNSSAI":{

                "sNSSAI":"001-024",

                "status":"ACTIVE",

                "configData":{

                "dLThptPerSlice": 65,

                "uLThptPerSlice": 30

                }

            }

        }

    ]

}

   ]

}

]


+--rw GNBDUFunction* [idGNBDUFunction]
| +--rw idGNBDUFunction string
| +--rw attributes
| | +--ro gNBId? int64
| | +--rw gNBIdLength? int32
| | +--rw gNBDUId? int64
| | +--rw gNBDUName? string
| | +--rw RRMPolicyRatio* [id]
| | +--rw id string
| | +--rw attributes
| | +--rw resourceType? string
| | +--rw rRMPolicyMemberList* [idx]
| | | +--rw idx uint32
| | | +--rw mcc Mcc
| | | +--rw mnc Mnc
| | | +--rw sNSSAI? SNssai
| | +--rw quotaType? QuotaType
| | +--rw rRMPolicyMaxRatio? uint8
| | +--rw rRMPolicyMinRatio? uint8
| | +--rw rRMPolicyDedicatedRatio? uint8
| +--rw NRCellDU* [idNRCellDU]
| +--rw idNRCellDU string
| +--rw attributes
| +--rw RRMPolicyRatio* [id]
| | +--rw id string
| | +--rw attributes
| | +--rw resourceType? string
| | +--rw rRMPolicyMemberList* [idx]
| | | +--rw idx uint32
| | | +--rw mcc Mcc
| | | +--rw mnc Mnc
| | | +--rw sNSSAI? SNssai
| | +--rw quotaType? QuotaType
| | +--rw rRMPolicyMaxRatio? uint8
| | +--rw rRMPolicyMinRatio? uint8
| | +--rw rRMPolicyDedicatedRatio? uint8
| +--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
| +--rw nRPCI? int32
| +--rw nRTAC? Tac		DCAE-slice-analysis-msSlicing
10./api/sdnc-config-db/v4/du-cell-list/{sNSSAI}GETFetch DU Cells for sNSSAIsNSSAI - String

{

   "1": [

        {

            "cellLocalId": 111,

            "operationalState": "ENABLED",

            "administrativeState": "UNLOCKED",

            "cellState": "ACTIVE",

            "pLMNInfoList": [

                {

                    "pLMNId": "pLMNId1",

                    "sNSSAI": {

                        "sNSSAI": "001-003",

                        "status": "ACTIVE",

                        "globalSubscriberId": null,

                        "subscriptionServiceType": null,

                        "configData": {}

                    }

                },

                {

                    "pLMNId": "pLMNId2",

                    "sNSSAI": {

                        "sNSSAI": "001-024",

                        "status": "ACTIVE",

                        "globalSubscriberId": null,

                        "subscriptionServiceType": null,

                        "configData": {}

                    }

                }

            ],

            "nRPCI": 45,

            "nRTAC": 9087

        }

    ]

}

Note:

Key - nearRTRIC Id

value - list of cells

| +--rw NRCellDU* [idNRCellDU]
| +--rw idNRCellDU 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
| +--rw nRPCI? int32
| +--rw nRTAC? Tac		DCAE-slice-analysis-msSlicing

Yang model defines only the DUCellList which is the value in the response.

Key is a nearRTRICId

11./api/sdnc-config-db/v4/profile-config/{sNSSAI}GETFetch slice profile configuration for a sNSSAIsNSSAI - String

DCAE-slice-analysis-ms,

ML MS

SlicingThis API will be replaced by AAI APIs
12./api/sdnc-config-db/v4/slice-config/{sNSSAI}GETFetch NearRTRIC configuration for a sNSSAIsNSSAI - String

{

    "1": {

        "dLThptPerSlice": 45,

        "uLThptPerSlice": 40

    }

}

Note:

key "1" is nearRICId

Value - nssai config

| | +--rw configData* [configParameter]
| | +--rw configParameter string
| | +--rw configValue? int64		DCAE-slice-analysis-msSlicing

Yang model defines only the DUCellConfiguration.

Key is NEarRTRICid

13./api/sdnc-config-db/v4/subscriber-details/{sNSSAI}GETFetch subscriber detailssNSSAI - String

DCAE-slice-analysis-msSlicingThis API will be replaced by AAI APIs
14./api/sdnc-config-db/v3/insertDataPUTPre-load Cell Data
{
  "cellList": [
    {
      "Cell": {
        "latitude": "string",
        "longitude": "string",
        "networkId": "string",
        "nodeId": "string",
        "notes": "string",
        "physicalCellId": 0,
        "pnfId": "string",
        "sectorNumber": "string"
      },
      "neighbor": [
        "string"
      ]
    }
  ]
}


OOF-PCI MSSON
15./api/sdnc-config-db/v3/modifyPci/{cellId}PATCHModfify PCI value of a cell


SDNRSON
16./api/sdnc-config-db/v3/modifyNbrHO/{cellId}/{targetCellId}PATCHModify HO (Handoff) flag for a target neighbor cell


SDNRSON
17./api/sdnc-config-db/v3/createNbr/{cellId}PUTCreate a neigbor for a cell
{
  "ho": true,
  "targetCellId": "string"
}


SDNRSON
18./api/sdnc-config-db/v3/deleteNbr/{cellId}/{targetCellId}DELETEDelete a neighbor for a call


SDNRSON
19.api/sdnc-config-db/v4/nearrtric/{ranNFNSSIId}GETFetches the NearRTRICs for the RANNFNSSI


SDNRSlicing

2. Sample CPS APIs (to mapper service and XPath queries)

  • No labels