Error Codes

Errors

Error responses are formatted according to 3GPP TS.29571 and IETF RFC 7807:

• The Content-Type is set to application/problem+json.
• The body is a ProblemDetails object.

For example:

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
Content-Language: en

{
 "type": "https://example.net/validation-error",
 "title": "Your request parameters didn't validate.",
 "invalid-params": [ {
                       "name": "age",
                       "reason": "must be a positive integer"
                     },
                     {
                       "name": "color",
                       "reason": "must be 'green', 'red' or 'blue'"}
                   ]
}

Common Error Codes

Common Error Codes shows common error codes typically sent by an SBA Gateway network function. These error codes are defined in 3GPP TS 29.500 table 5.2.7.2-1 ("Protocol and application errors common to several 5GC SBI API specifications" in "NF as HTTP Server").

Converged Charging Error Codes

In addition to the errors defined in Common Error Codes, the Converged Charging API can also send the following (as defined in 3GPP TS 32.291 table 6.1.7.3-1). Converged Charging Error Codes shows these converged charging error codes:

Spending Limit Control Error Codes

Spending Limit Control Error Codes shows the error codes for spending limits:

Network Function Error Codes

Every REST URI that forwards requests to MATRIXX Engine provides configuration to map error responses to the appropriate ProblemDetails error.

The charging data and spending limit control URIs define the following resultCodes by default. These are in addition to the scenarios that can cause the errors defined in common error codes (such as a badly formed message).

More precise matches (that is, matching of both the Result and the ResultDetails) are used in preference to less precise (that is, matching when only the Result value is defined).

The error code mapping (that is, MATRIXX Engine response to SBA response) is defined within the nf-defaults.yaml configuration. This file is included chf-sideloader-template.zip file. This allows for the response to be based on just the Result value of the response or the Result and the ResultDetails values. In addition to negative outcomes, a Result (or Result and ResultDetail) value can be mapped to SUCCESS, which denotes that the message must not be treated as an error. These can be updated or modified by adding overriding configuration to the nf.yaml.

This example shows how error codes in the converged charging API and spending limit control APIs are defined:

mdc:
  handlers:
    chargingData:
      resultCodes:
 
        - engineResult: 0
          sbaResponse: SUCCESS
 
        - engineResult: 10
          sbaResponse: INVALID_MSG_FORMAT
 
       - engineResult: 10
         engineResultDetails: 48
         sbaResponse: USER_UNKNOWN
 
         # shortened for example
 
       - engineResult: 39
         sbaResponse: END_USER_REQUEST_DENIED
   
    spendingLimitControl:
 
      resultCodes:
 
        - engineResult: 0
          sbaResponse: SUCCESS
 
        - engineResult: 10
          sbaResponse: INVALID_MSG_FORMAT
 
       - engineResult: 10
         engineResultDetails: 42
         sbaResponse: MANDATORY_IE_INCORRECT
 
       - engineResult: 26
         sbaResponse: NO_AVAILABLE_POLICY_COUNTERS

Each resultCode element has an engineResult, an sbResponse and, optionally, an engineResultDetails value. The sbaResponse values correlate with the error codes defined in the tables (except for SUCCESS). They dictate the HTTP status code used and the basic contents of the ProblemDetails response object.

Customizing Errors

Use uppercase for names, and use underscore characters instead of spaces. Defining a new key adds a new error definition. Re-defining an existing key replaces the existing error definition with yours.

Custom Error Definition Properties shows the properties of custom errors, with typical values:

Change the HTTP status and title of the CHARGING_FAILED error definition by adding to your nf.yaml file, for example (commented ends of lines show the preceding entries):

gateway:
  errors:
    CHARGING_FAILED:
      type: "/errors/charging-failed"
      title: "Oh No! Charging Failed" # Changed from 'Charging Failed'
      status: 500 # (changed from 400 BadRequest)

A new definition for an error called CUSTOM_ERROR is an addition to your nf.yaml file like the following:

gateway:
  errors:
    CUSTOM_ERROR:
      type: "/errors/custom-error"
      title: "This is my custom error"
      status: 418 #IAmATeapot

Known Alarms

SBA Gateway can raise alarms in certain scenarios. These messages are written to logs and can be picked up by third-party logging to take the relevant action. Known Common Alarms shows the known common alarms: