Jump to: navigation, search

Meteos/API

API

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 

{
    "templates": [
        {
            "description": "This is a sample template of experiment", 
            "id": "8e6f12ac-a08c-4ec5-996f-9be06c357cfb", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/templates/....", 
                    "rel": "self"
                }, 
                {
                    "href": "/475312c52eb941d3ab072fba9271d9c1/templates/....", 
                    "rel": "bookmark"
                }
            ], 
            "master_nodes": 1, 
            "name": "example-template", 
            "spark_version": "1.6", 
            "status": "available", 
            "worker_nodes": 5
        }, 
        {
            "description": "This is a sample template of experiment", 
            "id": "aea85a97-ea67-4717-93ae-54b7c5cd6492", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/templates/....", 
                    "rel": "self"
                }, 
                {
                    "href": "475312c52eb941d3ab072fba9271d9c1/templates/....", 
                    "rel": "bookmark"
                }
            ], 
            "master_nodes": 1, 
            "name": "example-template", 
            "spark_version": "1.6", 
            "status": "available", 
            "worker_nodes": 2
        }
    ]
}

Show Experiment Template

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

Response 

{
    "template": {
        "cluster_id": null, 
        "created_at": "2016-11-30T06:23:29.000000", 
        "description": "This is a sample template of experiment", 
        "id": "8e6f12ac-a08c-4ec5-996f-9be06c357cfb", 
        "master_flavor": "5", 
        "master_nodes": 1, 
        "name": "example-template", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "spark_version": "1.6", 
        "status": "available", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8", 
        "worker_flavor": "4", 
        "worker_nodes": 5
    }
}

Delete Experiment Template

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

Experiment

Create Experiment

  • POST /v1/<tenant_id>/experiments

Request 

{
    "experiment": {
        "display_description": "This is a sample experiment", 
        "display_name": "example-experiment", 
        "key_name": "key1", 
        "neutron_management_network": "fada8863-56b7-461b-b647-9334500c25df", 
        "template_id": "aea85a97-ea67-4717-93ae-54b7c5cd6492"
    }
}

Response 

{
    "experiment": {
        "created_at": "2016-11-30T06:38:12.000000", 
        "description": "This is a sample experiment", 
        "id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
        "key_name": "key1", 
        "management_network": "fada8863-56b7-461b-b647-9334500c25df", 
        "name": "example-experiment", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

List Experiments

  • GET /v1/<tenant_id>/experiments

Response 

{
    "experiments": [
        {
            "created_at": "2016-11-30T06:38:12.000000", 
            "description": "This is a sample experiment", 
            "id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/experiments/....", 
                    "rel": "self"
                }, 
                {
                    "href": "/475312c52eb941d3ab072fba9271d9c1/experiments/....", 
                    "rel": "bookmark"
                }
            ], 
            "name": "example-experiment", 
            "status": "creating"
        }
    ]
}

Show Experiment

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

Response 

