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

{
    "defaultSlfGroupName": "DefaultGrp",
    "onDemandMigrationEnabled": true,
    "defaultGroupIdEnabled": false,
    "subscriptionDataSubscriptionsOnly": false,
    "allowSubscriptionRecreation":true
 }
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.notifyservice.cfg/NOTIFY-SERVICE

Result Code: 200 OK

Payload

{
    "resourceRemovalNotificationEnabled": true,
    "retryErrorCodes": "400,429,500,503",
    "notifRetryCount": 3,
    "NotifRetryInterval": 5
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.global.cfg/GLOBAL

Result Code: 200 OK

Payload

{
    "snssai": "2-FFFFFF",
    "dnn": "dnn1",
    "sbiCorrelationInfoEnable": false,
    "autoCreate": true,
    "autoEnrolOnSignalling": true,
    "etagEnabled": true,
    "version": "v3",
    "consumerNF": "PCF,UDM,NEF",
    "vsaDefaultBillingDay": 1,
    "subscriberActivityEnabled": false,
    "addDefaultBillingDay": true,
    "enableControlledShutdown": false,
    "keyType": "msisdn",
    "keyRange": "000000-000000",
    "dbConflictResolutionEnabled": false,
    "maxNumberOfSubscriptions": 30,
    "suppressNotificationEnabled": true,
    "configClientConnectTimeout": 1000,
    "configClientReadTimeout": 1000,
    "s13InterfaceEnabled": false,
    "defaultResponse": "EQUIPMENT_UNKNOWN",
    "accessLogEnabled": true,
    "defaultResponseIMEINotFound": "EQUIPMENT_UNKNOWN",
    "imsiLookupFallbackEnabled": false,
    "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

{
    "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,
    "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

{
    "onDemandMigrationEnabled": false,
    "provLogsEnabled": true,
    "provLogsApiNames": [
        "nudr-dr-prov"
    ]
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG

Result Code: 200 OK

Payload

{
    "pdbiFileExpiryTime": "8d",
    "remoteDirPath": "/home/cloud-user/ocudr/",
    "fileExt": ".pdbi",
    "deleteFileFromPVC": true,
    "transferOutPath": "/home/cloud-user/transferOut/"
}
 NA
GET http://ocudr-nudr-config.myudr:5001/nudr-config/v1/udr.exporttool.cfg/EXPORT_TOOL_CFG

Result Code: 200 OK

Payload

{
    "remotePath": "/home/cloud-user/ocudr/",
    "fixedDumpFileNameSuffix": "SLFTestSegment1",
    "msisdnCount": 6,
    "pvcPath": "/home/udruser/export1",
    "fieldDelimiter": ",",
    "multiValuedelimiter": "|",
    "subscriberExportRange": {
        "keyType": "msisdn",
        "subscriberRanges": [
            "1111111130-1111111140",
            "1111111150-1111111160"
        ]
    },
    "subscriberRangeEnabled": false,
    "fileExtension": ".txt",
    "deleteFromPVC": true,
    "startTime": "14/09/2022 17:32:10",
    "imsiCount": 5,
    "newFilePerRangeEnabled": false,
    "frequencyOfPeriodicDump": "DAILY",
    "maxNumberOfDumps": 5
}
 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",
    "migrationRanges": {
        "migrationtool-nudr-migration-tool-0": {
            "startRange": 1111100000,
            "endRange": 1111100600
        }
    }
}

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

{
    "subscriptionDataSubscriptionsOnly": false,
    "defaultGroupIdEnabled": false,
    "defaultSlfGroupName": "DefaultGrp",
    "onDemandMigrationEnabled": true,
    "allowSubscriptionRecreation":true
 }
  • 400 Bad Request: Schema validation failed

  • Payload should have at least one valid parameter

  • Read Only field cannot be modified

  • JSONObject[\\"unknown 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

{
    "pdbiFileExpiryTime": "8d",
    "remoteDirPath": "/home/cloud-user/ocudr/",
    "fileExt": ".pdbi",
    "deleteFileFromPVC": true,
    "transferOutPath": "/home/cloud-user/transferOut/"
}
  • 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

{
    "remotePath": "/home/cloud-user/ocudr/",
    "fixedDumpFileNameSuffix": "SLFTestSegment",
    "msisdnCount": 5,
    "pvcPath": "/home/udruser/export",
    "fieldDelimiter": ",",
    "multiValuedelimiter": "|",
    "subscriberExportRange": {
        "keyType": "msisdn",
        "subscriberRanges": [
            "1111111130-1111111140",
            "1111111150-1111111160"
        ]
    },
    "subscriberRangeEnabled": false,
    "fileExtension": ".txt",
    "deleteFromPVC": true,
    "startTime": "14/09/2022 17:32:10",
    "imsiCount": 5,
    "newFilePerRangeEnabled": false,
    "frequencyOfPeriodicDump": "DAILY",
    "maxNumberOfDumps": 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.notifyservice.cfg/NOTIFY-SERVICE

Result Code: 200 OK

Payload

{
    "resourceRemovalNotificationEnabled": true,
    "retryErrorCodes": "400,429,500,503",
    "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

{
    "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

{
    "snssai": "2-FFFFFF",
    "dnn": "dnn1",
    "sbiCorrelationInfoEnable": false,
    "autoCreate": true,
    "autoEnrolOnSignalling": true,
    "etagEnabled": true,
    "version": "v3",
    "consumerNF": "PCF,UDM,NEF",
    "vsaDefaultBillingDay": 1,
    "subscriberActivityEnabled": false,
    "addDefaultBillingDay": true,
    "enableControlledShutdown": false,
    "keyType": "msisdn",
    "keyRange": "000000-000000",
    "dbConflictResolutionEnabled": false,
    "maxNumberOfSubscriptions": 30,
    "suppressNotificationEnabled": true,
    "configClientConnectTimeout": 1000,
    "configClientReadTimeout": 1000,
    "s13InterfaceEnabled": false,
    "defaultResponse": "EQUIPMENT_UNKNOWN",
    "accessLogEnabled": true,
    "defaultResponseIMEINotFound": "EQUIPMENT_UNKNOWN",
    "imsiLookupFallbackEnabled": false,
    "subscriberIdentifers": {
        "msisdn": [],
        "imsi": [],
        "nai": [],
        "extid": []
    }
}

Note: Do not change the default value of configClientConnectTimeout and configClientReadTimeout parameters unless required.

  • 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

{
    "onDemandMigrationEnabled": false,
    "provLogsEnabled": true,
    "provLogsApiNames": [
        "nudr-dr-prov"
    ]
}
  • 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,
    "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

{
    "pdbiFileExpiryTime": "8d",
    "remoteDirPath": "/home/cloud-user/ocudr1/",
    "fileExt": ".pdbi",
    "deleteFileFromPVC": true,
    "transferOutPath": "/home/cloud-user/transferOut1/"
}
  • 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
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"
}
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"
}
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
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/serverheaderdetails

200 OK

Response Body

{
    "enabled": false,
    "configuration": {
        "nfType": ""
    }
}
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
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/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
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/serverheaderdetails

200 OK

{
    "enabled": false,
    "configuration": {
        "nfType": ""
    }
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/serverheaderdetails
{
    "enabled": true,
    "configuration": {
        "nfType": "UDR",
        "nfInstanceId": "5a7bd676-ceeb-44bb-95e0-f6a55a328b03",
        "errorCodeSeries": [
            {
                "errorSet": "4xx",
                "errorCodes": [
                    -1
                ]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [
                    -1
                ]
            }
        ]
    }
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/useragentheadervalidation

To enable:

Payload
{
    "enabled": true,
    "validationType": "strict",
    "consumerNfTypes": [
        "PCF",
        "NRF",
        "UDM"
    ]
}

To disable:

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

200 OK

{
    "enabled": false,
    "validationType": "strict"
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/useragentheadervalidation
{
    "enabled": true,
    "validationType": "strict",
    "consumerNfTypes": [
        "PCF",
        "NRF",
        "UDM"
    ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/useragentheadervalidation

To enable:

Payload
{
    "enabled": true,
    "validationType": "strict",
    "consumerNfTypes": [
        "PCF",
        "NRF",
        "UDM"
    ]
}

To disable:

Payload 
{
    "enabled": false,
    "validationType": "strict"
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/useragentheadervalidation

200 OK

{
    "enabled": false,
    "validationType": "strict"
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/useragentheadervalidation
{
    "enabled": true,
    "validationType": "strict",
    "consumerNfTypes": [
        "PCF",
        "NRF",
        "UDM"
    ]
}
 200 OK
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
GET http://localhost:8081/udr/nf-common-component/v1/nrf-client-nfmanagement/nfProfileList

200 OK

[
    {
        "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
    }
]
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/podprotection or http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/podprotection
{
    "enabled": true,
    "congestionControl": {
        "states": [
            {
                "name": "Normal",
                "weight": 0,
                "entryAction": [
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "incrementBy": 30,
                            "maxConcurrentStreamsPerCon": 100,
                            "incrementByActionSamplingPeriod": 3
                        }
                    },
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": true
                        }
                    }
                ]
            },
            {
                "name": "DoC",
                "weight": 1,
                "entryAction": [
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": false
                        }
                    },
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "decrementBy": 30,
                            "incrementBy": 30,
                            "maxConcurrentStreamsPerCon": 50,
                            "decrementByActionSamplingPeriod": 1,
                            "incrementByActionSamplingPeriod": 3
                        }
                    }
                ],
                "resourceThreshold": {
                    "cpu": 60,
                    "pendingMessage": 5000
                }
            },
            {
                "name": "Congested",
                "weight": 2,
                "entryAction": [
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": false
                        }
                    },
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "decrementBy": 30,
                            "maxConcurrentStreamsPerCon": 10,
                            "decrementByActionSamplingPeriod": 1
                        }
                    }
                ],
                "resourceThreshold": {
                    "cpu": 75,
                    "pendingMessage": 7000
                }
            }
        ],
        "enabled": true,
        "actionSamplingPeriod": 3,
        "stateChangeSampleCount": 10
    },
    "monitoringInterval": 100
}

