DNS contexts collection

/dns-contexts

POST

Create

Individual DNS context

/dns-contexts/{dnsContextId}

PATCH

Update (partial update)

PUT

Update (complete replacement)

DELETE

Delete

apiRoot

string

See clause 6.1.1

apiVersion

string

See clause 6.1.1

n/a

DnsContextCreateData

M

1

Representation of the DNS context to be created in the EASDF

DnsContextCreatedData

M

1

201 Created

Successful creation of a DNS context

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

ProblemDetails

O

0..1

400 Bad Request

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

– BASELINE_DNS_PATTERN_UNKNOWN

– BASELINE_DNS_MDT_UNKNOWN

– BASELINE_DNS_AIT_UNKNOWN

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/neasdf-dnscontext/<apiVersion>/dns-contexts/{dnsContextId}

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

apiRoot

string

See clause 6.1.1.

apiVersion

string

See clause 6.1.1.

dnsContextId

string

DNS context Identifier assigned by the EASDF during the Create service operation.

n/a

n/a

n/a

204 No Content

Successful deletion of the DNS context.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

n/a

array(PatchItem)

M

1..N

It contains the list of changes to be made to the DNS context, according to the JSON PATCH format specified in IETF RFC 6902 [15].

PatchResult

M

1

200 OK

Upon partial success, e.g. some of the requested modifications for unknown attribute(s) are discarded while the rest of the modification instructions are fully accepted, the EASDF shall return the execution report.

n/a

204 No Content

Successful update of the DNS context.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

n/a

DnsContextCreateData

M

1

DNS Context Data to replace the existing DNS context data

n/a

204 No Content

Successful update of the DNS context.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

DNS Context Notification

{notifyUri}

(Notification URI provided by NF Service Consumer)

POST

DNS Context Notify

notifyUri

String formatted as URI with the Callback Uri

DnsContextNotification

M

1

Representation of the DNS context notification

n/a

204 No Content

Successful notification of the DNS context change

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

A URI pointing to the endpoint of another NF service consumer to which the notification should be sent or pointing to the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

Location

string

M

1

A URI pointing to the endpoint of another NF service consumer to which the notification should be sent or pointing to the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

DnsContextCreateData

6.1.6.2.2

Data in DNS Context Create request

DnsContextCreatedData

6.1.6.2.3

Data in DNS Context Create response

DnsRule

6.1.6.2.4

DNS handling rule

DnsQueryMdt

6.1.6.2.5

DNS Query Message Detection Template

DnsRspMdt

6.1.6.2.6

DNS Response Message Detection Template

Ipv4AddressRange

6.1.6.2.7

IPv4 addresses range

Ipv6PrefixRange

6.1.6.2.8

IPv6 addresses range

Action

6.1.6.2.9

Action to apply to DNS messages matching a message detection template

DnsContextNotification

6.1.6.2.10

DNS context notification

ForwardingParameters

6.1.6.2.11

Forwarding instructions

EcsOption

6.1.6.2.12

ECS Option information

DnsContextEventReport

6.1.6.2.13

DNS context Event report

DnsQueryReport

6.1.6.2.14

DNS Query Event Report

DnsRspReport

6.1.6.2.15

DNS Response Event Report

EcsOptionInfo

6.1.6.2.16

ECS option information

DnsServerAddressInfo

6.1.6.2.17

DNS Server address information

BaselineDnsMdtId

6.1.6.2.18

Baseline DNS Message Detection Template Identifier

BaselineDnsAitId

6.1.6.2.19

Baseline DNS Action Information Template Identifier

BaselineDnsQueryMdtInfo

6.1.6.2.20

Baseline DNS Query MDT ID and

optionally associated information

BaselineDnsRspMdtInfo

6.1.6.2.21

Baseline DNS Response MDT ID and

optionally associated information

ApplyAction

6.1.6.3.3

Action to apply to the DNS packet

