5 Configuration API Specifications

Configuration REST APIs are exposed directly on the nudr-config microservice of UDR, and it does not use Ingress Gateway for traffic (OAM traffic). These APIs are consumed by CNC Console GUI. For more information about APIs, see Oracle Communications Cloud Native Core Unified Data Repository User Guide.

5.1 Configuration APIs for UDR Microservices

This section describes the configuration APIs for UDR microservices.

Table 5-1 Configuration APIs for UDR microservices

HTTP Method Sample REST Request URL Sample Response Possible Error Codes
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.nudrservice.cfg/DR-SERVICE

Result Code: 200 OK

Payload

{
    "hikariPoolSize": 25,
    "defaultSlfGroupName": "DefaultGrp",
    "onDemandMigrationEnabled": true,
    "tracingEnabled": true,
    "defaultGroupIdEnabled": false,
    "subscriptionDataSubscriptionsOnly": false,
    "defaultResponse": "EQUIPMENT_UNKNOWN",
    "accessLogEnabled": false,
    "defaultResponseIMEINotFound": "EQUIPMENT_UNKNOWN"
 }
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.notifyservice.cfg/NOTIFY-SERVICE

Result Code: 200 OK

Payload

{
    "hikariPoolSize": 10,
    "retryErrorCodes": "400,429,500,503",
    "httpRetryCount": 2,
    "notifRetryCount": 3,
    "notifRetryInterval": 5
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.global.cfg/GLOBAL

Result Code: 200 OK

Payload

{
    "dbServiceName": "mysql-connectivity-service.occne-ndb",
    "udrServices": "All",
    "udsfEnabled": false,
    "ingressHttpPort": "",
    "ingressHttpsPort": "",
    "snssai": "2-FFFFFF",
    "dnn": "dnn1",
    "autoCreate": true,
    "autoEnrolOnSignalling": true,
    "etagEnabled": true,
    "sbiCorrelationInfoEnable": false,
    "consumerNF": "PCF,UDM,NEF",
    "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b03",
    "vsaDefaultBillingDay": 1,
    "subscriberActivityEnabled": false,
    "addDefaultBillingDay": true,
    "enableControlledShutdown": true,
    "suppressNotificationEnabled": true,
    "keyType": "msisdn",
    "keyRange": "000000-000000",    
    "subscriberIdentifers": {
        "msisdn": [],
        "imsi": [],
        "nai": [],
        "extid": []
    }
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.diamgateway.cfg/DIAMETER-GATEWAY

Result Code: 200 OK

Payload

{
    "realm": "oracle.com",
    "identity": "nudr.oracle.com",
    "reconnectDelay": 3,
    "responseTimeout": 4,
    "connectionTimeOut": 3,
    "watchdogInterval": 6,
    "reconnectLimit": 50,
    "onDemandMigrationEnabled": false,
    "allowedClientNodes": [{
        "port": 7867,
        "identity": "local1.tekelec1.com",
        "responseOnly": true,
        "host": "10.0.7.500",
        "realm": "tekelec1275.com",
        "type": "4GUDROndemandConnection"
    }, {
        "port": 3868,
        "identity": "sh-server",
        "host": "10.75.185.161",
        "responseOnly": true,
        "realm": "seagull",
        "type": "server"
    }]
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.biservice.cfg/BULK_IMPORT

Result Code: 200 OK

Payload

[
    {
        "importFile": "modify_slf5.csv",
        "timeQueued": "22-12-2020 10:36:06",
        "timeStarted": "22-12-2020 10:36:08",
        "timeCompleted": "22-12-2020 10:36:11",
        "progress": 100.0,
        "failedKeys": "[]",
        "passCount": 100,
        "failCount": 0,
        "totalCount": 100,
        "status": "Completed"
    },
    {
        "importFile": "modify_slf4.csv",
        "timeQueued": "22-12-2020 10:37:38",
        "timeStarted": "22-12-2020 11:13:14",
        "timeCompleted": "",
        "progress": 10.1085,
        "failedKeys": "[]",
        "passCount": 101066,
        "failCount": 0,
        "totalCount": 1000000,
        "status": "Started"
    }
]
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.ondemand.cfg/ON-DEMAND

Result Code: 200 OK

Payload

{
    "sourceUDRDeleteSubscriber": false,
    "realm": "oracle.com",
    "identity": "ondemand-migration.nudr.oracle.com",
    "enabled": false,
    "sourceUdrConfig": {
        "restEndpoint": "http://source-udr-rest-endpoint",
        "realm": "tekelec1275.com",
        "identity": "local1.tekelec1.com",
        "hostIp": "10.0.7.500",
        "hostPort": 7867
    }
}
 NA
GET http://localhost:8081/nudr-config/v1/udr.diamgateway.congestion.cfg/DGW-CONGESTION

Result Code: 200 OK

Payload

{
         "enabled": true,
         "defaultMessagePriority": 2,
         "sampleCount": 10,
         "calculationInterval": 100,
         "loadSheddingRulesMap": {
            "CONGESTED": {
               "state": "CONGESTED",
               "discardPriority": 10,
               "ansWithResultCode": "DIAMETER_TOO_BUSY",
               "resultCode": 3004,
               "vendorId": 10415
            },
            "DOC": {
               "state": "DOC",
               "discardPriority": 15,
               "ansWithResultCode": "DIAMETER_TOO_BUSY",
               "resultCode": 3004,
               "vendorId": 10415
            }
         },
         "priorityRules": [{
            "ruleName": "SH-UDR_MIGRATION",
            "messagePriority": 2,
            "conditions": {
               "requestType": "UDR_MIGRATION",
               "application": "Sh",
               "message": "UDR_MIGRATION"
            }
         }, {
            "ruleName": "SH-UDR",
            "messagePriority": 5,
            "conditions": {
               "requestType": "UDR",
               "application": "Sh",
               "message": "UDR"
            }
         }, {
            "ruleName": "SH-PUR",
            "messagePriority": 3,
            "conditions": {
               "requestType": "PUR",
               "application": "Sh",
               "message": "PUR"
            }
         }, {
            "ruleName": "SH-SNR",
            "messagePriority": 7,
            "conditions": {
               "requestType": "SNR",
               "application": "Sh",
               "message": "SNR"
            }
         }, {
            "ruleName": "SH-PNR",
            "messagePriority": 3,
            "conditions": {
               "requestType": "PNR",
               "application": "Sh",
               "message": "PNR"
            }
         }],
         "thresholds": {
            "CONGESTED": {
               "memory": 80,
               "cpu": 80,
               "queue": 50
            },
            "DOC": {
               "memory": 60,
               "cpu": 60,
               "queue": 30
            }
         }
      }
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.nudrprovservice.cfg/DR-PROV-SERVICE

Result Code: 200 OK

Payload

{
    "hikariPoolSize": 25,
    "tracingEnabled": false,
    "onDemandMigrationEnabled":true
 }
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG

Result Code: 200 OK

Payload

{
    "pollingTimeInterval": 5000,
    "lastModifiedTimeInterval": 30,
    "pdbiFilePath": "/home/udruser/pdbi",
    "resultLogFilePath": "/home/udruser/pdbi/logs",
    "pdbiFileExpiryTime":"1d",
    "remoteHost": "10.75.229.18",
    "remoteHostUsername": "cloud-user",
    "fileExt": ".pdbi",
    "remoteDirPath": "/home/cloud-user/ocudr/sftppath/",
    "periodicImportPoll": "2",
    "periodicExportPoll": "1",
    "remoteHostPort": "22",
    "deleteFileFromPVC": false,
    "sftpEnabled": true
 }
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttool.cfg/EXPORT_TOOL_CFG

Result Code: 200 OK

Payload

{
    "fixedDumpFileNamePrefix": "policydata",
    "remoteUserName": "cloud-user",
    "exportMode": "EXML_EXPORT",
    "remotePath": "/home/cloud-user/ocudr/",
    "pollingInterval": "1",
    "msisdnCount": 5,
    "pvcPath": "/home/udruser/export",
    "fieldDelimiter": ",",
    "serverPort": 22,
    "multiValuedelimiter": "|",
    "serverHost": "10.75.229.18",
    "subscriberExportRange": {
        "keyType": "msisdn",
        "subscriberRanges": [
            "33123654860-33123654864",
            "33123654865-33123654870",
            "33123654871-33123654874",
            "33123654875-3123654880",
            "33123654881-33123654885"
        ]
    },
    "subscriberRangeEnabled": false,
    "fileExtension": ".txt",
    "deleteFromPVC": true,
    "sftpExportEnabled": false,
    "startTime": "17/11/2022 07:02:04",
    "imsiCount": 5,
    "newFilePerRangeEnabled": false,
    "frequencyOfPeriodicDump": "ONE_TIME",
    "maxNumberOfDumps": 1
}
 NA
GET http://ocudr-nudr-config.myudr:5001/udr/nf-common-component/v1/operationalState

Result Code: 200 OK

Payload

{
    "operationalState": "NORMAL"
}
  • 404 Not Found: Operational State Not Found
  • 400 Bad Request
GET http://ocudr-nudr-config.myudr:5001/udr/nf-common-component/v1/operationalStateHistory

If offset is set to any value greater than 0 then it will return an empty array

Value of the limit greater than 5 displays only 5 records with query params:http://ocudr-nudr-config.myudr:5001/udr/nf-common-component/v1/operationalStateHistory?limit=3&offset=0

Result Code: 200 OK

Payload

[
    {
        "timeStamp": "2023-05-09T05:52:51.573025",
        "id": "9613dc1a-e6ce-4115-9e40-d1bee80ed8ca",
        "type": "operationalState",
        "value": "{\"state\":\"NORMAL\"}",
        "status": "SUCCESS"
    },
    {
        "timeStamp": "2023-05-09T05:52:31.259321",
        "id": "0bf4eb21-d312-424b-93a5-03da6546069f",
        "type": "operationalState",
        "value": "{\"state\":\"NORMAL\"}",
        "status": "SUCCESS"
    },
    {
        "timeStamp": "2023-05-09T05:49:28.531684",
        "id": "13c4824e-d8a4-4e98-94f7-0bf4debd4879",
        "type": "operationalState",
        "value": "{\"state\":\"COMPLETE_SHUTDOWN\"}",
        "status": "SUCCESS"
    }
]
  • 404 Not Found: Operational State Not Found
  • 400 Bad Request
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/migrationtool.status.cfg/MIGRATION_TOOL_STATUS 
[
    {
        "totalNumberOfSourceUdrSuccess": 0,
        "totalNumberOfKeyAlreadyExistsTargetUdr": 0,
        "totalNumberOfSourceUdrFailures": 2001,
        "timeCompleted": "2023-11-06T08:58:26.786402714Z",
        "progress": 100,
        "timeStarted": "2023-11-06T08:57:39.541432287Z",
        "totalNumberOfSubscribers": 2001,
        "totalNumberOfTargetUdrSuccess": 0,
        "totalNumberOfTargetUdrFailures": 0,
        "totalNumberOfSourceSubscriberNotFound": 0,
        "status": "COMPLETED"
    }
]

404 Not Found: Data field does not exist

400 Bad Request
GET http:ocudr-nudr-config.myudr:5001/nudr-config/v1/migration.tool.cfg/MIGRATION_TOOL 
{
    "migrationPauseEnabled": false,
    "keyType": "msisdn",
    "delete4g": false,
    "migrationRealm": "oracle.com",
    "migrationIdentity": "migration.oracle.com",
    "migrationNodePort": 3868,
    "migrationNodeHost": "ocudr-nudr-migration-service ",
    "migrationRanges": {
        "migrationtool-nudr-migration-tool-1": {
            "startRange": 1111101001,
            "endRange": 1111102000
        },
        "migrationtool-nudr-migration-tool-0": {
            "startRange": 1111100000,
            "endRange": 1111101000
        }
    }
}

Note: The subscriber migration ranges cannot be modified.

404 Not Found: Data field does not exist

400 Bad Request
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttoolfilestatus.cfg/EXPORT_TOOL_FILE_STATUS

Result Code: 200 OK

Payload

{
    "exportFileStatusList": [
        {
            "jobId": "export-10-11-2022T15:32:00",
            "fileName": "2022-11-10-15-32-00-026810444_SLFTestSegment.txt",
            "startTime": "10/11/2022 15:32:00",
            "completeTime": "10/11/2022 15:32:14",
            "filePath": "/home/udruser/export/2022-11-10-15-32-00-026810444_SLFTestSegment.txt",
            "status": "FILE_EXPORT_COMPLETED"
        },
        {
            "jobId": "export-09-11-2022T17:21:00",
            "fileName": "2022-11-09-17-21-00-018290194_SLFTestSegment.txt",
            "startTime": "09/11/2022 17:21:00",
            "completeTime": "09/11/2022 17:21:10",
            "filePath": "/home/udruser/export/2022-11-09-17-21-00-018290194_SLFTestSegment.txt",
            "status": "FILE_EXPORT_COMPLETED"
        },
        {
            "jobId": "export-10-11-2022T15:35:00",
            "fileName": "2022-11-10-15-35-00-019351328_SLFTestSegment.txt",
            "startTime": "10/11/2022 15:35:00",
            "completeTime": "10/11/2022 15:35:12",
            "filePath": "/home/udruser/export/2022-11-10-15-35-00-019351328_SLFTestSegment.txt",
            "status": "FILE_EXPORT_COMPLETED"
        },
        {
            "jobId": "export-10-11-2022T05:40:00",
            "fileName": "2022-11-10-05-40-00-315885098_SLFTestSegment.txt",
            "startTime": "10/11/2022 05:40:00",
            "completeTime": "10/11/2022 05:40:43",
            "filePath": "/home/udruser/export/2022-11-10-05-40-00-315885098_SLFTestSegment.txt",
            "status": "FILE_EXPORT_COMPLETED"
        }
    ]
}
  • 400 Bad Request
  • 404 Data field Doesn't exist
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS

Result Code: 200 OK

Payload

[
    {
        "jobId": "export-2023-01-16T14:12:33",
        "subscriberCount": 1,
        "exportedSubscriberCount": 1,
        "jobProgress": 100.0,
        "exportState": "1/1",
        "status": "COMPLETED"
    },
    {
        "jobId": "export-2023-01-16T14:13:53",
        "subscriberCount": 1,
        "exportedSubscriberCount": 1,
        "jobProgress": 100.0,
        "exportState": "1/1",
        "status": "COMPLETED"
    },
    {
        "jobId": "export-2023-01-16T17:32:10",
        "subscriberCount": 1,
        "exportedSubscriberCount": 1,
        "jobProgress": 100.0,
        "exportState": "1/1",
        "status": "COMPLETED"
    }
]
  • 400 Bad Request
  • 404 Data field Doesn't exist
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS/export-2023-01-16T14:12:33

Result Code: 200 OK

Payload

{
    "exportedSubscriberCount": 1,
    "jobId": "export-2023-01-16T14:12:33",
    "jobProgress": 100,
    "subscriberCount": 1,
    "exportState": "1/1",
    "exportFileStatusList": [
        {
            "jobId": "export-2023-01-16T14:12:33",
            "fileName": "2023-01-16-14-12-33-025218306_SLFTestSegment.txt",
            "filePath": "/home/udruser/export/2023-01-16-14-12-33-025218306_SLFTestSegment.txt",
            "completeTime": "16/01/2023 14:12:33",
            "startTime": "16/01/2023 14:12:33",
            "status": "FILE_EXPORT_COMPLETED"
        }
    ],
    "status": "COMPLETED"
}
  • 400 Bad Request
  • 404 Data field Doesn't exist
PUT

http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.nudrservice.cfg/DR-SERVICE

Result Code: 200 OK

Payload

{
    "hikariPoolSize": 25,
    "tracingEnabled": false,
    "subscriptionDataSubscriptionsOnly": false,
    "defaultGroupIdEnabled": false,
    "defaultSlfGroupName": "DefaultGrp",
    "onDemandMigrationEnabled": true,
    "defaultResponse": "EQUIPMENT_UNKNOWN",
    "accessLogEnabled": false,
    "defaultResponseIMEINotFound": "EQUIPMENT_UNKNOWN"
 }
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG

Result Code: 200 OK

Payload

{
    "pollingTimeInterval": 5000,
    "lastModifiedTimeInterval": 30,
    "pdbiFilePath": "/home/udruser/pdbi",
    "resultLogFilePath": "/home/udruser/pdbi/logs",
    "pdbiFileExpiryTime":"1d",
    "remoteHost": "10.75.229.18",
    "remoteHostUsername": "cloud-user",
    "fileExt": ".pdbi",
    "remoteDirPath": "/home/cloud-user/ocudr/sftppath/",
    "periodicImportPoll": "2",
    "periodicExportPoll": "1",
    "remoteHostPort": "22",
    "deleteFileFromPVC": false
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttool.cfg/EXPORT_TOOL_CFG

Result Code: 200 OK

Payload

{
    "fixedDumpFileNamePrefix": "policydata",
    "remoteUserName": "cloud-user",
    "exportMode": "EXML_EXPORT",
    "remotePath": "/home/cloud-user/ocudr/",
    "pollingInterval": "1",
    "msisdnCount": 5,
    "pvcPath": "/home/udruser/export",
    "fieldDelimiter": ",",
    "serverPort": 22,
    "multiValuedelimiter": "|",
    "serverHost": "10.75.229.18",
    "subscriberExportRange": {
        "keyType": "msisdn",
        "subscriberRanges": [
            "33123654860-33123654864",
            "33123654865-33123654870",
            "33123654871-33123654874",
            "33123654875-3123654880",
            "33123654881-33123654885"
        ]
    },
    "subscriberRangeEnabled": false,
    "fileExtension": ".txt",
    "deleteFromPVC": true,
    "sftpExportEnabled": false,
    "startTime": "17/11/2022 07:02:04",
    "imsiCount": 5,
    "newFilePerRangeEnabled": false,
    "frequencyOfPeriodicDump": "ONE_TIME",
    "maxNumberOfDumps": 1
}
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
PUT

http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.notifyservice.cfg/NOTIFY-SERVICE

Result Code: 200 OK

Payload

{
    "hikariPoolSize": 10,
    "retryErrorCodes": "400,429,500,503",
    "httpRetryCount": 2,
    "notifRetryCount": 3,
    "notifRetryInterval": 5
}
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
PUT

http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.diamgateway.cfg/DIAMETER-GATEWAY

Result Code: 200 OK

payload

{
    "realm": "oracle.com",
    "identity": "nudr.oracle.com",
    "reconnectDelay": 3,
    "responseTimeout": 4,
    "connectionTimeOut": 3,
    "watchdogInterval": 6,
    "reconnectLimit": 50,
    "onDemandMigrationEnabled": false,
    "allowedClientNodes": [{
        "port": 7867,
        "identity": "local1.tekelec1.com",
        "responseOnly": true,
        "host": "10.0.7.500",
        "realm": "tekelec1275.com",
        "type": "4GUDROndemandConnection"
    }, {
        "port": 3868,
        "identity": "sh-server",
        "host": "10.75.185.161",
        "responseOnly": true,
        "realm": "seagull",
        "type": "server"
    }]
}
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT

http://localhost:8081/nudr-config/v1/udr.diamgateway.congestion.cfg/DGW-CONGESTION

Result Code: 200 OK

payload

{
         "enabled": true,
         "defaultMessagePriority": 2,
         "sampleCount": 10,
         "calculationInterval": 100,
         "loadSheddingRulesMap": {
            "CONGESTED": {
               "state": "CONGESTED",
               "discardPriority": 10,
               "ansWithResultCode": "DIAMETER_TOO_BUSY",
               "resultCode": 3004,
               "vendorId": 10415
            },
            "DOC": {
               "state": "DOC",
               "discardPriority": 15,
               "ansWithResultCode": "DIAMETER_TOO_BUSY",
               "resultCode": 3004,
               "vendorId": 10415
            }
         },
         "priorityRules": [{
            "ruleName": "SH-UDR_MIGRATION",
            "messagePriority": 2,
            "conditions": {
               "requestType": "UDR_MIGRATION",
               "application": "Sh",
               "message": "UDR_MIGRATION"
            }
         }, {
            "ruleName": "SH-UDR",
            "messagePriority": 5,
            "conditions": {
               "requestType": "UDR",
               "application": "Sh",
               "message": "UDR"
            }
         }, {
            "ruleName": "SH-PUR",
            "messagePriority": 3,
            "conditions": {
               "requestType": "PUR",
               "application": "Sh",
               "message": "PUR"
            }
         }, {
            "ruleName": "SH-SNR",
            "messagePriority": 7,
            "conditions": {
               "requestType": "SNR",
               "application": "Sh",
               "message": "SNR"
            }
         }, {
            "ruleName": "SH-PNR",
            "messagePriority": 3,
            "conditions": {
               "requestType": "PNR",
               "application": "Sh",
               "message": "PNR"
            }
         }],
         "thresholds": {
            "CONGESTED": {
               "memory": 80,
               "cpu": 80,
               "queue": 50
            },
            "DOC": {
               "memory": 60,
               "cpu": 60,
               "queue": 30
            }
         }
      }
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT

http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.global.cfg/GLOBAL

200 OK

payload

{
    "dbServiceName": "mysql-connectivity-service.occne-ndb",
    "udrServices": "All",
    "udsfEnabled": false,
    "ingressHttpPort": "",
    "ingressHttpsPort": "",
    "snssai": "2-FFFFFF",
    "dnn": "dnn1",
    "autoCreate": true,
    "autoEnrolOnSignalling": true,
    "etagEnabled": true,
    "sbiCorrelationInfoEnable": false,
    "consumerNF": "PCF,UDM,NEF",
    "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b03",
    "vsaDefaultBillingDay": 1,
    "subscriberActivityEnabled": false,
    "addDefaultBillingDay": true,
    "enableControlledShutdown": true,
    "suppressNotificationEnabled": true,
    "keyType": "msisdn",
    "keyRange": "000000-000000",    
    "subscriberIdentifers": {
        "msisdn": [],
        "imsi": [],
        "nai": [],
        "extid": []
    }
}
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.nudrprovservice.cfg/DR-PROV-SERVICE

Result Code: 200 OK

Payload


{
    "hikariPoolSize": 25,
    "tracingEnabled": false,
    "onDemandMigrationEnabled":true
 }
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.ondemand.cfg/ON-DEMAND

Result Code: 200 OK

Payload

{
    "sourceUDRDeleteSubscriber": false,
    "realm": "oracle.com",
    "identity": "ondemand-migration.nudr.oracle.com",
    "enabled": false,
    "sourceUdrConfig": {
        "restEndpoint": "http://source-udr-rest-endpoint",
        "realm": "tekelec1275.com",
        "identity": "local1.tekelec1.com",
        "hostIp": "10.0.7.500",
        "hostPort": 7867
    }
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG

Result Code: 200 OK

Payload

{       "pollingTimeInterval" : 5000,
        "lastModifiedTimeInterval": 30 
  }
  • 400 Bad Request: Schema validation failed

  • Payload should at least one valid parameter

  • Read Only field can not be modified

  • JSONObject[\\"unknow field name\\"] not found.
  • Data field update not allowed
PUT http://ocudr-nudr-config.myudr:5001/udr/nf-common-component/v1/operationalState

Result Code: 200 OK

Payload

{    "operationalState": "NORMAL"}
  • 400 Bad Request: Controlled shutdown feature disabled
  • 500 Internal Server Error Occurred
PUT http://ocudr-nudr-config.myudr:5001/nudr-config/v1/migration.tool.cfg/MIGRATION_TOOL

Result Code: 200 OK

Payload

{
    "migrationPauseEnabled": false,
    "keyType": "msisdn",
    "migrationRanges": {
        "migrationtool-nudr-migration-tool-0": {
            "startRange": 1111100000,
            "endRange": 1111100600
        }
    }
}
  • 400 Bad Request: Controlled shutdown feature disabled
  • 500 Internal Server Error Occurred
DELETE http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS/export-2023-01-16T14:12:33

Result Code: 200 OK
  • 400 Bad Request
  • 404 Data field Doesn't exist

5.2 Configuration APIs for Common Services

This section describes the configuration APIs for common services.

Table 5-2 Common Services Configuration APIs

HTTP Method Sample Request REST URL Sample Response Possible Error Codes
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration

Payload

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"

200 OK

Response Body

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"
}
 NA
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration

200 OK

Response Body

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"
}
 NA
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/oauthvalidatorconfiguration

Payload

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"
}

200 OK

Response Body

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"
}
  
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/oauthvalidatorconfiguration

200 OK

Response Body

{
    "keyIdList": [
        {
            "keyId": "a14ef8e1bc5d",
            "certName": "rsa_certificate.crt",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "instanceIdList": [
        {
            "certName": "rsa_certificate.crt",
            "instanceId": "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c",
            "kSecretName": "oauthsecret",
            "certAlgorithm": "RS256"
        }
    ],
    "oauthValidationMode": "KID_PREFERRED"
}
  
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/serverheaderdetails

To enable:

Payload
{
    "enabled": true,
    "configuration": {
        "nfType": "UDR",
        "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b03",
        "errorCodeSeries": [
            {
                "errorSet": "4xx",
                "errorCodes": [
                    -1
                ]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [
                    -1
                ]
            }
        ]
    }
}

To disable:

Payload 
{
    "enabled": false,
    "configuration": {
        "nfType": ""
    }
}

200 OK

 NA
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/serverheaderdetails

200 OK

Response Body

{
    "enabled": false,
    "configuration": {
        "nfType": ""
    }
}
 NA
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/serverheaderdetails

Payload

{
    "enabled": true,
    "configuration": {
        "nfType": "UDR",
        "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b03",
        "errorCodeSeries": [
            {
                "errorSet": "4xx",
                "errorCodes": [
                    -1
                ]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [
                    -1
                ]
            }
        ]
    }
}
 200 OK NA
PUT http://localhost:8081/udr/nf-common-component/v1/nrf-client-nfmanagement/nfProfileList

Request

[
    {
        "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
        "load": 0,
        "nfType": "UDR",
        "udrInfo": {
            "groupId": "udr-1",
            "gpsiRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ],
            "supiRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ],
            "supportedDataSets": [
                "POLICY",
                "SUBSCRIPTION"
            ],
            "externalGroupIdentifiersRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ]
        },
        "capacity": 500,
        "locality": "bangalore",
        "nfStatus": "REGISTERED",
        "plmnList": [
            {
                "mcc": "310",
                "mnc": "14"
            }
        ],
        "priority": 10,
        "nfServices": [
            {
                "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
                "load": 0,
                "scheme": "http",
                "capacity": 500,
                "priority": 10,
                "versions": [
                    {
                        "apiFullVersion": "2.1.0.alpha-3",
                        "apiVersionInUri": "v1"
                    }
                ],
                "ipEndPoints": [
                    {
                        "port": "80",
                        "transport": "TCP",
                        "ipv4Address": "10.0.0.0"
                    }
                ],
                "serviceName": "nudr-dr",
                "allowedNfTypes": [
                    "PCF",
                    "UDM"
                ],
                "nfServiceStatus": "REGISTERED",
                "serviceInstanceId": "ae870316-384d-458a-bd45-025c9e748976"
            },
            {
                "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
                "load": 0,
                "scheme": "http",
                "capacity": 500,
                "priority": 10,
                "versions": [
                    {
                        "apiFullVersion": "2.1.0.alpha-3",
                        "apiVersionInUri": "v1"
                    }
                ],
                "ipEndPoints": [
                    {
                        "port": "80",
                        "transport": "TCP",
                        "ipv4Address": "10.0.0.0"
                    }
                ],
                "serviceName": "nudr-group-id-map",
                "allowedNfTypes": [
                    "NRF"
                ],
                "nfServiceStatus": "REGISTERED",
                "serviceInstanceId": "547d42af-628a-4d5d-a8bd-38c4ba672682"
            }
        ],
        "nfSetIdList": [
            "setxyz.udrset.5gc.mnc012.mcc345"
        ],
        "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b13",
        "allowedNfTypes": [
            "PCF",
            "UDM",
            "NRF"
        ],
        "heartBeatTimer": 90,
        "nfServicePersistence": false,
        "nfProfileChangesSupportInd": false
    }
]

200 OK

 NA
GET http://localhost:8081/udr/nf-common-component/v1/nrf-client-nfmanagement/nfProfileList 
[
    {
        "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
        "load": 0,
        "nfType": "UDR",
        "udrInfo": {
            "groupId": "udr-1",
            "gpsiRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ],
            "supiRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ],
            "supportedDataSets": [
                "POLICY",
                "SUBSCRIPTION"
            ],
            "externalGroupIdentifiersRanges": [
                {
                    "end": "20000000000",
                    "start": "10000000000"
                }
            ]
        },
        "capacity": 500,
        "locality": "bangalore",
        "nfStatus": "REGISTERED",
        "plmnList": [
            {
                "mcc": "310",
                "mnc": "14"
            }
        ],
        "priority": 10,
        "nfServices": [
            {
                "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
                "load": 0,
                "scheme": "http",
                "capacity": 500,
                "priority": 10,
                "versions": [
                    {
                        "apiFullVersion": "2.1.0.alpha-3",
                        "apiVersionInUri": "v1"
                    }
                ],
                "ipEndPoints": [
                    {
                        "port": "80",
                        "transport": "TCP",
                        "ipv4Address": "10.0.0.0"
                    }
                ],
                "serviceName": "nudr-dr",
                "allowedNfTypes": [
                    "PCF",
                    "UDM"
                ],
                "nfServiceStatus": "REGISTERED",
                "serviceInstanceId": "ae870316-384d-458a-bd45-025c9e748976"
            },
            {
                "fqdn": "ocudr-ingressgateway.myudr.svc.cluster.local",
                "load": 0,
                "scheme": "http",
                "capacity": 500,
                "priority": 10,
                "versions": [
                    {
                        "apiFullVersion": "2.1.0.alpha-3",
                        "apiVersionInUri": "v1"
                    }
                ],
                "ipEndPoints": [
                    {
                        "port": "80",
                        "transport": "TCP",
                        "ipv4Address": "10.0.0.0"
                    }
                ],
                "serviceName": "nudr-group-id-map",
                "allowedNfTypes": [
                    "NRF"
                ],
                "nfServiceStatus": "REGISTERED",
                "serviceInstanceId": "547d42af-628a-4d5d-a8bd-38c4ba672682"
            }
        ],
        "nfSetIdList": [
            "setxyz.udrset.5gc.mnc012.mcc345"
        ],
        "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b13",
        "allowedNfTypes": [
            "PCF",
            "UDM",
            "NRF"
        ],
        "heartBeatTimer": 90,
        "nfServicePersistence": false,
        "nfProfileChangesSupportInd": false
    }
]
 200 OK

5.3 Configuration APIs for Import and Export

This section describes the configuration APIs for import and export.

Table 5-3 Configuration APIs for Import and Export

HTTP Method Sample Request REST URL Sample Response Notes
POST
  • To export all services: http://<nudr-config svc IP>:<port>/nudr-config/v1/export
  • To export selective services: http://<nudr-config svc IP>:<port>/nudr-config/v1/export/?managedObjects=Access%20Token%20Validation%20Provisioning,Access%20Token%20Validation%20Signaling, Global%20Configurations,Logging%20Level,Data%20 Repository%20Service,Notify%20Service

Result Code: 201 Created

Payload

Export resource id: 3e470fab-e131-4dbe-be67-ba7391729254

This is the first step to initiate export.
GET To export all services : http://10.75.229.157:31725/nudr-config/v1/export Result Code: 200 OK
Payload
3e470fab-e131-4dbe-be67-ba7391729254
 This API is to get the existing export id.

Possible error codes

404 Not Found

500 Internal Server Error
GET

URI: http://10.75.229.157:31725/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/status

Export resource id: 3e470fab-e131-4dbe-be67-ba7391729254

Result Code: 200 OK

Payload

{
    "status": "DONE",
    "exportResourceId": "2337e6d8-f17e-46f9-9992-4ab4b0903b3d",
    "createTimeStamp": "2021-07-16T14:13:44Z",
    "percentage": "100",
    "result": "PARTIAL_SUCCESS"
}

This is the second step.

Keep calling this API until "percentage": "100".
GET

URI: http://10.75.229.157:31725/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/report

Export resource id: 3e470fab-e131-4dbe-be67-ba7391729254

Result Code: 200 OK

Payload

{
   "report":[
      {
         "name":"Access Token Validation",
         "status":"1 records exported successfully"
      },
      {
         "name":"Global Configurations",
         "status":"1 records exported successfully"
      },
      {
         "name":"Data Repository Service",
         "status":"1 records exported successfully"
      },
      {
         "name":"Notify Service",
         "status":"1 records exported successfully"
      },
      {
         "name":"NRF Client service",
         "status":"NOT_FOUND"
      },
      {
         "name":"Diameter service",
         "status":"1 records exported successfully"
      },
      {
         "name":"DR Service Logging",
         "status":"1 records exported successfully"
      },
      {
         "name":"Notify Logging",
         "status":"1 records exported successfully"
      },
      {
         "name":"Diameter Service Logging",
         "status":"1 records exported successfully"
      },
      {
         "name":"Ondemand Logging",
         "status":"NOT_FOUND"
      },
      {
         "name":"NRF Client Logging",
         "status":"NOT_FOUND"
      },
      {
         "name":"Ingressgateway Logging",
         "status":"1 records exported successfully"
      },
      {
         "name":"Egressgateway Logging",
         "status":"1 records exported successfully"
      },
      {
         "name":"Alternate Route Logging",
         "status":"1 records exported successfully"
      }
   ]
}

This is the third step.

This API gives complete export report.
GET

URI: http://10.75.229.157:31725/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/download

Export resource id: 3e470fab-e131-4dbe-be67-ba7391729254

Result Code: 200 OK

exportedFiles_ 1.12.0_20210706080247.zip

This is the fourth step.

This API is used to download exported zip file.
POST URL: http://10.75.229.157:31725/nudr-config/v1/import

Result Code: 201 Created

Payload

Import resource id: 552a4328-21ec-43aa-a460-58ce1df407ae

 This is the first step to initiate import.
GET URL : http://10.75.229.157:31725/nudr-config/v1/import Result Code: 200 OK
Payload
552a4328-21ec-43aa-a460-58ce1df407ae
 This API is to get the existing import id.

404 Not Found

500 Internal Server Error
GET

URL: http://10.75.229.157:31725/nudr-config/v1/import/552a4328-21ec-43aa-a460-58ce1df407ae/status

Import resource id: 552a4328-21ec-43aa-a460-58ce1df407ae

Result Code: 200 OK

Payload

{
    "status": "DONE",
    "importResourceId": "c0ec965a-5d9f-4799-b47f-768a23561ae2",
    "createTimeStamp": "2021-07-16T09:06:17Z",
    "percentage": "100",
    "progress": "12 / 12 MO(s) completed",
    "result": "PARTIAL_SUCCESS"
}

This is the second step.

Keep calling this API until "percentage": "100"
GET URL: http://10.75.229.157:31725/nudr-config/v1/import/552a4328-21ec-43aa-a460-58ce1df407ae/report

Import resource id: 552a4328-21ec-43aa-a460-58ce1df407ae

Result Code: 200 OK

Payload

{
   "report":[
      {
         "name":"Alternate Route Logging",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Diameter service",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Notify Logging",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Egressgateway Logging",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Notify Service",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Ingressgateway Logging",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Data Repository Service",
         "status":"INTERNAL_SERVER_ERROR"
      },
      {
         "name":"Global Configurations",
         "status":"METHOD_NOT_ALLOWED"
      },
      {
         "name":"Access Token Validation",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"Diameter Service Logging",
         "status":"1 / 1 records imported successfully."
      },
      {
         "name":"DR Service Logging",
         "status":"1 / 1 records imported successfully."
      }
   ]
}

This is the third step.

This API gives complete import report.

For more information about the Import and Export configurable parameters, see Oracle Communications Cloud Native Core Unified Data Repository Installation and Upgrade Guide.

5.4 Configuration APIs for Loglevel

This section describes the configuration APIs for loglevel.

Table 5-4 Configuration APIs for Loglevel

HTTP Method Sample Request REST URL Sample Response Notes
GET URI: http://10.75.229.168:32310/nudr-config/v1/nudr-drservice/logging

Result Code: 200 OK

Payload


{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-notify-service/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-diameterproxy/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/diam-gateway/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-ondemand-migration/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32527/udr/nf-common-component/v1/igw-sig/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
 NA
GET http://10.75.229.168:32527/udr/nf-common-component/v1/igw-prov/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
 NA
GET http://10.75.229.168:32527/udr/nf-common-component/v1/egw/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
 NA
GET http://10.75.229.168:32527/udr/nf-common-component/v1/alt-route/logging

Result Code: 200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
 NA
GET

http://10.75.229.168:32527/udr/nf-common-component/v1/nrf-client-nfmanagement/logging

200 OK

Response
{
  "appLogLevel": "INFO",
  "packageLogLevel": [
  {
    "logLevelForPackage": "INFO",
    "packageName": "root"
   }]
}
  • 404 NOT Found
  • 400 BAD REQUEST
GET http://10.75.229.168:31867/nudr-config/v1/all/logging

Result Code: 200 OK

Payload

[
    {
        "egress-gateway": "{\"appLogLevel\":\"INFO\",\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"oauth\",\"logLevelForPackage\":\"INFO\"}]}",
        "nudr-diameterproxy": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "diam-gateway": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "alternate-route": "{\"appLogLevel\":\"WARN\",\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}]}",
        "nudr-drservice": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "nudr-ondemand-migration": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "nudr-notify-service": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "ingress-gateway": "{\"appLogLevel\":\"INFO\",\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"oauth\",\"logLevelForPackage\":\"INFO\"}]}",
        "perf-info": "{\"appLogLevel\":\"WARN\"}",
        "app-info": "{\"appLogLevel\":\"WARN\"}",
        "nudr-dr-provservice": "{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"appLogLevel\":\"DEBUG\"}",
        "nrf-client-nfmanagement": "{\"appLogLevel\":\"INFO\",\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}]}"
    }
]
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-dr-provservice/logging Result Code: 200 OK
{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-bulk-import/logging Result Code: 200 OK
{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [{
        "packageName": "springframework",
        "logLevelForPackage": "WARN"
    }, {
        "packageName": "root",
        "logLevelForPackage": "WARN"
    }]
}
 NA
GET http://10.75.229.168:32310/nudr-config/v1/nudr-export-tool/logging

200 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
 NA
GET http://10.75.180.253:30601/nudr-config/v1/nudr-config/logging

200 Created

Payload

{
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        }
    ],
    "appLogLevel": "WARN"
}
 NA
PUT

URI: http://10.75.229.168:32310/nudr-config/v1/nudr-drservice/logging

201 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 400 Bad Request: Schema validation failed
PUT

http://10.75.229.168:32310/nudr-config/v1/nudr-notify-service/logging

201 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 400 Bad Request: Schema validation failed
PUT http://10.75.229.168:32310/nudr-config/v1/nudr-diameterproxy/logging

201 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 400 Bad Request: Schema validation failed
PUT

http://10.75.229.168:32310/nudr-config/v1/diam-gateway/logging

201 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 400 Bad Request: Schema validation failed
PUT

http://10.75.229.168:32310/nudr-config/v1/nudr-ondemand-migration/logging

201 Created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 400 Bad Request: Schema validation failed
PUT

http://10.75.229.168:32527/udr/nf-common-component/v1/igw-sig/logging

200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
  • 404 Not Found
PUT http://10.75.229.168:32527/udr/nf-common-component/v1/igw-prov/logging

200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
  • 404 Not Found
PUT

http://10.75.229.168:32527/udr/nf-common-component/v1/egw/logging

200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        },
        {
            "packageName": "oauth",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
  • 404 Not Found
PUT

http://10.75.229.168:32527/udr/nf-common-component/v1/alt-route/logging

200 OK

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
  • 404 Not Found
PUT

http://10.75.229.168:32527/udr/nf-common-component/v1/nrf-client-nfmanagement/logging

200 OK

Response
{
  "appLogLevel": "INFO",
  "packageLogLevel": [
  {
    "logLevelForPackage": "INFO",
    "packageName": "root"
   }]
}
  • 404 NOT FOUND
  • 400 BAD REQUEST
PUT http://10.75.229.168:32310/nudr-config/v1/nudr-dr-provservice/logging

201 created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 404 NOT FOUND
  • 400 BAD REQUEST
PUT http://10.75.229.168:32310/nudr-config/v1/nudr-bulk-import/logging

201 created

Payload

{
    "appLogLevel": "WARN",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "WARN"
        }
    ]
}
  • 404 NOT FOUND
  • 400 BAD REQUEST
PUT http://10.75.229.168:32310/nudr-config/v1/nudr-export-tool/logging

201 created

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [{
        "packageName": "springframework",
        "logLevelForPackage": "WARN"
    }, {
        "packageName": "root",
        "logLevelForPackage": "WARN"
    }]
}
  • 404 NOT FOUND
  • 400 BAD REQUEST
