nf-instances

(Store)

/nf-instances

GET

Read a collection of NF Instances.

OPTIONS

Discover the communication options supported by the NRF for this resource.

nf-instance

(Document)

/nf-instances/{nfInstanceID}

GET

Read the profile of a given NF Instance.

PUT

Register in NRF a new NF Instance, or replace the profile of an existing NF Instance, by providing an NF profile.

PATCH

Modify the NF profile of an existing NF Instance.

DELETE

Deregister from NRF a given NF Instance.

subscriptions

(Collection)

/subscriptions

POST

Creates a new subscription in NRF to newly registered NF Instances.

subscription

(Document)

/subscriptions/{subscriptionID}

PATCH

Updates an existing subscription in NRF.

DELETE

Deletes an existing subscription from NRF.

Notification Callback

{nfStatusNotificationUri}

POST

Notify about newly created NF Instances, or about changes of the profile of a given NF Instance.

apiRoot

string

See clause 6.1.1

nf-type

NFType

O

0..1

The type of NF to restrict the list of returned NF Instances.

limit

integer

C

0..1

Maximum number of items to be returned in this query; this parameter should only be provided if the "nf-type" parameter is provided.

If the "page-number" and "page-size" parameters are present, the "limit" parameter shall be absent.

page-number

integer

C

0..1

This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages (i.e. a subset of the total number of items).

If present, it shall contain the page number to retrieve.

The total number of pages available, N, can be determined based on the "totalItemCount" attribute of the response (see clause 6.1.6.2.25) as:

N = ceiling(totalItemCount / page-size)

The first page shall be identified by "page-number" set to 1.

Minimum: 1

(See NOTE 1, NOTE 2)

page-size

integer

C

0..1

This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages.

If present, it shall contain the maximum number of items to be returned per page.

Minimum: 1

(See NOTE 1, NOTE 2)

NOTE 1: The parameters "page-number" and "page-size" shall be either both present, or both absent.

NOTE 2: If the NRF supports the pagination query parameters, it shall ensure that the response to these requests always return the same set of items for the same query parameters, as long as the ETag of the collection resource is not changed.

n/a

UriList

M

1

200 OK

The response body contains a "_links" object containing the URI of each registered NF in the NRF.

If there are no NFs to return in the query result (e.g., because there are no registered NFs in the NRF, or because there are no matching NFs of the type specified in the "nf-type" query parameter, currently registered in the NRF), the "_links" attribute may be absent or, if present, it shall contain only the "self" attribute (i.e. the "item" attribute shall be absent).

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

ETag

string

C

0..1

Entity Tag containing a strong validator, described in IETF RFC 7232 [19], clause 2.3.

In this resource, this header shall contain a different value if the list of NF instances (regardless of the contents of each NF instance profile) stored in the NRF has changed; i.e. it shall change if there are new instances added to the NRF, or if existing instances are removed from the NRF.

If the NF Service Consumer, during the course of successive paginated requests, receives a different ETag value, it shall conclude that the list of NF Instances in the NRF has changed, so it may re-start the paginated NFListRetrieval service operation.

n/a

n/a

n/a

204 No Content

OptionsResponse

M

1

200 OK

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

ProblemDetails

O

0..1

405 Method Not Allowed

ProblemDetails

O

0..1

501 Not Implemented

NOTE: The mandatory HTTP error status codes for the OPTIONS method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Accept-Encoding

string

O

0..1

Accept-Encoding, described in IETF RFC 7694 [41]

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

apiRoot

string

See clause 6.1.1

nfInstanceID

NfInstanceId

Represents a specific NF Instance

requester-features

SupportedFeatures

C

0..1

Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NF Service Consumer.

n/a

NFProfile

M

1

200 OK

The response body contains the profile of a given NF Instance.

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

ETag

string

C

0..1

Entity Tag containing a strong validator, described in IETF RFC 7232 [19], clause 2.3

n/a

NFProfile

M

1

Profile of the NF Instance to be registered, or completely replaced, in NRF.

NFProfile

M

1

200 OK

This case represents the successful replacement of an existing NF Instance profile.

Upon success, a response body is returned containing the replaced profile of the NF Instance.

NFProfile

M

1

201 Created

This case represents the successful registration of a new NF Instance.

Upon success, a response body is returned containing the newly created NF Instance profile; also, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NF Instance.

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

NOTE: The mandatory HTTP error status codes for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Content-Encoding

string

O

0..1

Content-Encoding, described in IETF RFC 7231 [40]

Accept-Encoding

string

O

0..1

Accept-Encoding, described in IETF RFC 7694 [41]

ETag

string

C

0..1

Entity Tag containing a strong validator, described in IETF RFC 7232 [19], clause 2.3

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId}

Accept-Encoding

string

O

0..1

Accept-Encoding, described in IETF RFC 7694 [41]

ETag

string

C

0..1

Entity Tag containing a strong validator, described in IETF RFC 7232 [19], clause 2.3

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

n/a

array(PatchItem)

M

1

It contains the list of changes to be made to the profile of the NF Instance, according to the JSON PATCH format specified in IETF RFC 6902 [13].

NFProfile

M

1

200 OK

Upon success, a response body is returned containing the updated profile of the NF Instance.

n/a

204 No Content

Successful response sent when there is no need to provide a full updated profile of the NF Instance (e.g., in the Heart-Beat operation response described in clause 5.2.2.3.2).

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

ProblemDetails

O

0..1

412 Precondition Failed

The modification has failed due to the precondition in the request is not fulfilled.

ProblemDetails

O

0..1

409 Conflict

The modification has failed due to confliction (e.g. to change a value of a non-existing IE).

NOTE: The mandatory HTTP error status codes for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

If-Match

string

C

0..1

Validator for conditional requests, as described in IETF RFC 7232 [19], clause 3.2.

ETag

string

C

0..1

Entity Tag containing a strong validator, described in IETF RFC 7232 [19], clause 2.3.

n/a

n/a

n/a

204 No Content

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

apiRoot

string

See clause 6.1.1

n/a

SubscriptionData

M

1

The request body contains the input parameters for the subscription. These parameters include, e.g.:

– Target NF type

– Target Service Name

– Callback URI of the Requester NF

SubscriptionData

M

1

201 Created

This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– SUBSCRIPTION_NOT_ALLOWED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– NF_NOT_FOUND

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId}

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

apiRoot

string

See clause 6.1.1

subscriptionID

string

Represents a specific subscription

n/a

n/a

n/a

204 No Content

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

n/a

array(PatchItem)

M

1..N

It contains the list of changes to be made to an individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13].

SubscriptionData

M

1

200 OK

n/a

204 No Content

RedirectResponse

O

0..1

307 Temporary Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– NF_NOT_FOUND

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent

Location

string

M

1

A URI pointing to the endpoint of the NRF service instance to which the request should be sent