IPv4Addr

3GPP TS 29.571 [16]

IPv4 address

IPv6Prefix

3GPP TS 29.571 [16]

IPv6 prefix

Dnn

3GPP TS 29.571 [16]

DNN

Uri

3GPP TS 29.571 [16]

URI

Uint32

3GPP TS 29.571 [16]

Unsigned 32-bit integer

IpAddr

3GPP TS 29.571 [16]

IP address

IPv6Addr

3GPP TS 29.571 [16]

IPv6 address

SupportedFeatures

3GPP TS 29.571 [16]

Supported features

DateTime

3GPP TS 29.571 [16]

Date and time

PatchResult

3GPP TS 29.571 [16]

FqdnPatternMatchingRule

3GPP TS 29.571 [16]

FQDN Pattern Matching Rule

Fqdn

3GPP TS 29.571 [16]

Snssai

3GPP TS 29.571 [16]

ueIpv4Addr

Ipv4Addr

C

0..1

UE IPv4 address (NOTE 1)

ueIpv6Prefix

Ipv6Prefix

C

0..1

UE IPv6 prefix (NOTE 1)

dnn

Dnn

M

1

DNN of the PDU session (NOTE 2)

sNssai

Snssai

M

1

S-NSSAI of the PDU session (NOTE 2)

dnsRules

map(DnsRule)

M

1..N

Map of DNS message handling rules.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.

notifyUri

Uri

C

0..1

Callback URI to receive notifications.

This IE shall be present if the NF service consumer subscribes to receive DNS context notifications.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

NOTE 1: At least one of the ueIpv4Addr and ueIpv6Prefix attributes shall be present.

NOTE 2: The UE IP address shall be used together with the DNN and S-NSSAI to uniquely identify the DNS context associated with a PDU session (e.g. in deployments where the same EASDF is used for PDU sessions to DNs with overlapping IP address spaces) and to associate the DNS context with a specific DN (and e.g. related tunnels connecting to the DN).

easdfIpv4Addr

IPv4Addr

C

0..1

EASDF IPv4 address

easdfIpv6Addr

IPv6Addr

C

0..1

EASDF IPv6 address

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

NOTE: At least one of the easdfIpv4Addr and easdfIpv6Addr attributes shall be present.

dnsRuleId

string

C

0..1

Unique Identifier of the DNS rule within the DNS context

This IE shall be present for a DNS rule other than a One-Time DNS rule.

label

string

O

0..1

DNS rule’s label

(NOTE 5)

precedence

Uint32

C

0..1

Precedence of the DNS message handling rule.

This IE shall be present for a DNS rule other than a One-Time DNS rule.

The lower precedence values indicate higher precedence of the DNS rule, and the higher precedence values indicate lower precedence of the DNS rule when matching a DNS message.

dnsQueryMdtList

map(DnsQueryMdt)

C

1..N

Map of DNS Query message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.

(NOTE 3)

baseDnsQueryMdtList

array(BaselineDnsQueryMdtInfo)

C

1..N

List of Baseline DNS Query Message Detection Template IDs and optionally associated information.

(NOTE 3)

dnsRspMdtList

map(DnsRspMdt)

C

1..N

Map of DNS Response message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.

(NOTE 4)

baseDnsRspMdtList

array(BaselineDnsRspMdtInfo)

C

1..N

List of Baseline DNS Response Message Detection Template IDs and optionally associated information. (NOTE 4)

dnsMsgId

string

C

0..1

DNS message identifier

This IE shall be present for a One-Time DNS Rule and it shall be set to the identifier of the DNS message buffered in the EASDF for which the DNS rule shall apply (see clause 5.2.3.2.4).

(NOTE 6)

actionList

map(Action)

M

1..N

Map of Actions to apply to DNS messages matching the DNS message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.

NOTE 1: A DNS rule shall be provisioned either for DNS Query messages or for DNS Response messages.

