Jump to: navigation, search

Difference between revisions of "Meteos/API"

(→‎API (TBD))
(→‎API (TBD))
Line 3: Line 3:
 
=== Experiment Template ===
 
=== Experiment Template ===
  
−
* Create Experiment Template
+
==== Create Experiment Template ====
−
** POST /v1/<tenant_id>/templates
+
* POST /v1/<tenant_id>/templates
 +
'''Request'''
 +
<pre>
 +
{
 +
    "template": {
 +
        "display_description": "This is a sample template of experiment",
 +
        "display_name": "example-template",
 +
        "floating_ip_pool": "56a30dc6-79d9-422d-94ba-cd4dbceea9a4",
 +
        "image_id": "9692f7a3-7dfa-4b8c-904c-4f4be3d1ebe7",
 +
        "master_flavor_id": "4",
 +
        "master_nodes_num": 1,
 +
        "spark_version": "1.6",
 +
        "worker_flavor_id": "2",
 +
        "worker_nodes_num": 2
 +
    }
 +
}
 +
</pre>
 +
'''Response'''
 +
<pre>
 +
{
 +
    "template": {
 +
        "cluster_id": null,
 +
        "created_at": "2016-11-30T06:13:07.000000",
 +
        "description": "This is a sample template of experiment",
 +
        "id": "aea85a97-ea67-4717-93ae-54b7c5cd6492",
 +
        "master_flavor": "4",
 +
        "master_nodes": 1,
 +
        "name": "example-template",
 +
        "project_id": "475312c52eb941d3ab072fba9271d9c1",
 +
        "spark_version": "1.6",
 +
        "status": "available",
 +
        "user_id": "511c049d52524ba9b14b0ff33867d3b8",
 +
        "worker_flavor": "2",
 +
        "worker_nodes": 2
 +
    }
 +
}
 +
</pre>
  
−
* List Experiment Templates
+
====  List Experiment Templates ====
−
** GET /v1/<tenant_id>/templates
+
* GET /v1/<tenant_id>/templates
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Show Experiment Template
+
====  Show Experiment Template ====
−
** GET /v1/<tenant_id>/templates/<template_id>
+
* GET /v1/<tenant_id>/templates/<template_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
 
   
 
   
−
* Delete Experiment Template
+
====  Delete Experiment Template ====
−
** DELETE /v1/<tenant_id>/templates/<template_id>  
+
* DELETE /v1/<tenant_id>/templates/<template_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
 
=== Experiment ===
 
=== Experiment ===
  
−
* Create Experiment
+
==== Create Experiment ====
−
** POST /v1/<tenant_id>/experiments
+
* POST /v1/<tenant_id>/experiments
 +
'''Request'''
 +
<pre>
 +
</pre>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* List Experiments
+
====  List Experiments ====
−
** GET /v1/<tenant_id>/experiments
+
* GET /v1/<tenant_id>/experiments
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Show Experiment
+
====  Show Experiment ====
−
** GET /v1/<tenant_id>/experiments/<experiment_id>
+
* GET /v1/<tenant_id>/experiments/<experiment_id>
−
   
+
'''Response'''
−
* Delete Experiment
+
<pre>
−
** DELETE /v1/<tenant_id>/experiments/<experiment_id>  
+
</pre>
 +
 
 +
==== Delete Experiment ====
 +
* DELETE /v1/<tenant_id>/experiments/<experiment_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
 
=== Data Set ===
 
=== Data Set ===
  
−
* Create Data Set (Download)
+
====  Create Data Set (Download) ====
−
** POST /v1/<tenant_id>/datasets
+
* POST /v1/<tenant_id>/datasets
 +
'''Response'''
 +
<pre>
 +
</pre>
 +
 
 +
====  Create Data Set (Parse) ====
 +
* POST /v1/<tenant_id>/datasets
 +
'''Request'''
 +
<pre>
 +
</pre>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Create Data Set (Parse)
+
====  List Data Sets ====
−
** POST /v1/<tenant_id>/datasets
+
* GET /v1/<tenant_id>/datasets
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* List Data Sets
+
====  Show Data Sets ====
−
** GET /v1/<tenant_id>/datasets
+
* GET /v1/<tenant_id>/datasets/<dataset_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Show Data Sets
+
====  Delete Data Set ====
−
** GET /v1/<tenant_id>/datasets/<dataset_id>
+
* DELETE /v1/<tenant_id>/datasets/<dataset_id>  
−
+
'''Response'''
−
* Delete Data Set
+
<pre>
−
** DELETE /v1/<tenant_id>/datasets/<dataset_id>  
+
</pre>
  
 
=== Prediction Model ===
 
=== Prediction Model ===
  
−
* Create Prediction Model
+
====  Create Prediction Model ====
−
** POST /v1/<tenant_id>/models
+
* POST /v1/<tenant_id>/models
 +