Note: You can use the URI for both signaling and provisioning by changing the igw in the URI address to igw-sig or igw-prov respectively.

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/podprotection or http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/podprotection

Note: You can use the URI for both signaling and provisioning by changing the igw in the URI address to igw-sig or igw-prov respectively.

200 OK

{
    "enabled": true,
    "congestionControl": {
        "states": [
            {
                "name": "Normal",
                "weight": 0,
                "entryAction": [
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "incrementBy": 30,
                            "maxConcurrentStreamsPerCon": 100,
                            "incrementByActionSamplingPeriod": 3
                        }
                    },
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": true
                        }
                    }
                ]
            },
            {
                "name": "DoC",
                "weight": 1,
                "entryAction": [
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": false
                        }
                    },
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "decrementBy": 30,
                            "incrementBy": 30,
                            "maxConcurrentStreamsPerCon": 50,
                            "decrementByActionSamplingPeriod": 1,
                            "incrementByActionSamplingPeriod": 3
                        }
                    }
                ],
                "resourceThreshold": {
                    "cpu": 60,
                    "pendingMessage": 5000
                }
            },
            {
                "name": "Congested",
                "weight": 2,
                "entryAction": [
                    {
                        "action": "AcceptIncomingConnections",
                        "arguments": {
                            "accept": false
                        }
                    },
                    {
                        "action": "MaxConcurrentStreamsUpdate",
                        "arguments": {
                            "decrementBy": 30,
                            "maxConcurrentStreamsPerCon": 10,
                            "decrementByActionSamplingPeriod": 1
                        }
                    }
                ],
                "resourceThreshold": {
                    "cpu": 75,
                    "pendingMessage": 7000
                }
            }
        ],
        "enabled": true,
        "actionSamplingPeriod": 3,
        "stateChangeSampleCount": 10
    },
    "monitoringInterval": 100
}