NOTE 2: A DNS rule including the dnsMsgId IE shall be considered as a One-Time DNS Rule (see clause 5.2.3.2.4).

NOTE 3: For a DNS rule other than a One-Time DNS rule provisioned for DNS Query messages, at least one of the dnsQueryMdtList and baseDnsQueryMdtList IEs shall be present.

NOTE 4: For a DNS Rule other than a One-Time DNS rule provisioned for DNS Response messages, at least one of the dnsRspMdtList and baseDnsRspMdtList IEs shall be present.

NOTE 5: This attribute may contain free information describing the scope of the DNS rule. It may be used e.g. for trouble-shooting.

NOTE 6: An EASDF can encode the DNS message identifier as the ID field in the header of the DNS message, or as any other string uniquely identifying the DNS message within the DNS context.

mdtId

string

M

1

Identifier of the DNS Query message detection template, with a maximum of 32 characters.

label

string

O

0..1

DNS Query MDT’s label

(NOTE 2)

sourceIpv4Addr

Ipv4Addr

O

0..1

UE IPv4 address (NOTE 1)

sourceIpv6Prefix

Ipv6Prefix

O

0..1

UE IPv6 prefix (NOTE 1)

fqdnPatternList

array(FqdnPatternMatchingRule)

O

1..N

List of FQDN patterns, where each FQDN pattern is described by a FQDN Pattern Matching Rule.

An FQDN value is considered part of the template if and only if the FQDN in the Queries field in the DNS Query message fully matches at least one FQDN pattern.

(NOTE 3)

NOTE 1: If neither the sourceIpv4Addr IE nor the sourceIpv6Prefix IE is present, the UE IP address in the DNS Context Data shall be assumed.

NOTE 2: This attribute may contain free information describing the scope of the DNS Query MDT. It may be used e.g. for trouble-shooting.

NOTE 3: The list of FQDN patterns may encode some FQDN patterns with a string matching rule and others with a regular expression (when the FQDN patterns cannot be described by a string matching rule).

mdtId

string

M

1

Identifier of the DNS Response message detection template, with a maximum of 32 characters.

label

string

O

0..1

DNS Response MDT’s label

(NOTE 1)

fqdnPatternList

array(FqdnPatternMatchingRule)

O

1..N

List of FQDN patterns, where each FQDN pattern is described by a FQDN Pattern Matching Rule.

An FQDN value is considered part of the template if and only if the FQDN in the Queries field in the DNS Response message fully matches at least one FQDN pattern.

(NOTE 2)

easIpv4AddrRanges

array(Ipv4AddressRange)

O

1..N

List of EAS IPv4 addresses ranges

easIpv6PrefixRanges

array(Ipv6PrefixRange)

O

1..N

List of EAS IPv6 prefixes ranges

NOTE 1: This attribute may contain free information describing the scope of the DNS Response MDT. It may be used e.g. for trouble-shooting.

NOTE 2: The list of FQDN patterns may encode some FQDN patterns with a string matching rule and others with a regular expression (when the FQDN patterns cannot be described by a string matching rule).

start

Ipv4Addr

M

1

First value identifying the start of an IPv4 address range

end

Ipv4Addr

M

1

Last value identifying the end of an IPv4 address range

start

Ipv6Prefix

M

1

First value identifying the start of an IPv6 prefix range

end

Ipv6Prefix

M

1

Last value identifying the end of an IPv6 prefix range

applyAction

ApplyAction

M

1

Action to apply to the DNS message

forwardingParameters

ForwardingParameters

O

0..1

This IE may be present if applyAction IE is set to " FORWARD".

When present, it shall contain forward instructions to apply to the DNS message before forwarding it.

reportingOnceInd

boolean

O

0..1

Reporting-once Indication

This IE may be present if the applyAction is set to "REPORT".

When present, it shall be set as follows:

