Create a Service Profile

Create and manage resource profiles for your 5G Edge applications. You must create a resource profile before you can select nodes to host your application.

 

Create a service profile

Creates a profile that describes the resource needs of your 5G Edge application. You can use the serviceProfileId from the response to find the best 5G Edge nodes to host your application.

HTTP Request
 
POST https://5gedge.verizon.com/api/mec/eds/serviceprofiles
 
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

None

 

REQUEST BODY: application/json

Note: "GPU" is future functionality. Default values are listed below. 

 

  • Example request
    schema
    {
       "clientType": "V2X",
       "ecspFilter": "Verizon",
       "clientSchedule": "string",
       "clientServiceArea": "string",
       "networkResources": {
          "minBandwidthKbits": 1,
          "serviceContinuitySupport": true,
          "maxRequestRate": 1,
          "maxLatencyMs": 5,
          "minAvailability": 1
       },
       "computeResources": {
          "GPU": {
            "minCoreClockMHz": 1,
            "minMemoryClockMHz": 0,
            "minBandwidthGBs": 0,
            "minTFLOPS": 0
           },
           "minRAMGB": 1,
           "minStorageGB": 1
       },
       "properties": {
          "type": "string",
          "data": {}
       }
    }
    
Request Parameters
Parameter Description
clientType
required
The category of application client. Valid values are: V2X, ComputerVision, MachineLearning, IoT, Gaming, AR, VR, Analytics and Robotics.
ecspFilter Edge Computing Service Provider (ECSP) filter. This filter defines what MEC service providers are allowed to be used by the application.
clientSchedule The time period or periods the application will be active
clientServiceArea The region or regions the application is allowed to operate in.
minBandwidthKbits The minimum acceptable data network throughput for the application to function, measured in Kilobits per second.
serviceContinuitySupport If the client is subscribed to endpoint redundancy (True) or not (False) 
maxRequestRate The maximum number of application requests sent per second.
maxLatencyMs
required
The maximum allowable data latency for the application, measured in Milliseconds.  Note: This value must be submitted in multiples of 5 (i.e. if you are looking for 24ms then the value must be either 20ms or 25ms).
minAvailability The minimum acceptable amount of service availability, measured as a percentage.
minCoreClockMHz The minimum acceptable speed of the endpoint's processor, measured in Millions of Cycles per second.
minMemoryClockMHz The minimum acceptable speed of the endpoint's memory, measured in Millions of Cycles per second.
minBandwidthGBs The minimum acceptable data network throughput for the application to function, measured in Gigabits per second.
minTFLOPS The minimum acceptable data processing performance for the application to function, measured in Trillions of Floating-Point Operations per second (Terraflops).
minRAMGB The minimum acceptable amount of Random Access Memory available for the application to function, measured in Gigabytes.
minStorageGB The minimum acceptable amount of storage space available for the application to function, measured in Gigabytes.
properties Additional service support information for the MEC platform.
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

A successful request returns a serviceProfileId that you can use in subsequent requests.

  • Success response
    schema

    {

    "serviceProfileId": "string"
    }

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