Find Edge Application Service Endpoints

 

After registering the routable endpoints of your deployed application, use service endpoint discovery to find the optimal service endpoints for application clients to connect to for each session.

 

Get Service Endpoints

Returns a list of optimal Service Endpoints that client devices can connect to. You can search based on service profile, region, subscriber density, or user equipment identity.

HTTP Request

 

GET https://5gedge.verizon.com/api/mec/eds/serviceendpoints

 

See also:
 
POST /serviceendpoints - Register service endpoints
 
 

HEADER PARAMETERS: application/json

The request header must contain a current ThingSpace authorization bearer token and must set the content-type to JSON. For more information about tokens, see Getting Started

 

QUERY PARAMETERS: application/json

Note: If a query is sent with all of the parameters, it will fail with a "400" error. 

Search with the following combinations: 

  • region + service endpoints IDs + subscriber density (density is optional but recommended) 
  • region + service endpoints ID + UEIdentity (including UEIdentity Type)
  • service endpoints IDs + UEIdentity (including UEIdentity Type)
  • region
    string

    The Region name of a Multi-access Edge Compute (MEC) region. Current valid regions are US_WEST_2 and US_EAST_1.

    Note: using US_WEST_1 or US_EAST_2 will cause a 500 error.

  • subscriberDensity
    integer

    Minimum number of subscribers in a region

  • UEIdentityType
    string

    Type of User Equipment identifier used in UEIdentity

    Note: Currently IPAddress is the only valid value

  • UEIdentity
    string

    The User Equipment identifier used for the query. This can be in IPv4 or IPv6 format for IP Address

  • serviceEndpointsIds
    string

    A unique identifier for a service endpoint.

PATH PARAMETERS: application/json

None

 

REQUEST BODY: application/json

None

 

Responses

Note: For cases where user input exceeds the boundary values an additional "data" key will be returned with a relevant description. The error response returns an additional data key value beyond the error values listed here. 

 

RESPONSE BODY SCHEMA: application/json

  • Success response
    schema
    {
      "serviceEndpoints": [
        {
          "ern": "string",
          "serviceEndpoint": {
            "URI": "string",
            "FQDN": "string",
            "IPv4Address": "198.51.100.42",
            "IPv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
            "port": 0
          },
          "applicationServerProviderId": "AWS",
          "applicationId": "string",
          "serviceDescription": "string"
        }
      ]
    }
    
Response Parameters
Parameter Description
ern An Edge Resource Name. This is the identifier for an Edge Resource to use as a connection.
URI Universal Resouce Identifier. Not to be confused with Universal Resource Locator (URL), which is how to get to the resource identified.
FQDN Fully Qualified Domain Name. The entire URL, including http or https. In EDS service registry APIs, the customer calling the API needs to set FQDN for their edge app server endpoint.
IPv4Address The 32-bit IPv4 address of the service endpoint.
IPv6Address The 256-bit IPv6 address of the service endpoint.
port The HTTP port to use for the service endpoint.
applicationServerProviderId The ID of the Cloud Service Provider (CSP) hosting the application. Currently the only accepted value is "AWS".
applicationId The assigned name of the application hosted that will be using the service endpoint.
serviceDescription Details about the service parameters supported by the service endpoint (i.e. latency).

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details