5.2.1 Ingress Gateway Signaling APIs

This section describes the configuration APIs for Ingress Gateway Signaling.

Table 5-3 Common Services Configuration APIs

HTTP Method Sample Request REST URL Sample Response
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK

Response Body

{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocpolicymapping
{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}

200 OK

Response Body

{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocpolicymapping
{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocpolicymapping

Payload

{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}

200 OK

Response Body
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-sig/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK

5.2.2 Ingress Gateway Provisioning APIs

This section describes the configuration APIs for Ingress Gateway Provisioning.

Table 5-4 Common Services Configuration APIs

HTTP Method Sample Request REST URL Sample Response
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK

Response Body

{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocpolicymapping

200 OK

Response Body

{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocpolicymapping
{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocpolicymapping
{
   "enabled": true,
   "mappings": [
   {
     "svcName": "sm.pcf.com",
     "policyName": "OCDP1"
   },
   {
     "svcName": "cm.pcf.com",
     "policyName": "OCDP2"
   },
   {
     "svcName": "localhost",
     "policyName": "OCDP3"
   }],
   "samplingPeriod": 200
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeprofiles
[
 {
   "name": "error300",
   "errorCode": 300,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 },
 {
   "name": "error500",
   "errorCode": 500,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/errorcodeserieslist
[ 
    {
        "id": "P1",
        "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            },
            {
                "errorSet": "5xx",
                "errorCodes": [500, 503]
            }
        ]
    },
    {
        "id": "P2",
         "exceptionList": [
            "RequestTimeout",
            "ConnectionTimeout",
            "UnknownHostException",
            "NotFoundException"
  
        ],
        "errorCodeSeries":
        [
            {
                "errorSet": "4xx",
                "errorCodes": [400, 408]
            }
        ]
    }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/messagelogging
{
    "enabled": true,
    "responseCodeSeries": [
        {
            "responseSet": "2xx",
            "responseCodes": [
                201,
                202
            ]
        }
    ],
    "whiteListedHeaders": [
        "ocLogId",
        "content-type",
        "customheader",
        "server"
    ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/oauthvalidatorconfiguration
{
    "keyIdList": [
        {
            "keyId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret1",
            "certName": "samplecert1.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "instanceIdList": [
        {
            "instanceId": "664b344e74294c8fa5d2e7dfaaaba407",
            "kSecretName": "samplesecret2",
            "certName": "samplecert2.crt",
            "certAlgorithm": "ES256"
        }
    ],
    "oauthValidationMode": "INSTANCEID_ONLY"
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/ocdiscardpolicies
[
 {
   "name": "OCDP3",
   "scheme": "PercentageBased",
   "policies": [
   {
     "value": 10,
     "action": "RejectWithErrorCode",
     "level": "Major",
     "errorCodeProfile": "error300"
   }]
 },
 {
   "name": "OCDP1",
   "scheme": "PriorityBased",
   "policies": [
   {
     "value": 30,
     "action": "RejectWithErrorCode",
     "level": "Minor",
     "errorCodeProfile": "error300"
   },
   {
     "value": 20,
     "action": "RejectWithErrorCode",
     "level": "Critical",
     "errorCodeProfile": "error500"
   }]
 }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/igw-prov/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_group",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    },
    {
        "id": "traffic_mapping_http_eir",
        "rateLimiting": {
            "methods": [
                {
                    "name": "GET",
                    "rate": 1500,
                    "rateLimitPolicy": "R1"
                }
            ]
        },
        "failureReqCountErrorCodeSeriesId": "P1"
    }
]

200 OK

5.2.3 Egress Gateway APIs

This section describes the configuration APIs for Egress Gateway.

Table 5-5 Common Services Configuration APIs

HTTP Method Sample Request REST URL Sample Response
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
 
}

200 OK

Response Body

{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
 
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
 
}

200 OK

Response Body

{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
 
}
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/configurableerrorcodes
{
    "enabled": false,
 
    "errorScenarios": [{
            "exceptionType": "GLOBAL_RATELIMIT",
            "errorProfileName": "ERR_100"
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_200"
 
        },
        {
            "exceptionType": "REQUEST_TIMEOUT",
            "errorProfileName": "ERR_500"
 
        }
 
    ]
}
 
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/errorcodeprofiles
[
  
 {
   "name": "error100",
   "errorCode": 100,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK

Response Body

[
  
 {
   "name": "error100",
   "errorCode": 100,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/errorcodeprofiles
[
  
 {
   "name": "error100",
   "errorCode": 100,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }

200 OK

Response Body

[
  
 {
   "name": "error100",
   "errorCode": 100,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/errorcodeprofiles
[
  
 {
   "name": "error100",
   "errorCode": 100,
   "errorCause": "",
   "errorTitle": "",
   "redirectURL": "",
   "retry-after": "",
   "errorDescription": ""
 }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/messagelogging
{
  "enabled": true,
  "responseCodeSeries": [
  {
    "responseSet": "2xx",
    "responseCodes": [200,201]
  },
  {
    "responseSet": "1xx",
    "responseCodes": [103]
  },
  {
    "responseSet": "3xx",
    "responseCodes": [300]
  },
  {
    "responseSet": "4xx",
    "responseCodes": [404]
  },
  {
    "responseSet": "5xx",
    "responseCodes": [500]
  }],
  "whiteListedHeaders": [
    "ocLogId","content-type","customheader","server"
  ]
}

200 OK

Response Body

{
  "enabled": true,
  "responseCodeSeries": [
  {
    "responseSet": "2xx",
    "responseCodes": [200,201]
  },
  {
    "responseSet": "1xx",
    "responseCodes": [103]
  },
  {
    "responseSet": "3xx",
    "responseCodes": [300]
  },
  {
    "responseSet": "4xx",
    "responseCodes": [404]
  },
  {
    "responseSet": "5xx",
    "responseCodes": [500]
  }],
  "whiteListedHeaders": [
    "ocLogId","content-type","customheader","server"
  ]
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/messagelogging
{
  "enabled": true,
  "responseCodeSeries": [
  {
    "responseSet": "2xx",
    "responseCodes": [200,201]
  },
  {
    "responseSet": "1xx",
    "responseCodes": [103]
  },
  {
    "responseSet": "3xx",
    "responseCodes": [300]
  },
  {
    "responseSet": "4xx",
    "responseCodes": [404]
  },
  {
    "responseSet": "5xx",
    "responseCodes": [500]
  }],
  "whiteListedHeaders": [
    "ocLogId","content-type","customheader","server"
  ]
}

200 OK

Response Body

{
  "enabled": true,
  "responseCodeSeries": [
  {
    "responseSet": "2xx",
    "responseCodes": [200,201]
  },
  {
    "responseSet": "1xx",
    "responseCodes": [103]
  },
  {
    "responseSet": "3xx",
    "responseCodes": [300]
  },
  {
    "responseSet": "4xx",
    "responseCodes": [404]
  },
  {
    "responseSet": "5xx",
    "responseCodes": [500]
  }],
  "whiteListedHeaders": [
    "ocLogId","content-type","customheader","server"
  ]
}
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/messagelogging
{
  "enabled": true,
  "responseCodeSeries": [
  {
    "responseSet": "2xx",
    "responseCodes": [200,201]
  },
  {
    "responseSet": "1xx",
    "responseCodes": [103]
  },
  {
    "responseSet": "3xx",
    "responseCodes": [300]
  },
  {
    "responseSet": "4xx",
    "responseCodes": [404]
  },
  {
    "responseSet": "5xx",
    "responseCodes": [500]
  }],
  "whiteListedHeaders": [
    "ocLogId","content-type","customheader","server"
  ]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/forwardheaderdetails
{
 "enabled": true,
 "forwardHeaderValue": "10.75.225.67" 
}

200 OK

Response Body

{
 "enabled": true,
 "forwardHeaderValue": "10.75.225.67" 
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/forwardheaderdetails
{
 "enabled": true,
 "forwardHeaderValue": "10.75.225.67" 
}

200 OK

Response Body

{
 "enabled": true,
 "forwardHeaderValue": "10.75.225.67" 
}
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/forwardheaderdetails
{
 "enabled": true,
 "forwardHeaderValue": "10.75.225.67" 
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peerconfiguration
[
    {
        "id": "peer1",
        "host": "10.75.225.67",
        "port": "31235",
        "apiPrefix": "/"
    }
]

200 OK

Response Body

[
    {
        "id": "peer1",
        "host": "10.75.225.67",
        "port": "31235",
        "apiPrefix": "/"
    }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peerconfiguration
[
    {
        "id": "peer1",
        "host": "10.75.225.67",
        "port": "31235",
        "apiPrefix": "/"
    }
]

200 OK

Response Body

[
    {
        "id": "peer1",
        "host": "10.75.225.67",
        "port": "31235",
        "apiPrefix": "/"
    }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peerconfiguration
[
    {
        "id": "peer1",
        "host": "10.75.225.67",
        "port": "31235",
        "apiPrefix": "/"
    }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peersetconfiguration
[
    {
    "id":"set0",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }]
    },
    {
        "id":"set1",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 2,
                "peerIdentifier": "peer3"
    }]         
      },
      {
        "id":"set2",
    "httpsConfiguration":[
    {
                "priority": 1,
                "peerIdentifier": "peer4"
    }]
    }
]

200 OK

Response Body

[
    {
    "id":"set0",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }]
    },
    {
        "id":"set1",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 2,
                "peerIdentifier": "peer3"
    }]         
      },
      {
        "id":"set2",
    "httpsConfiguration":[
    {
                "priority": 1,
                "peerIdentifier": "peer4"
    }]
    }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peersetconfiguration
[
    {
    "id":"set0",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }]
    },
    {
        "id":"set1",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 2,
                "peerIdentifier": "peer3"
    }]         
      },
      {
        "id":"set2",
    "httpsConfiguration":[
    {
                "priority": 1,
                "peerIdentifier": "peer4"
    }]
    }
]

200 OK

Response Body

[
    {
    "id":"set0",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }]
    },
    {
        "id":"set1",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 2,
                "peerIdentifier": "peer3"
    }]         
      },
      {
        "id":"set2",
    "httpsConfiguration":[
    {
                "priority": 1,
                "peerIdentifier": "peer4"
    }]
    }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/peersetconfiguration
[
    {
    "id":"set0",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer1"
    },
    {
                "priority": 2,
        "peerIdentifier": "peer2"
    }]
    },
    {
        "id":"set1",
    "httpConfiguration":[
    {
                "priority": 1,
        "peerIdentifier": "peer2"
    }],
    "httpsConfiguration":[
    {
                "priority": 2,
                "peerIdentifier": "peer3"
    }]         
      },
      {
        "id":"set2",
    "httpsConfiguration":[
    {
                "priority": 1,
                "peerIdentifier": "peer4"
    }]
    }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/retryprofile
{
    "retryCount": 3,
    "requestTimeout": 3000,
    "statuses": ["4xx"],
    "exceptions": ["java.net.ConnectException"]
}

200 OK

Response Body

{
    "retryCount": 3,
    "requestTimeout": 3000,
    "statuses": ["4xx"],
    "exceptions": ["java.net.ConnectException"]
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/retryprofile
{
    "retryCount": 3,
    "requestTimeout": 3000,
    "statuses": ["4xx"],
    "exceptions": ["java.net.ConnectException"]
}

200 OK

Response Body

{
    "retryCount": 3,
    "requestTimeout": 3000,
    "statuses": ["4xx"],
    "exceptions": ["java.net.ConnectException"]
}
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/retryprofile
{
    "retryCount": 3,
    "requestTimeout": 3000,
    "statuses": ["4xx"],
    "exceptions": ["java.net.ConnectException"]
}

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/routesconfiguration
[
    {
        "id": "egress_scp_proxy1",
        "uri": "http://localhost:32068/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false,
            "configurableErrorCodes": {
                "enabled": false,
                "errorScenarios": [
                    {
                        "exceptionType": "CONNECTION_TIMEOUT",
                        "errorProfileName": "ERR_100"
                    },
                    {
                        "exceptionType": "REQUEST_TIMEOUT",
                        "errorProfileName": "ERR_200"
                    }
                ]
            }
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/npcf"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": true,
                    "errorHandling": [
                        {
                            "errorCriteriaSet": "criteria_1",
                            "actionSet": "action_1",
                            "priority": 1
                        },
                        {
                            "errorCriteriaSet": "criteria_0",
                            "actionSet": "action_0",
                            "priority": 2
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "egress_scp_proxy2",
        "uri": "http://localhost:32069/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/nef"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": false
                }
            }
        ]
    }
]

200 OK

Response Body

[
    {
        "id": "egress_scp_proxy1",
        "uri": "http://localhost:32068/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false,
            "configurableErrorCodes": {
                "enabled": false,
                "errorScenarios": [
                    {
                        "exceptionType": "CONNECTION_TIMEOUT",
                        "errorProfileName": "ERR_100"
                    },
                    {
                        "exceptionType": "REQUEST_TIMEOUT",
                        "errorProfileName": "ERR_200"
                    }
                ]
            }
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/npcf"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": true,
                    "errorHandling": [
                        {
                            "errorCriteriaSet": "criteria_1",
                            "actionSet": "action_1",
                            "priority": 1
                        },
                        {
                            "errorCriteriaSet": "criteria_0",
                            "actionSet": "action_0",
                            "priority": 2
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "egress_scp_proxy2",
        "uri": "http://localhost:32069/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/nef"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": false
                }
            }
        ]
    }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/routesconfiguration
[
    {
        "id": "egress_scp_proxy1",
        "uri": "http://localhost:32068/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false,
            "configurableErrorCodes": {
                "enabled": false,
                "errorScenarios": [
                    {
                        "exceptionType": "CONNECTION_TIMEOUT",
                        "errorProfileName": "ERR_100"
                    },
                    {
                        "exceptionType": "REQUEST_TIMEOUT",
                        "errorProfileName": "ERR_200"
                    }
                ]
            }
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/npcf"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": true,
                    "errorHandling": [
                        {
                            "errorCriteriaSet": "criteria_1",
                            "actionSet": "action_1",
                            "priority": 1
                        },
                        {
                            "errorCriteriaSet": "criteria_0",
                            "actionSet": "action_0",
                            "priority": 2
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "egress_scp_proxy2",
        "uri": "http://localhost:32069/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/nef"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": false
                }
            }
        ]
    }
]

200 OK

Response Body

[
    {
        "id": "egress_scp_proxy1",
        "uri": "http://localhost:32068/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false,
            "configurableErrorCodes": {
                "enabled": false,
                "errorScenarios": [
                    {
                        "exceptionType": "CONNECTION_TIMEOUT",
                        "errorProfileName": "ERR_100"
                    },
                    {
                        "exceptionType": "REQUEST_TIMEOUT",
                        "errorProfileName": "ERR_200"
                    }
                ]
            }
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/npcf"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": true,
                    "errorHandling": [
                        {
                            "errorCriteriaSet": "criteria_1",
                            "actionSet": "action_1",
                            "priority": 1
                        },
                        {
                            "errorCriteriaSet": "criteria_0",
                            "actionSet": "action_0",
                            "priority": 2
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "egress_scp_proxy2",
        "uri": "http://localhost:32069/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/nef"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": false
                }
            }
        ]
    }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/routesconfiguration
[
    {
        "id": "egress_scp_proxy1",
        "uri": "http://localhost:32068/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false,
            "configurableErrorCodes": {
                "enabled": false,
                "errorScenarios": [
                    {
                        "exceptionType": "CONNECTION_TIMEOUT",
                        "errorProfileName": "ERR_100"
                    },
                    {
                        "exceptionType": "REQUEST_TIMEOUT",
                        "errorProfileName": "ERR_200"
                    }
                ]
            }
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/npcf"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": true,
                    "errorHandling": [
                        {
                            "errorCriteriaSet": "criteria_1",
                            "actionSet": "action_1",
                            "priority": 1
                        },
                        {
                            "errorCriteriaSet": "criteria_0",
                            "actionSet": "action_0",
                            "priority": 2
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "egress_scp_proxy2",
        "uri": "http://localhost:32069/",
        "order": 3,
        "metadata": {
            "httpsTargetOnly": false,
            "httpRuriOnly": false,
            "sbiRoutingEnabled": false
        },
        "predicates": [
            {
                "args": {
                    "pattern": "/nef"
                },
                "name": "Path"
            }
        ],
        "filters": [
            {
                "name": "SbiRouting",
                "args": {
                    "peerSetIdentifier": "set0",
                    "customPeerSelectorEnabled": false
                }
            }
        ]
    }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerroractionsets
[
   {
      "id":"action_0",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   },
   {
      "id":"action_1",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   }
]

200 OK

[
   {
      "id":"action_0",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   },
   {
      "id":"action_1",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerroractionsets
[
   {
      "id":"action_0",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   },
   {
      "id":"action_1",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   }
]

200 OK

[
   {
      "id":"action_0",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   },
   {
      "id":"action_1",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerroractionsets
[
   {
      "id":"action_0",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   },
   {
      "id":"action_1",
      "action":"reroute",
      "attempts":2,
      "blacklist":{
         "enabled":false,
         "duration":60000
      }
   }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerrorcriteriasets
[
   {
      "id":"criteria_0",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "exceptions":[
         "java.util.concurrent.TimeoutException",
         "java.net.UnknownHostException"
      ]
   },
   {
      "id":"criteria_1",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "response":{
         "statuses":[
            {
               "statusSeries":"4xx",
               "status":[
                  400,
                  404
               ]
            },
            {
               "statusSeries":"5xx",
               "status":[
                  500,
                  503
               ]
            }
         ],
         "headersMatchingScript":"headerCheck,server,via,.*(SEPP|UDR).*"
       }
   }
]

200 OK

[
   {
      "id":"criteria_0",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "exceptions":[
         "java.util.concurrent.TimeoutException",
         "java.net.UnknownHostException"
      ]
   },
   {
      "id":"criteria_1",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "response":{
         "statuses":[
            {
               "statusSeries":"4xx",
               "status":[
                  400,
                  404
               ]
            },
            {
               "statusSeries":"5xx",
               "status":[
                  500,
                  503
               ]
            }
         ],
         "headersMatchingScript":"headerCheck,server,via,.*(SEPP|UDR).*"
       }
   }
]
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerrorcriteriasets
[
   {
      "id":"criteria_0",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "exceptions":[
         "java.util.concurrent.TimeoutException",
         "java.net.UnknownHostException"
      ]
   },
   {
      "id":"criteria_1",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "response":{
         "statuses":[
            {
               "statusSeries":"4xx",
               "status":[
                  400,
                  404
               ]
            },
            {
               "statusSeries":"5xx",
               "status":[
                  500,
                  503
               ]
            }
         ],
         "headersMatchingScript":"headerCheck,server,via,.*(SEPP|UDR).*"
       }
   }
]

200 OK

[
   {
      "id":"criteria_0",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "exceptions":[
         "java.util.concurrent.TimeoutException",
         "java.net.UnknownHostException"
      ]
   },
   {
      "id":"criteria_1",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "response":{
         "statuses":[
            {
               "statusSeries":"4xx",
               "status":[
                  400,
                  404
               ]
            },
            {
               "statusSeries":"5xx",
               "status":[
                  500,
                  503
               ]
            }
         ],
         "headersMatchingScript":"headerCheck,server,via,.*(SEPP|UDR).*"
       }
   }
]
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/sbiroutingerrorcriteriasets
[
   {
      "id":"criteria_0",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "exceptions":[
         "java.util.concurrent.TimeoutException",
         "java.net.UnknownHostException"
      ]
   },
   {
      "id":"criteria_1",
      "method":[
         "GET",
         "POST",
         "PUT",
         "DELETE",
         "PATCH"
      ],
      "response":{
         "statuses":[
            {
               "statusSeries":"4xx",
               "status":[
                  400,
                  404
               ]
            },
            {
               "statusSeries":"5xx",
               "status":[
                  500,
                  503
               ]
            }
         ],
         "headersMatchingScript":"headerCheck,server,via,.*(SEPP|UDR).*"
       }
   }
]

200 OK
PUT http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/useragentheader
{
   "enabled": false,
   "nfType": " SMF",
   "nfInstanceId": "",
   "nfFqdn": "smf.org",
   "addFqdnToHeader": true,
   "overwriteHeader": true
}

200 OK

{
   "enabled": false,
   "nfType": " SMF",
   "nfInstanceId": "",
   "nfFqdn": "smf.org",
   "addFqdnToHeader": true,
   "overwriteHeader": true
}
PATCH http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/useragentheader
{
   "enabled": false,
   "nfType": " SMF",
   "nfInstanceId": "",
   "nfFqdn": "smf.org",
   "addFqdnToHeader": true,
   "overwriteHeader": true
}

200 OK

{
   "enabled": false,
   "nfType": " SMF",
   "nfInstanceId": "",
   "nfFqdn": "smf.org",
   "addFqdnToHeader": true,
   "overwriteHeader": true
}
GET http://<nudr-config svc IP>:<port>/udr/nf-common-component/v1/egw/useragentheader
{
   "enabled": false,
   "nfType": " SMF",
   "nfInstanceId": "",
   "nfFqdn": "smf.org",
   "addFqdnToHeader": true,
   "overwriteHeader": true
}

200 OK

5.2.4 Configuration APIs for Overload Handling

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

Table 5-6 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-7 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.2.5 Configuration APIs for Rate Limit

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

Table 5-8 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.2.5.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-9 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-10 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-11 Method wise Rate Details

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

    Table 5-12 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-13 Method wise Rate Details

    Method Rate
    GET 800
    PUT 200
    DELETE 200

5.3 Configuration APIs for Subscriber Bulk Import Tool and Subscriber Export Tool

The following table describes the configuration APIs for Subscriber Bulk Import Tool.

Table 5-14 Configuration APIs for Subscriber Bulk Import Tool

HTTP Method Sample Request REST URL Sample Response Notes
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.
The following table describes the configuration APIs for Subscriber Export Tool.

Table 5-15 Configuration APIs for Subscriber Export Tool.

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.

For more information about the Subscriber Bulk Import Tool and Subscriber Export Tool configurable parameters, see Oracle Communications Cloud Native Core Unified Data Repository User Guide.

5.4 Configuration APIs for Loglevel

This section describes the configuration APIs for loglevel.

Table 5-16 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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

[{"ingress-gateway-prov":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null,\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"oauth\",\"logLevelForPackage\":\"WARN\"}]}","nudr-notify-service":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":\"DISABLED\"}","app-info":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null}","diam-gateway":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"INFO\",\"additionalErrorLogging\":\"DISABLED\"}","nrf-client-nfmanagement":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null,\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}]}","ingress-gateway-sig":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null,\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"oauth\",\"logLevelForPackage\":\"WARN\"}]}","nudr-dr-provservice":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":\"DISABLED\"}","nudr-config":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":\"DISABLED\"}","egress-gateway":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null,\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"oauth\",\"logLevelForPackage\":\"WARN\"}]}","perf-info":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null}","nudr-diameterproxy":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":\"DISABLED\"}","alternate-route":"{\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":null,\"logSubscriberInfo\":null,\"packageLogLevel\":[{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}]}","nudr-drservice":"{\"packageLogLevel\":[{\"packageName\":\"jetty\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"springframework\",\"logLevelForPackage\":\"WARN\"},{\"packageName\":\"root\",\"logLevelForPackage\":\"WARN\"}],\"logSubscriberInfo\":\"DISABLED\",\"appLogLevel\":\"WARN\",\"additionalErrorLogging\":\"DISABLED\"}"}]
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
    }],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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",
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
    }],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 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"
        }
    ],
    "logSubscriberInfo": "DISABLED",
    "additionalErrorLogging": "DISABLED"
}
  • 404 NOT FOUND
  • 400 BAD REQUEST

5.5 List of Errors and their Details

The list of errors and their details are as follows:

Table 5-17 Error Code Catalogue

Error Details Possible Causes Corrective Actions

Error Code: E550

HTTP Response Code: 404

Category: CFG

Error Description: The import or export ResourceId or report not found

Provided import or export ResourceId is incorrect. The import or export report with the provided ResourceId is not found.

 Check if the provided import or export ResourceId is correct.

Error Code: E551

HTTP Response Code: 500

Category: CFG

Error Description: Retrieving the report or status of import or export when the operation is still in progress.

Retrieving the report or status of import or export when the operation is still in progress.

Try after the existing import or export is completed.

Error Code: E552

HTTP Response Code: 500

Category: CFG

Error Description:The import or exportt report is not generated.

The import or export report creation failed.

 NA

Error Code: E553

HTTP Response Code: 400

Category: CFG

Error Description: Empty or incorrect MO passed.

Empty MO value passed or the passed MO value is incorrect.

 Provide a valid MO value.

Error Code: E554

HTTP Response Code: 400

Category: CFG

Error Description: The file provided for the import has unsupported file format or file content.

Import file other than ZIP file format is provided. Error reading zip stream or unable to extract contents of file.

 Check and upload the file with supported format and file content.
E555

HTTP Response Code: 500

Category: CFG

Error Description: Another import or export operation request is in progress.

Another import or export request is in progress.

 You must wait for previous requests to complete before performing another import or export operation.

Error Code: E556

HTTP Response Code: 500

Category: CFG

Error Description: Unable to download exported data

Could not create exported JSON files.

 NA

Error Code: E557

HTTP Response Code: 400

Category: CFG

Error Description: Controlled Shutdown feature is disabled

Controlled shutdown feature is disabled when updating OperationalStatus.

 Enable the controlled shutdown feature.

Error Code: E558

HTTP Response Code: 400

Category: CFG

Error Description: Invalid OperationalState

Invalid OperationalState provided.

 Provide operationalState with "NORMAL" or "COMPLETE_SHUTDOWN"

Error Code: E559

HTTP Response Code: 403

Category: CFG

Error Description: Read only field can not be modified.

Tried to modify a read only field.

 NA

Error Code: E560

HTTP Response Code: 400

Category: CFG

Error Description: Invalid URI sent from client.

The URI in the request is invalid or does not comply to the specification.

 Check the specification for the correct URI.

Error Code: E561

HTTP Response Code: 415

Category: CFG

Error Description: Unsupported Media Type Header

The handleHttpMediaType is not supported.

 Content type header is incorrect.

Error Code: E562

HTTP Response Code: 406

Category: CFG

Error Description: Media type header not acceptable.

The handleHttpMediaType is not supported.

 Accept header is incorrect.

Error Code: E564

HTTP Response Code: 400

Category: CFG

Error Description: Invalid schema content supplied or schema validation failed.

Schema update request payload, json content is invalid. The request payload json content does not comply to schema defined.

 Check the schema for correctness and formatting issues.

Error Code: E565

HTTP Response Code: 404

Category: CFG

Error Description: Data field does not exist.

The request sent for unavailable service configuration data. Check if the service key or id used is valid.

Error Code: E566

HTTP Response Code: 404

Category: CFG

Error Description: NF Operational State not found.

NF Operational status is not found. NA

Error Code: E567

HTTP Response Code: 404

Category: CFG

Error Description: Operational State History not present for the limit.

Operational State History for the limit is not found.

 NA

Error Code: E568

HTTP Response Code: 404

Category: CFG

Error Description: NF score not available.

NF score not available. NA

Error Code: E569

HTTP Response Code: 400

Category: CFG

Error Description: Peer identity must be unique

Multiple peers with same identity is received.

 Make sure to use unique for every diam serverpeer.

Error Code: E570

HTTP Response Code: 500

Category: DB

Error Description: SQL Command Grammar Error

SQL statement syntax issues.

 Check the logs for more details.

Error Code: E571

HTTP Response Code: 500

Category: DB

Error Description: Resource accessed in an invalid fashion.

Database fetch failure.

 Check the logs for more details.

Error Code: E572

HTTP Response Code: 500

Category: DB

Error Description: Permission denied to requested resource on the database.

Database access failed due to permission issues.

 Check the logs for more details.

Error Code: E573

HTTP Response Code: 503

Category: DB

Error Description: Database table or resource not accessible.

Data retrieval from database failed.

 Check the database availability and connectivity. Check the logs for more information on SQL state.

Error Code: E574

HTTP Response Code: 503

Category: DB

Error Description: Transient database access issue.

Data retrieval from database failed.

 Check the database availability and connectivity. Check the logs for more information on SQL state.

Error Code: E575

HTTP Response Code: 503

Category: DB

Error Description: Cannot acquire lock on database resource.

Data retrieval from database failed.

 Check the database state and database. Check the logs for more information on SQL state.

Error Code: E576

HTTP Response Code: 400

Category: CFG

Error Description: Insertion or update of invalid records to database.

Internal SQL transaction failures due to invalid records not matching table schema.

 Check the content shared in payload from where the content is formed for insertion or update.

Error Code: E577

HTTP Response Code: 404

Category: CFG

Error Description: Resource fetch from database failed.

Exception occurred during resource fetch from database.

 Check the logs for more information on failures.

Error Code: E578

HTTP Response Code: 400

Category: CFG

Error Description: Invalid payload.

Internal JSON format data formation failure or invalid parameters passed, or, empty payload is passed.

 Check for any missing required parameters in the payload or check for provided empty payload.

Error Code: E579

HTTP Response Code: 400

Category: CFG

Error Description: Invalid format of data

Invalid payload. Parameter with number type is not set correctly.

 Check the number or integer parameters are correct in the payload.

Error Code: E580

HTTP Response Code: 405

Category: CFG

Error Description: Operation not allowed.

REST API used does not support the requested operation type.

 Check the specification for the allowed operations for provided REST API in request.

Error Code: E581

HTTP Response Code: 500

Category: CFG

Error Description: Internal server error

Unidentified internal server errors.

 Check the logs for more details.

Error Code: E582

HTTP Response Code: 400

Category: CFG

Error Description: Subscriber export ranges are not valid.

The provided start range value is greater than the end range value.

 Provide the correct values for start range and end range.