– true: only one report shall be sent to the SMF, i.e. one report shall only be sent when a first DNS message matches any Message Detection Template of the DNS rule.

– false (default): a report shall be sent to the SMF for any DNS message matching any Message Detection Template of the DNS rule.

resetReportingOnceInd

boolean

O

0..1

Reset the Reporting-once Indication

This IE may be present in a request modifying a DNS rule, if the applyAction is set to "REPORT" and the reportingOnceInd is set to "true".

When present, it shall be set as follows:

– true: reset the Reporting-once Indication, i.e. send (only) one more report to the SMF when a next first DNS message matches any Message Detection Template of the DNS rule.

– false (default): do not reset the Reporting-once Indication

eventReportList

array(DnsContextEventReport)

O

1..N

List of event reports

ecsOptionInfo

EcsOptionInfo

O

0..1

Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE.

dnsServerAddressInfo

DnsServerAddressInfo

O

0..1

DNS Server Address Information to be used as destination address of the outgoing DNS Query

sourcePrefixLength

integer

M

1

Leftmost number of significant bits of the IP address as defined for the SOURCE PREFIX-LENGTH in clause 6 of IETF RFC 7871 [18].

Minimum=0. Maximum=128

scopePrefixLength

integer

O

0..1

Leftmost number of bits of the IP address that the DNS response covers as defined for the SCOPE PREFIX-LENGTH in clause 6 of IETF RFC 7871 [18]. This attribute shall only be sent in EASDF notification to the SMF.

Minimum=0. Maximum=128

ipAddr

IpAddr

M

1

IP address as defined for the ADDRESS in clause 6 of IETF RFC 7871 [18]

timestamp

DateTime

M

1

Time of detection of the event

dnsRuleId

Uint32

C

0..1

Identifies the DNS rule that triggered the report. This IE shall be present if the report is triggered by an event matching a DNS rule.

dnsQueryReport

DnsQueryReport

O

0..1

DNS Query Report

dnsRspReport

DnsRspReport

O

0..1

DNS Response Report

dnsMsgId

string

O

0..1

DNS message identifier

When present, this IE shall be set to a unique identifier of the DNS message for which the event is reported (see clause 5.2.3.2.4)

fqdn

Fqdn

O

0..1

FQDN received in the DNS Query

fqdn

Fqdn

O

0..1

FQDN received in the DNS Response

easIpv4Addresses

array(IPv4Addr)

O

1..N

EAS IPv4 address(es) received in the DNS Response

easIpv6Addresses

array(IPv6Addr)

O

1..N

EAS IPv6 address(es) received in the DNS Response

ecsOption

EcsOption

O

0..1

EDNS Client Subnet (ECS) option received in the DNS Response (as defined in IETF RFC 7871 [18])

ecsOption

EcsOption

C

0..1

Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE. (NOTE 1)

baseDnsAitId

BaselineDnsAitId

C

0..1

Identifier of the Baseline DNS Action Information Template that contains information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE.

(NOTE 1, NOTE 2)

NOTE 1: Either the ecsOption IE or the baseDnsAitId IE shall be present.

NOTE 2: The referenced baseline DNS Action Information Template may contain other information beyond the information to build the ECS option, in which case the EADSF shall only apply the information to build the ECS option.

dnsServerAddressList

array(IpAddr)

C

1..N

DNS Server Address to be used as destination address of the outgoing DNS Query. More than one IP address may be provided for resiliency. (NOTE 1)

baseDnsAitId

BaselineDnsAitId

C

0..1

Identifier of the Baseline DNS Action Information Template that contains DNS Server Address to be used as destination address of the outgoing DNS Query. (NOTE 1, NOTE 2)

NOTE 1: Either the dnsServerAddressList IE or the baseDnsAitId IE shall be present.

NOTE 2: The referenced baseline DNS Action Information Template may contain other information beyond the DNS Server Address information, in which case the EADSF shall only apply the DNS Server Address information.

baseDnsPatternUri

