List Lake

This API returns a list of data lakes currently being used by the user. This list contains only brief information, please call the View Lake API to get more detailed information.

HTTP Request

GET https://${CloudVendor}.${CountryCode}.machlake.com/lakes

Parameters

no parameters

Request Example

GET https://aws1.us.machlake.com/lakes/
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

Response Example

Status 200

{
    "lake": [
        {
            "lake_id": "lake01",
            "lake_info": {
                "lake_name": "My Lake1",
                "lake_plan": "basic",
                "region"   : "us-west-1",
                "timezone" : "America/Los_Angeles"
            }
        },
        {
            "lake_id": "lake02",
            "lake_info": {
                "lake_name": "My Lake2",
                "lake_plan": "enterprise",
                "region"   : "ap-northeast-2",
                "timezone" : "Asia/Seoul"
            }
        }
    ]
}

Sample Code

window(batch)

github

chcp 65001 
:: Text Encoding to UTF-8 in CMD
:: Example For Get Lake List API by using curl in window script
:: written by yeony kim

set API_KEY=YOUR_API_TOKEN

set CONTENT_HEADER="Content-Type: application/json"
set API_HEADER="x-api-key: %API_KEY%"

set URL=https://api.machlake.com/lakes

:: ------------------------------------------------------------------------------------------------- ::

:: CASE - GET LAKE List

curl -k -X GET %URL% -H %CONTENT_HEADER% -H %API_HEADER%

:: Return Format
:: {"data":{"lake":[{"lake_id":"YOUR_LAKE_ID","lake_info":{"lake_name":"sample_lake","lake_plan":"basic","region":"ap-northeast-2","timezone":"Asia/Seoul"}}],"mount":[],"share":[]},"status":"success"}

linux(shell)

github

# Text Encoding to UTF-8 in CMD
# Example For Get Lake List API by using curl in shell script
# written by yeony kim

API_KEY=YOUR_API_TOKEN

CONTENT_HEADER="Content-Type:application/json"
API_HEADER="x-api-key:$API_KEY"

URL=https://api.machlake.com/lakes

# ------------------------------------------------------------------------------------------------- #

# CASE - GET LAKE List

curl -k -X GET $URL -H $CONTENT_HEADER -H $API_HEADER

# Return Format
# {"data":{"lake":[{"lake_id":"YOUR_LAKE_ID","lake_info":{"lake_name":"sample_lake","lake_plan":"basic","region":"ap-northeast-2","timezone":"Asia/Seoul"}}],"mount":[],"share":[]},"status":"success"}

javascript

github

// Example For Get Lake List API by using request in nodejs
// written by yeony kim

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

const express = require('express');
const app = express();
const API_KEY = "YOUR_API_TOKEN";
const URL = "https://api.machlake.com/lakes"

// CASE - GET LAKE List

app.get(
    '/get_lake_list', function(req, res) {
        var request = require('request');
        var option = {
            url: URL,
            headers: {
                'Content-Type': 'application/json',
                'x-api-key': API_KEY
            },
        };
        request.get( option, function(error, response, body) {
            if (!error) {
                res.writeHead(200);
                res.end(body);
                console.log(body) // {"data":{"lake":[{"lake_id":"YOUR_LAKE_ID","lake_info":{"lake_name":"sample_lake","lake_plan":"basic","region":"ap-northeast-2","timezone":"Asia/Seoul"}}],"mount":[],"share":[]},"status":"success"}
            } else {
                console.log(error)
            }
        })
    }
)

app.listen(8888, function() {
    console.log('http://127.0.0.1:8888/get_lake_list is result for get LAKE list')
})

python

github

"""
Example For Get Lake List API by using request in python
written by yeony kim
"""

import requests

API_KEY = "YOUR_API_TOKEN"
URL = f"https://api.machlake.com/lakes"

# CASE - GET LAKE List

headers = {
    'Content-Type': 'application/json',
    'x-api-key': API_KEY
}

response = requests.get(URL, headers=headers, verify=False)
print(response.content.decode('utf-8'))  # {"data":{"lake":[{"lake_id":"YOUR_LAKE_ID","lake_info":{"lake_name":"sample_lake","lake_plan":"basic","region":"ap-northeast-2","timezone":"Asia/Seoul"}}],"mount":[],"share":[]},"status":"success"}