'''Request'''
 +
<pre>
 +
</pre>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* List Prediction Models
+
====  List Prediction Models ====
−
** GET /v1/<tenant_id>/models
+
* GET /v1/<tenant_id>/models
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Show Model
+
====  Show Model ====
−
** GET /v1/<tenant_id>/models/<moded_id>  
+
* GET /v1/<tenant_id>/models/<moded_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Delete Model
+
====  Delete Model ====
−
** DELETE /v1/<tenant_id>/models/<model_id>
+
* DELETE /v1/<tenant_id>/models/<model_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
 
=== Learning Job ===
 
=== Learning Job ===
  
−
* Create Learning Job
+
====  Create Learning Job ====
−
** POST /v1/<tenant_id>/jobs
+
* POST /v1/<tenant_id>/jobs
 +
'''Request'''
 +
<pre>
 +
</pre>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* List Learning Jobs
+
====  List Learning Jobs ====
−
** GET /v1/<tenant_id>/jobs
+
* GET /v1/<tenant_id>/jobs
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Show Learning Job
+
====  Show Learning Job ====
−
** GET /v1/<tenant_id>/jobs/<job_id>
+
* GET /v1/<tenant_id>/jobs/<job_id>
 +
'''Response'''
 +
<pre>
 +
</pre>
  
−
* Delete Learning Job
+
====  Delete Learning Job ====
−
** DELETE/v1/<tenant_id>/jobs/<job_id>
+
* DELETE/v1/<tenant_id>/jobs/<job_id>
 +
'''Response'''
 +
<pre>
 +
</pre>

Revision as of 06:22, 30 November 2016

API (TBD)

Experiment Template

Create Experiment Template

  • POST /v1/<tenant_id>/templates

Request 

{
    "template": {
        "display_description": "This is a sample template of experiment", 
        "display_name": "example-template", 
        "floating_ip_pool": "56a30dc6-79d9-422d-94ba-cd4dbceea9a4", 
        "image_id": "9692f7a3-7dfa-4b8c-904c-4f4be3d1ebe7", 
        "master_flavor_id": "4", 
        "master_nodes_num": 1, 
        "spark_version": "1.6", 
        "worker_flavor_id": "2", 
        "worker_nodes_num": 2
    }
}

Response 

{
    "template": {
        "cluster_id": null, 
        "created_at": "2016-11-30T06:13:07.000000", 
        "description": "This is a sample template of experiment", 
        "id": "aea85a97-ea67-4717-93ae-54b7c5cd6492", 
        "master_flavor": "4", 
        "master_nodes": 1, 
        "name": "example-template", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "spark_version": "1.6", 
        "status": "available", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8", 
        "worker_flavor": "2", 
        "worker_nodes": 2
    }
}

List Experiment Templates

  • GET /v1/<tenant_id>/templates

Response 



Show Experiment Template


  •  GET /v1/<tenant_id>/templates/<template_id>


Response





Delete Experiment Template


  •  DELETE /v1/<tenant_id>/templates/<template_id> 


Response





Experiment


Create Experiment


  •  POST /v1/<tenant_id>/experiments


Request





Response





List Experiments


  •  GET /v1/<tenant_id>/experiments


Response





Show Experiment


  •  GET /v1/<tenant_id>/experiments/<experiment_id>


Response



 

Delete Experiment


  •  DELETE /v1/<tenant_id>/experiments/<experiment_id> 


Response





Data Set


Create Data Set (Download)


  •  POST /v1/<tenant_id>/datasets


Response





Create Data Set (Parse)


  •  POST /v1/<tenant_id>/datasets


Request





Response





List Data Sets


  •  GET /v1/<tenant_id>/datasets


Response





Show Data Sets


  •  GET /v1/<tenant_id>/datasets/<dataset_id>


Response





Delete Data Set


  •  DELETE /v1/<tenant_id>/datasets/<dataset_id> 


Response





Prediction Model


Create Prediction Model


  •  POST /v1/<tenant_id>/models


Request





Response





List Prediction Models


  •  GET /v1/<tenant_id>/models


Response





Show Model


  •  GET /v1/<tenant_id>/models/<moded_id> 


Response





Delete Model


  •  DELETE /v1/<tenant_id>/models/<model_id>


Response





Learning Job


Create Learning Job


  •  POST /v1/<tenant_id>/jobs


Request





Response





List Learning Jobs


  •  GET /v1/<tenant_id>/jobs


Response





Show Learning Job


  •  GET /v1/<tenant_id>/jobs/<job_id>


Response





Delete Learning Job


  •  DELETE/v1/<tenant_id>/jobs/<job_id>


Response









          

                

                
        

        Retrieved from "https://wiki.openstack.org/w/index.php?title=Meteos/API&oldid=143509"