{
    "experiment": {
        "created_at": "2016-11-30T06:38:12.000000", 
        "description": "This is a sample experiment", 
        "id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
        "key_name": "key1", 
        "management_network": "fada8863-56b7-461b-b647-9334500c25df", 
        "name": "example-experiment", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Delete Experiment

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

Data Set

Create Data Set (Download)

  • POST /v1/<tenant_id>/datasets

Request 

{
    "dataset": {
        "created_at": "2016-11-30T06:54:08.000000", 
        "description": "This is a sample dataset", 
        "head": null, 
        "id": "da6131ae-783f-45b5-a3eb-56050f0eed46", 
        "name": "sample-data", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "stderr": null, 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Response 

{
    "dataset": {
        "created_at": "2016-11-30T06:57:28.000000", 
        "description": "This is a sample dataset", 
        "head": null, 
        "id": "9fd54ac9-2da4-4c56-b8f1-fc05fda635b2", 
        "name": "sample-data", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "stderr": null, 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Create Data Set (Parse)

  • POST /v1/<tenant_id>/datasets

Request 

{
    "dataset": {
        "display_description": "This is a sample dataset", 
        "display_name": "sample-data", 
        "experiment_id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
        "method": "parse", 
        "params": "W3t1J2FyZ3MnOiB1ImxhbWJkYSBsOiBsLnNwbGl0KCcsJylbMF0gIT0gJzAnIiwgdSdtZXRob2QnOiB1J2ZpbHRlcid9XQ==", 
        "source_dataset_url": "swift://meteos/linear_data.txt", 
        "swift_password": "nova", 
        "swift_tenant": "demo", 
        "swift_username": "demo"
    }
}

Response 

{
    "dataset": {
        "created_at": "2016-11-30T06:59:29.000000", 
        "description": "This is a sample dataset", 
        "head": null, 
        "id": "2e0f4d7a-8cbc-4bb7-aeb6-6c4adbbd36d9", 
        "name": "sample-data", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "stderr": null, 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

List Data Sets

  • GET /v1/<tenant_id>/datasets

Response 

{
    "datasets": [
        {
            "created_at": "2016-11-30T06:54:08.000000", 
            "description": "This is a sample dataset", 
            "id": "da6131ae-783f-45b5-a3eb-56050f0eed46", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/datasets/....", 
                    "rel": "self"
                }, 
                {
                    "href": "/475312c52eb941d3ab072fba9271d9c1/datasets/....", 
                    "rel": "bookmark"
                }
            ], 
            "name": "sample-data", 
            "source_dataset_url": "swift://meteos/linear_data.txt", 
            "status": "creating"
        }
    ]
}

Show Data Sets

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

Response 

{
    "dataset": {
        "created_at": "2016-11-30T06:57:28.000000", 
        "description": "This is a sample dataset", 
        "head": "[u'500000,1,10,2016,6,0,68,50', u'500000,1,10,2016,6,0,68,50', u'550000,2,10,2016,0,1,68,90', u'550000,2,10,2016,0,1,68,90', u'300000,3,10,2016,1,0,60,55', u'300000,3,10,2016,1,0,60,55', u'350000,4,10,2016,2,2,58,87', u'0,5,10,2016,3,3,58,60', u'400000,6,10,2016,4,3,60,60', u'330000,7,10,2016,5,2,62,87']
", 
        "id": "9fd54ac9-2da4-4c56-b8f1-fc05fda635b2", 
        "name": "sample-data", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "available", 
        "stderr": "", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Delete Data Set

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

Prediction Model

Create Prediction Model

  • POST /v1/<tenant_id>/models

Request 

{
    "model": {
        "experiment_id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
        "model_params": "eydudW1JdGVyYXRpb25zJzogMSwgJ2Rlc2lyZWRfb3V0cHV0JzowfQ==", 
        "model_type": "LinearRegression", 
        "source_dataset_url": "swift://meteos/linear_data.txt", 
        "swift_password": "nova", 
        "swift_tenant": "demo", 
        "swift_username": "demo"
    }
}

Response 

{
    "model": {
        "created_at": "2016-11-30T07:03:33.000000", 
        "description": null, 
        "id": "c8707239-ae83-40c8-9d1b-273981ba209d", 
        "name": null, 
        "params": "eydudW1JdGVyYXRpb25zJzogMSwgJ2Rlc2lyZWRfb3V0cHV0JzowfQ==", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "stderr": null, 
        "stdout": null, 
        "type": "LinearRegression", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

List Prediction Models

  • GET /v1/<tenant_id>/models

Response 

{
    "models": [
        {
            "created_at": "2016-11-30T07:03:33.000000", 
            "description": null, 
            "id": "c8707239-ae83-40c8-9d1b-273981ba209d", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/models/....", 
                    "rel": "self"
                }, 
                {
                    "href": "/475312c52eb941d3ab072fba9271d9c1/models/....", 
                    "rel": "bookmark"
                }
            ], 
            "name": null, 
            "source_dataset_url": "swift://meteos/linear_data.txt", 
            "status": "available", 
            "type": "LinearRegression"
        }
    ]
}

Show Model

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

Response 

{
    "model": {
        "created_at": "2016-11-30T07:03:33.000000", 
        "description": null, 
        "id": "c8707239-ae83-40c8-9d1b-273981ba209d", 
        "name": null, 
        "params": "eydudW1JdGVyYXRpb25zJzogMSwgJ2Rlc2lyZWRfb3V0cHV0JzowfQ==", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "available", 
        "stderr": "", 
        "stdout": "", 
        "type": "LinearRegression", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Delete Model

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

Learning Job

Create Learning Job

  • POST /v1/<tenant_id>/jobs

Request 

{
    "learning": {
        "args": "MTEsMTAsMjAxNiwyLDAsNjcsODA=", 
        "display_description": "This is a sample job", 
        "display_name": "example-learning-job", 
        "experiment_id": "b45fb6a9-6f93-4e4b-93ec-0b128927b62d", 
        "method": "predict", 
        "model_id": "27032fe5-cb88-42bc-a753-f6a1359d629e"
    }
}

Response 

{
    "learning": {
        "args": "MTEsMTAsMjAxNiwyLDAsNjcsODA=", 
        "created_at": "2016-11-30T07:16:17.000000", 
        "description": "This is a sample job", 
        "id": "e3b205bc-0292-48a9-a7f9-76c77bbf02a4", 
        "method": "predict", 
        "name": "example-learning-job", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "creating", 
        "stderr": null, 
        "stdout": null, 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

List Learning Jobs

  • GET /v1/<tenant_id>/jobs

Response 

{
    "learnings": [
        {
            "args": "MTEsMTAsMjAxNiwyLDAsNjcsODA=", 
            "description": "This is a sample job", 
            "id": "e3b205bc-0292-48a9-a7f9-76c77bbf02a4", 
            "links": [
                {
                    "href": "/v1/475312c52eb941d3ab072fba9271d9c1/learnings/....", 
                    "rel": "self"
                }, 
                {
                    "href": "/475312c52eb941d3ab072fba9271d9c1/learnings/....", 
                    "rel": "bookmark"
                }
            ], 
            "name": "example-learning-job", 
            "status": "available", 
            "stdout": "233730.600776", 
            "type": "LinearRegression"
        }
    ]
}

Show Learning Job

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

Response 

{
    "learning": {
        "args": "MTEsMTAsMjAxNiwyLDAsNjcsODA=", 
        "created_at": "2016-11-30T07:16:17.000000", 
        "description": "This is a sample job", 
        "id": "e3b205bc-0292-48a9-a7f9-76c77bbf02a4", 
        "method": "predict", 
        "name": "example-learning-job", 
        "project_id": "475312c52eb941d3ab072fba9271d9c1", 
        "status": "available", 
        "stderr": "", 
        "stdout": "233730.600776", 
        "user_id": "511c049d52524ba9b14b0ff33867d3b8"
    }
}

Delete Learning Job

  • DELETE/v1/<tenant_id>/jobs/<job_id>
Retrieved from "https://wiki.openstack.org/w/index.php?title=Meteos/API&oldid=144746"