Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.46 KB

A1_ENDPOINTS.md

File metadata and controls

109 lines (81 loc) · 3.46 KB
Raw

REST Endpoints

⚠ The endpoints of the ELCM are not expected to be exposed to the Internet and may leak information. For user management and authorization always use a different front-end, such as the Dispatcher.

Experiment management endpoints

[POST] /experiment/run

[POST] /api/v0/run (Deprecated)

Creates and queues a new experiment execution, based on the contents of the received Experiment Descriptor (JSON). Replies with the following response JSON:

{ “ExecutionId”: <id> }

Where is a unique execution identification that can be used as input in other endpoints.

[GET] /execution/<id>/status

[GET] /execution/<id>/json (Deprecated)

Returns a JSON that contains general information about the status of the selected execution id, with the following format:

{ “Coarse”: <Global status or current stage of execution>,
  “Status”: <Global status or status within the current stage>,
  “PerCent”: <Percentage of completion of current stage>,
  “Messages”: <List of global messages generated by the execution>,
  “Verdict”: <Current or final verdict of the execution> }

[GET] /execution/<id>/logs

Returns a JSON that contains all the log messages generated by the execution, separated by stage:

{ “Status”: <Either “Success” or “Not Found”>,
  “PreRun”: <Messages generated during Pre-Run stage>,
  “Executor”: <Messages generated during the Run stage>,
  “PostRun”: <Messages generated during Post-Run stage> }

[GET] /execution/<id>/results

Returns a compressed file that includes the logs and all files generated by the experiment execution.

[GET] /execution/<id>/descriptor

Returns a copy of the Experiment Descriptor that was used to define the execution.

[GET] '/execution//kpis'

Returns a dictionary with a single KPIs key, containing a list of pairs (measurement, kpi) that are considered of interest.

These values can be used as part of queries to the Analytics Module, in order to extract a sub-set of important KPIs from all the generated measurements.

[DELETE] /execution/<id>

[GET] /execution/<id>/cancel (Deprecated)

Marks the selected execution for cancellation. The execution will be cancelled after finalization of the current task.

Facility information

[GET] /facility/baseSliceDescriptors

Returns a list of available Base Slice Descriptors, with the following format:

{ "SliceDescriptors": [] }

[GET] /facility/testcases

Returns a list of available UEs, with the following format:

{
  "TestCases": [
    {
      "Name": <Name of the TestCase>,
      "Distributed": <Boolean>,
      "Standard": <Boolean, indicates if the experiment can be executed without additional parameters>,
      "PublicCustom": <Boolean, indicates if the experiment can be customized by any user>,
      "PrivateCustom": <List of emails, of the users allowed to customize the experiment>,
      "Parameters": <List of configurable parameters of the experiment>
    }, ...
  ]
}

[GET] /facility/ues

Returns a list of available UEs, with the following format:

{ "UEs": [] }

[GET] /facility/resource_status

Returns a list of available Resources, separated by current usage status:

{ "Busy": [],
  "Idle": [] }

[GET] /facility/scenarios

Returns a list of available Scenarios, with the following format:

{ "Scenarios": [] }