PUT http://10.75.180.253:30601/nudr-config/v1/nudr-config/logging

201 created

Payload

{
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
        {
            "packageName": "jetty",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "springframework",
            "logLevelForPackage": "WARN"
        },
        {
            "packageName": "root",
            "logLevelForPackage": "DEBUG"
        }
    ]
}
  • 404 NOT FOUND
  • 400 BAD REQUEST

5.5 Configuration APIs for Overload Handling

This section describes the configuration APIs on Ingress Gateway and perf-info microservices for overload handling.

Table 5-5 Configuration APIs on Ingress Gateway for Overload Handling

HTTP Method Sample Request REST URL Sample Response
PUT

igw-sig URL: /udr/nf-common-component/v1/igw-sig/ocpolicymapping

oc policy mapping
{
"enabled":true,
"mappings": [
{
"svcName": "ocudr-nudr-drservice",
"policyName":"OCDP1"
}
],
"samplingPeriod":6000
}

igw-prov URL: /udr/nf-common-component/v1/igw-prov/ocpolicymapping

oc policy mapping
{
"enabled":true,
"mappings": [
{
"svcName": "ocudr-nudr-drprovservice",
"policyName":"OCDP1"
}
],
"samplingPeriod":6000
}

Response is same as Request payload.
PUT