Uri

M

1

URI of the baseline DNS pattern returned in the Location header in the baseline DNS pattern creation response

mdtId

string

M

1

Identifier of the baseline DNS Message Detection Template ID within the baseline DNS pattern

baseDnsPatternUri

Uri

M

1

URI of the baseline DNS pattern returned in the Location header in the baseline DNS pattern creation response

aitId

string

M

1

Identifier of the baseline DNS Action Information Template ID within the baseline DNS pattern

sourceIpv4Addr

Ipv4Addr

O

0..1

UE IPv4 address (NOTE)

sourceIpv6Prefix

Ipv6Prefix

O

0..1

UE IPv6 prefix (NOTE)

baseDnsMdtList

array(BaselineDnsMdtId)

M

1..N

List of Baseline DNS Query Message Detection Template IDs.

NOTE: If neither the sourceIpv4Addr IE nor the sourceIpv6Prefix IE is present, the UE IP address in the DNS Context Data shall be assumed.

baseDnsMdtList

array(BaselineDnsMdtId)

M

1..N

List of Baseline DNS Response Message Detection Template IDs.

<one simple data type, i.e. boolean, integer, number, or string>

"BUFFER"

Buffer the DNS Query or Response message

"REPORT"

Report the DNS Query or Response message content to the SMF

"FORWARD"

Forward the DNS Query or Response message, after applying the instructions indicated in the forwarding parameters if any

"DISCARD"

Discard DNS messages

BASELINE_DNS_PATTERN_UNKNOWN

400 Bad Request

The request to create or modify a DNS context is rejected due to a baseline DNS pattern being unknown to the EASDF (i.e the URI of the baseline DNS pattern is unknown).

BASELINE_DNS_MDT_UNKNOWN

400 Bad Request

The request to create or modify a DNS context is rejected due to a baseline DNS Message Detection Template being unknown to the EASDF (the baseline DNS pattern is known).

BASELINE_DNS_AIT_UNKNOWN

400 Bad Request

The request to create or modify a DNS context is rejected due to a baseline DNS Action Information Template being unknown to the EASDF (the baseline DNS pattern is known).

Individual Baseline DNS Pattern

/base-dns-patterns/{smfId}/{smfImplementationSegmentPaths}

PUT

Create a new Baseline DNS pattern, or replace the existing Baseline DNS pattern, by providing an Baseline DNS pattern

PATCH

Update (partial update)

DELETE

Delete

apiRoot

string

See clause 6.2.1.

apiVersion

string

See clause 6.2.1.

smfId

VarNfId

Represents the SMF Set Identifier (see NF Set Identifier in clause 28.12 of 3GPP TS 23.003 [19]) or the Set ID part within the SMF Set Identifier (see <Set Id> within the NF Set Identifier in clause 28.12 of 3GPP TS 23.003 [19]) or NF Instance Id of the SMF.

The SMF Set Identifier or the Set ID part within the SMF Set ID shall be included if the EASDF is controlled by the SMF set, or the NF Instance Id of the SMF shall be included if the EASDF is controlled by a SMF.

n/a

array(PatchItem)

M

1..N

It contains the list of changes to be made to the Baseline DNS pattern, according to the JSON PATCH format specified in IETF RFC 6902 [15].

PatchResult

M

1

200 OK

Upon partial success, e.g. some of the requested modifications for unknown attribute(s) are discarded while the rest of the modification instructions are fully accepted, the EASDF shall return the execution report.

n/a

204 No Content

Successful update of the Baseline DNS Pattern.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

n/a

BaseDnsPatternCreateData

M

1

Baseline DNS Pattern Data to be created or to replace the existing Baseline DNS Pattern data

DnsBasePatternCreatedData

M

1

201 Created

Successful creation of a Baseline DNS Pattern

n/a

204 No Content

Successful update of the Baseline DNS Pattern.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

n/a

n/a

n/a

