NF Heartbeat Procedure

The following figure illustrates the NF Heartbeat call flow.

NF Heartbeat Call Flow
NF Heartbeat Call Flow Description
Step

Description

1

The NF Service Consumer sends a PATCH request to the resource URI representing the NF instance. The payload body of the PATCH request contains a replace operation on the nfStatus attribute of the NF Profile of the NF instance, and set it to the value REGISTERED.

2

On success, if the NF Profile changes, the NRF returns "200 OK" along with the full NF Profile data in the response body; otherwise, "204 No Content" is returned.

3

If the NF instance, identified by the "nfInstanceID", is not found in the list of registered NF instances in the NRF's database, the NRF returns "404 Not Found" status code with the ProblemDetails IE providing details of the error. Example:

PATCH .../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64
Content-Type: application/json-patch+json 
[ 
  {“op": "replace", "path": "/nfStatus", "value": "REGISTERED”} 
] 
HTTP/2 204 No Content 
Content-Location: .../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64