EAS Registrations

/registrations

POST

Registers a new EAS at the Edge Enabler Server.

Individual EAS Registration

/registrations/{registrationId}

GET

Fetch an individual EAS registration resource.

PUT

Fully replace an individual EAS registration resource.

DELETE

Remove an individual EAS registration resource.

PATCH

Partially update an individual EAS registration resource.

apiRoot

string

See clause 7.5

n/a

EASRegistration

M

1

EAS registration request information.

EASRegistration

M

1

201 Created

EAS information is registered successfully at EES. EAS information registered with EES is provided in the response body.

The URI of the created resource shall be returned in the "Location" HTTP header.

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

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-easregistration/<apiVersion>/registrations/{registrationId}

apiRoot

string

See clause 7.5

registrationId

string

The EAS registration identifier.

n/a

n/a

EASResgistration

M

1

200 OK

The EAS registration information at the Edge Enabler Server.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

n/a

EASRegistration

M

1

Details of the EAS registration information to be updated

EASRegistration

M

1

200 OK

The EAS registration information updated successfully and the updated EAS registration information is returned in the response.

n/a

204 No Content

The EAS registration information was updated successfully.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

NOTE: The manadatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

n/a

n/a

n/a

204 No Content

The individual EAS registration information matching the registrationId is deleted.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

NOTE: The manadatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

n/a

EASRegistrationPatch

M

1

Details of the EAS registration information to be updated

EASRegistration

M

1

200 OK

The Individual EAS registration information was updated successfully and the updated EAS registration information is returned in the response.

n/a

204 No Content

The Individual EAS registration information was updated successfully.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6].

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

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

Location

string

M

1

An alternative URI of the resource located in an alternative EES.

EASRegistration

8.1.5.2.2

The EAS registration information on EES.

EASProfile

8.1.5.2.3

The profile information related to the EAS in the EASRegistration data type.

EASServiceKPI

8.1.5.2.4

Service characteristics provided by EAS, captured in EAS profile information.

EndPoint

8.1.5.2.5

The end point information of the Edge Application Server in the EAS profile.

EASRegistrationPatch

8.1.5.2.6

To partially update the EAS Registration information.

PermissionLevel

8.1.5.3.3

Used to indicate the level of service permissions supported by the EAS.

EASCategory

8.1.5.3.4

Used to indicate the category or type of the EAS.

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of optional features defined in table 8.1.7-1.

DateTime

3GPP TS 29.122 [6]

Used to capture the expiration time of EAS registration.

DateTimeRm

3GPP TS 29.571 [8]

Used to capture the expiration time EAS registration patch.

ScheduledCommunicationTime

3GPP TS 29.122 [6]

Used to define the schedule of EAS availability.

RouteToLocation

3GPP TS 29.571 [8]

Used to define the DNAIs associated with EAS and the corresponding N6 routing information for each EAS DNAI.

DurationSec

3GPP TS 29.122 [6]

Duration in seconds, used to define the availability reporting period for EES to check EAS availability.

LocationArea5G

3GPP TS 29.122 [6]

Used to defined the geographic and topological area served by EAS.

BitRate

3GPP TS 29.571 [8]

Used to express the connection bandwidth of EAS service KPI.

Ipv4Addr

3GPP TS 29.122 [6]

Identifying the IPv4 address of the Edge Application Server.

Ipv6Addr

3GPP TS 29.122 [6]

Identifying the IPv6 address of the Edge Application Server.

ServiceArea

Clause 9.1.5.2.5

Represents the topological and geographical service area information of the EAS.

Uinteger

3GPP TS 29.571 [8]

Used to express the maximum response time of EAS service KPI.

Fqdn

3GPP TS 29.571 [8]

Used to express the Fully Qualified Domain Name of EAS end point.

easProf

EASProfile

M

1

The profile information of the EAS.

expTime

DateTime

O

0..1

Identifies the expiration time for the EAS registration. If the expiration time is not present, then it indicates that the registration of EAS never expires.

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 7.8.