204 No Content

Successful deletion of the Baseline DNS Pattern.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the Successful deletion of method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set, or same URI if this is a redirection triggered by an SCP towards the same target resource via another SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target EASDF (service) instance ID towards which the request is redirected

BaseDnsPatternCreateData

6.2.6.2.2

Data in Baseline DNS Pattern Create request

BaseDnsPatternCreatedData

6.2.6.2.3

Data in Baseline DNS Pattern Create response

BaselineDnsMdt

6.2.6.2.4

Baseline DNS message detection template

BaselineDnsAit

6.2.6.2.5

Baseline DNS action information Template

VarNfId

6.2.6.2.6

SMF or SMF Set Id or Set Id part in SMF set identifier

DnsQueryMdt

6.1.6.2.5

DNS Query Message Detection Template

DnsRspMdt

6.1.6.2.6

DNS Response Message Detection Template

EcsOption

6.1.6.2.12

ECS Option information

IpAddr

3GPP TS 29.571 [16]

IP address

NfSetId

3GPP TS 29.571 [16]

NF Set Id

NfInstanceId

3GPP TS 29.571 [16]

NF Instance Id

PatchResult

3GPP TS 29.571 [16]

label

string

O

0..1

Baseline DNS pattern’s label

(NOTE)

baseDnsMdtList

map(BaselineDnsMdt)

O

1..N

When present, this IE contains the map of DNS message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the baseline DNS Message Detection Template, with a maximum of 32 characters.

baseDnsAitList

map(BaselineDnsAit)

O

1..N

When present, this IE contains the map of Baseline DNS action information Templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the baseline DNS Message Detection Template, with a maximum of 32 characters.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported.

NOTE: This attribute may contain free information describing the scope of the baseline DNS pattern. It may be used e.g. for trouble-shooting.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported.

mdtId

string

M

1

Identifier of the DNS message detection template within the baseline DNS pattern, with a maximum of 32 characters.

label

string

O

0..1

Baseline DNS MDT’s label

(NOTE 2)

dnsQueryMdtList

map(DnsQueryMdt)

C

1..N

Map of DNS Query message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the DNS Query message detection template, with a maximum of 32 characters.

If present, only fqdnList attribute shall be included in the DNS Query message detection template.

(NOTE 1)

dnsRspMdtList

map(DnsRspMdt)

C

1..N

Map of DNS Response message detection templates.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the DNS Response message detection template, with a maximum of 32 characters.

(NOTE 1)

NOTE 1: Either the dnsQueryMdtList IE or the dnsRspMdtList IE shall be present.

NOTE 2: This attribute may contain free information describing the scope of the baseline DNS MDT. It may be used e.g. for trouble-shooting.

aitId

string

M

1

Identifier of the DNS message handling action within the baseline DNS pattern

label

string

O

0..1

Baseline DNS AIT’s label

(NOTE)

ecsOption

EcsOption

C

0..1

Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE.

dnsServerAddressList

array(IpAddr)

C

1..N

DNS Server Address to be used as destination address of the outgoing DNS Query More than one IP address may be provided for resiliency.

NOTE: This attribute may contain free information describing the scope of the baseline DNS AIT. It may be used e.g. for trouble-shooting.

smfSetId

NfSetId

C

0..1

This IE shall be present if available.

When present, this IE includes the SMF Set Id (NOTE)

setId

string

C

0..1

This IE shall be present if available.

When present, this IE includes Set Id part in NF Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]), formatted as the following string:

"set<Set ID>"

with

<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

Pattern: ‘^([A-Za-z0-9\-]*[A-Za-z0-9])$’

Examples:
"setxyz"

"set12"

(NOTE)

smfInstanceId

NfInstanceId

C

0..1

This IE shall be present if available.

When present, this IE includes SMF Instance Id (NOTE)

NOTE: Either smfSetId attribute or setId or smfInstanceId attribute shall be included.