igw-sig URL: /udr/nf-common-component/v1/igw-sig/ocdiscardpolicies

igw-prov URL: /udr/nf-common-component/v1/igw-prov/ocdiscardpolicies

For payload, see PUT - OC Discard Policy.

Response is same as Request payload.
PUT

igw-sig URL: /udr/nf-common-component/v1/igw-sig/errorcodeprofiles

igw-prov URL: /udr/nf-common-component/v1/igw-prov/errorcodeprofiles

For payload, see PUT - Error Code Profiles.

Response is same as Request payload.
PUT

igw-sig URL: /udr/nf-common-component/v1/igw-sig/routesconfiguration

igw-prov URL: /udr/nf-common-component/v1/igw-prov/routesconfiguration

For payload, see PUT - Routes Configuration.

Response is same as Request payload.
PUT

igw-sig URL: /udr/nf-common-component/v1/igw-sig/errorcodeserieslist

igw-prov URL: /udr/nf-common-component/v1/igw-prov/errorcodeserieslist

error code series

[
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
        ],
        "errorCodeSeries": [
            {
                "errorSet": "5xx",
                "errorCodes": [
                    503
                ]
            }
        ]
    }
]

Response is same as Request payload.

Table 5-6 Configuration APIs on perf-info for Overload Handling

HTTP Method Sample Request REST URL Sample Response
PUT

URL: /udr/nf-common-component/v1/perf-info/overloadLevelThreshold

For payload, see PUT - Overload Threshold Configuration

Response is same as Request payload.

For more information about the Overload Handling configurable parameters, see Oracle Communications Cloud Native Core Unified Data Repository Installation and Upgrade Guide.

5.6 Configuration APIs for Rate Limit

This section describes the configuration APIs on Ingress Gateway for rate limiting feature.

Table 5-7 Configuration APIs on Ingress Gateway for Rate Limiting

HTTP Method Sample Request REST URL Sample Response Notes
PUT

URL: http://10.75.229.75:31187/udr/nf-common-component/v1/igw/routesconfiguration

routesconfiguration

[
  {
    "id": "traffic_mapping_http",
      "rateLimiting": {
       "methods": [
      {
        "name": "PATCH",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "GET",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 300,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "POST",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "PATCH",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "GET",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 300,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "POST",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_group",
      "rateLimiting": {
      "methods": [
      {
        "name": "GET",
        "rate": 1500,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_group_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "GET",
        "rate": 800,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_slf_group_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "GET",
        "rate": 800,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  }
]

routesconfiguration

[
  {
    "id": "traffic_mapping_http",
      "rateLimiting": {
       "methods": [
      {
        "name": "PATCH",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "GET",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 300,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "POST",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "PATCH",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "GET",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 300,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "POST",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_group",
      "rateLimiting": {
      "methods": [
      {
        "name": "GET",
        "rate": 1500,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_group_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "GET",
        "rate": 800,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  },
  {
    "id": "traffic_mapping_http_slf_group_prov",
      "rateLimiting": {
       "methods": [
      {
        "name": "GET",
        "rate": 800,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "PUT",
        "rate": 200,
        "rateLimitPolicy": "R1"
      },
      {
        "name": "DELETE",
        "rate": 200,
        "rateLimitPolicy": "R1"
      }]
    },
     "failureReqCountErrorCodeSeriesId": "P1"
  }
]
 Response is same as request
PUT

URL: http://10.75.229.75:31187/udr/nf-common-component/v1/igw/routelevelratelimiting

routelevelratelimiting
{
   "enabled": true,
   "samplingPeriod": 1000,
   "rateLimitPolicies": [
   {
     "name": "R1",
     "value": 24,
     "action": "RejectWithErrorCode",
     "scheme": "PriorityBased",
     "errorCodeProfile": "error429"
   }]
}

routelevelratelimiting

{
   "enabled": true,
   "samplingPeriod": 1000,
   "rateLimitPolicies": [
   {
     "name": "R1",
     "value": 24,
     "action": "RejectWithErrorCode",
     "scheme": "PriorityBased",
     "errorCodeProfile": "error429"
   }]
}
 Response is same as request
PUT

URL: http://10.75.229.75:31187/udr/nf-common-component/v1/igw/errorcodeprofiles

errorcodeprofiles

[
    {
        "name": "error429",
        "errorCode": 429,
        "errorCause": "Too many reequests",
        "errorTitle": "Too many reequests",
        "redirectURL": "",
        "retry-after": "",
        "errorDescription": "Too many reequests"
    }
]

errorcodeprofiles

[
    {
        "name": "error429",
        "errorCode": 429,
        "errorCause": "Too many reequests",
        "errorTitle": "Too many reequests",
        "redirectURL": "",
        "retry-after": "",
        "errorDescription": "Too many reequests"
    }
]
 Response is same as request

5.6.1 Default Configuration Details for Rate Limit

The default configuration details for rate limit are:

Important:

The default deployment setup includes two Ingress Gateways and two DR pods. The following default rates are derived based on this deployment setup. If you want to scale up the pods, then adjust or configure the route rates accordingly. The route rates are available under routesconfiguration of http://10.75.229.75:31187/udr/nf-common-component/v1/igw/routesconfiguration.
  • RouteId-Path - traffic_mapping_http - nudr-dr

    Table 5-8 Method wise Rate Details

    Method Rate
    GET 200
    PUT 300
    POST 200
    PATCH 200
    DELETE 200
  • RouteId-Path - traffic_mapping_http_prov - nudr-dr-prov

    Table 5-9 Method wise Rate Details

    Method Rate
    GET 200
    PUT 300
    POST 200
    PATCH 200
    DELETE 200
  • RouteId-Path - traffic_mapping_http_group - nudr-group-id-map

    Table 5-10 Method wise Rate Details

    Method Rate
    GET 1350
  • RouteId-Path - traffic_mapping_http_group_prov - nudr-group-id-map-prov

    Table 5-11 Method wise Rate Details

    Method Rate
    GET 800
    PUT 200
    DELETE 200
  • RouteId-Path - traffic_mapping_http_slf_group_prov - slf-group-prov

    Table 5-12 Method wise Rate Details

    Method Rate
    GET 800
    PUT 200
    DELETE 200

5.7 List of Errors and their Details

The list of errors and their details are as follows:

Table 5-13 Error Details

Error Codes Error Text Error Detail
400 Bad request

Schema Validation Failure

Invalid URI

Key Not Supported

Invalid JSON Format

JSONObject[\\"unknow field name\\"] not found.

/nudr-config/v1/export:
  • "No MO name passed OR Passed MO name is not correct"
  • "No MO name passed for Export."
/nudr-config/v1/import:
  • Only zip file format is supported. Upload a zip file to perform the bulk import.
  • Passed MO name is not correct
  • Unable to extract contents of file... skipping
  • Error reading zip stream
404 Not Found

Configuration does not exist

Destination Not Found

Key Not Found

Data field does not exist

/nudr-config/v1/export/<id>/status:
  • Export request id not found
/nudr-config/v1/export/<id>/report:
  • Export report with the provided ID does not exist
  • Export report with the provided ID not found
/nudr-config/v1/export/<id>/download:
  • Exported Files with the provided ID does not exist
/nudr-config/v1/import/<id>/status:
  • Import request id not found
/nudr-config/v1/import/<id>/report
  • Import report with the provided ID does not exists
  • Import report with the provided ID not found
405 Operation Not Allowed Method Not Allowed
429 Too Many Requests
/nudr-config/v1/import:
  • Another import or export request is in progress. Please wait for previous requests to complete before performing bulk import operation
500 Internal Server Error Internal error
/nudr-config/v1/export/<id>/report:
  • Export is in progress. Please try after some time
  • Could not create export report
/nudr-config/v1/export/<id>/download:
  • Report not yet ready. Please try again after some time
  • Could not create exported json files
/nudr-config/v1/import/<id>/report:
  • Import is in progress. Please try after some time
  • Could not create import report
503 Service Unavailable Service unavailable