This attribute shall be provided in the HTTP POST request and in the response of successful resource creation.

easId

string

M

1

The application identifier of the EAS, e.g. URI, FQDN.

endPt

EndPoint

M

1

Endpoint information (URI, FQDN, IP address) used to communicate with the EAS. This information maybe discovered by EEC and exposed to ACs so that ACs can establish contact with the EAS.

acIds

array(string)

O

1..N

Identities of the Application Clients that can be served by the EAS

provId

string

O

0..1

Identifier of the ASP that provides the EAS.

type

EASCategory

O

0..1

The category or type of EAS.

scheds

array(ScheduledCommunicationTime)

O

1..N

The availability schedule of the EAS.

svcArea

ServiceArea

O

0..1

The list of geographical and topological areas that the EAS serves. ACs in the UE that are outside the area shall not be served.

svcKpi

EASServiceKPI

O

0..1

Service characteristics provided by the EAS.

permLvl

array(PermissionLevel)

O

1..N

Level of service permissions supported by the EAS.

easFeats

array(string)

O

1..N

Service specific features supported by the EAS (e.g. single vs multi-player gaming service).

svcContSupp

array(ACRScenario)

O

1..N

The ACR scenarios supported by the EAS for service continuity. If this attribute is not present, then the EAS does not support service continuity.

appLocs

array(RouteToLocation)

O

1..N

List of DNAI(s) and the corresponding N6 traffic routing information/routing profile ID, associated with the EAS.

It is a subset of the DNAI(s) associated with the EDN where the EAS resides.

avlRep

DurationSec

O

0..1

The period indicating to the EES, how often the EES needs to check the EAS’s availability after a successful registration.

status

string

O

0..1

EAS status (e.g. Enabled, Disabled etc.)

maxReqRate

Uinteger

O

0..1

Maximum request rate from the Application Client supported by the EAS. The minimum and maximum value shall be 0 and 100 respectively.

maxRespTime

Uinteger

O

0..1

The maximum response time, in the units of milliseconds, advertised for the AC’s service requests. This includes the round trip time of the request and response packet, the processing time at the EAS and time required by EAS to consume any 3GPP core network capabilities.

avail

Uinteger

O

0..1

Advertised percentage of time the server is available for the AC’s use. The minimum and maximum value shall be 0 and 100 respectively.

avlComp

Uinteger

O

0..1

The maximum compute resource available for the AC.

avlGraComp

Uinteger

O

0..1

The maximum graphical compute resource available for the AC.

avlMem

Uinteger

O

0..1

The maximum memory resource available for the AC.

avlStrg

Uinteger

O

0..1

The maximum storage resource available for the AC.

connBand

BitRate

O

0..1

The connection bandwidth in Kbit/s advertised for the AC’s use.

fqdn

Fqdn

O

0..1

Fully Qualified Domain Name of the Edge server. (NOTE)

ipv4Addrs

array(Ipv4Addr)

O

1..N

IPv4 addresses of the Edge server. (NOTE)

ipv6Addrs

array(Ipv6Addr)

O

1..N

IPv6 addresses of the Edge server. (NOTE)

uri

Uri

O

0..1

URI information of the Edge server (NOTE)

NOTE: At least one of the addressing parameters (fqdn, ipv4Addrs, ipv6Addrs, uri attributes) shall be included.

easProf

EASProfile

O

0..1

The profile information of the EAS.

expTime

DateTimeRm

O

0..1

Identifies the expiration time for the EAS registration. If the expiration time is not present, then it indicates that the registration of EAS never expires.

TRIAL

Level of service permission supported is TRIAL.

GOLD

Level of service permission supported is GOLD.

SILVER

Level of service permission supported is SILVER.

OTHER

Any other level of service permissions supported.

UAS

Category of EAS is for Uncrewed Aerial Services.

V2X

Category of EAS is for V2X Services.

OTHER

Any other type of EAS category