Please note: There has been a schema change as of Feb 18th, 2022 that is not backwards compatible with the previous schema. Please update your instances.

Find Registered Service Endpoints

Returns endpoint information for all Service Endpoints registered to a specified serviceEndpointId.

 

Get registered service endpoints

Returns the registered service endpoint information for a 5G Edge service.

HTTP Request
 
GET https://5gedge.verizon.com/api/mec/eds/serviceendpoints/{serviceEndpointsId}
 
See also:

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

None

 

PATH PARAMETERS: application/json

Get all the registered Service Endpoints associated with a Service Endpoint ID.

 

  • serviceEndpointsId
    required
    string

    The Service Endpoint ID being queried 

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

Each endpoint is described by these properties:

 

  • Success response
    schema
    [{
                "serviceEndpoint": 
                {   "FQDN": "thingtest.verizon.com", 
                    "IPv4Address": "192.168.11.10", 
                    "IPv6Address": "2001:0db8:85a3:0000:0000:8a2e:0370:1234", 
                    "port": 1234, 
                    "URI": "http://base_path/some_segment/id"
                },
                "applicationId": "IogspaceFEB040902", 
                "serviceDescription": "ThieIt", 
                "applicationServerProviderId": "AWS", 
                 "ern": "us-east-1-wl1-atl-wlz-1",
                "serviceProfileID" : "Service profile ID"
            
        }
    ]
    
Response Parameters
Parameter Description
ern An Edge Resource Name. This is the identifier for an Edge Resource to use as a connection.
serviceProfileID A unique identifier for a service profile.
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