Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7
typeflat

This API creates a data lake for the user to use. Define the Tag of the data lake to be created, its extended columns and Values, and its definite columns. And, don't forget to design well in advance because the data structure determined in this way cannot be changed. The last created Data Lake incurs an immediate cost, so call it with caution.

HTTP Request

Paste code macro
languagehttp
themeSunburst
POST https://api.machlake.com/lakes
Content-Type: application/json; charset=utf8
x-api-key: {API Key}
  
{
    "lake_info"    : {
        "lake_name"    : "{lake_name}",
        "lake_tier"    : "{lake_tier}",
        "lake_type"    : "{lake_type}",
        "owner"        : "{owner}" 
    },
    "tag_schema"   : [
       {
        "col_name"   : "{column name}",
        "col_type"   : "{column type}",
        "col_length" : "{column length}"
       },
       ......
    ],
    "value_schema" : [
       {
        "col_name"   : "{column name}",
        "col_type"   : "{column type}",
        "col_length" : "{column length}"
       },
       ......
    ]
}

Parameters

...

Prerequisites

...

Key

...

Type

...

Description

...

lake_name

...

string

...

lake name

...

lake_type

...

string

...

Type of Lake

N or M, Can be omitted

(N when omitted)

...

lake_tier

...

string

...

free / basic / small / enterprise

...

owner

...

string

...

Lake's Owner

(When omitted, the user who calls the API)

...

Optional

...

Key

...

Type

...

Description

...

tag_schema

...

JSON

...

additional columns for this lake's Tag meta col_name : column name col_type : column type (long or string) col_length : if string type, assign length

...

value_schema

...

JSON

...

additional columns for this lake's Tag Table col_name : column name col_type : column type (long or string) col_length : if string type, assign length

Request Example

Paste code macro
languagejson
themeSunburst
POST https://api.machlake.com/lakes
Content-Type: application/json; charset=utf8
x-api-key: {API Key}
  
{
    "lake_info"    : {
        "lake_name"    : "My Lake",
        "lake_tier"    : "free",
        "lake_type"    : "N",
        "owner"        : "user01"
    },
    "tag_schema"   : [
       {
        "col_name"   : "corr-X",
        "col_type"   : "long"
       }
    ],
    "value_schema" : [
       {
        "col_name"   : "testcol",
        "col_type"   : "string",
        "col_length" : 128
       }
    ]
}

Response Example

...

languagejson
themeSunburst

...

is a risky function that can lost all data and is not provided as an API. Instead, it is designed to drop directly from the user management page.