View Source

note

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://api.machlake.com/v1/lakes
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

Parameters

no parameters

Request Example

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

Response Example

Status 200

{
    "success": true,
    "reason": "get lake list success",
    "data" : {
        "lake": [
            {
                "lake_id": "lake01",
                "lake_info": {
                    "lake_name": "My Lake1",
                    "lake_plan": "basic",
                    "region"   : "aws1.kor",
                    "timezone" : "America/Los_Angeles"
                }
            },
            {
                "lake_id": "lake02",
                "lake_info": {
                    "lake_name": "My Lake2",
                    "lake_plan": "enterprise",
                    "region"   : "aws1.kor",
                    "timezone" : "Asia/Seoul"
                }
            }
        ]
    }
}

Sample Code

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_KEY

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

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

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

:: CASE - GET LAKE List

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

:: Return Format
:: {
::     "success" : true,
::     "reason"  : "get list success",
::     "data": [
::         {
::             "lake_id" : "{lake_id}",
::             "lake_info" : {
::                 "lake_name"    : "sample_lake",
::                 "lake_plan"    : "basic",
::                 "region"       : "aws1.kor",
::                 "timezone"     : "Asia/Seoul"
::             }
::         },
::         ......
::     ]
:: }

github

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

API_KEY=$YOUR_API_KEY

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

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

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

# CASE - GET LAKE List

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

# Return Format
# {
#     "success" : true,
#     "reason"  : "get list success",
#     "data": [
#         {
#             "lake_id" : "{lake_id}",
#             "lake_info" : {
#                 "lake_name"    : "sample_lake",
#                 "lake_plan"    : "basic",
#                 "region"       : "aws1.kor",
#                 "timezone"     : "Asia/Seoul"
#             }
#         },
#         ......
#     ]
# }

github

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

// process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

const API_KEY = "YOUR_API_TOKEN";
const URL = "https://api.machlake.com/v1/lakes";

var request = require('request');

/* ------------------------------------------------------------------------------------------------- */

// CASE - GET LAKE List

request.get({
    url: URL, 
    headers: {
        "Content-Type": "application/json",
        "x-api-key": API_KEY
    }}, 
    function(error, response, body) {
        console.log(body);
        // Return Format
        // {
        //     "success" : true,
        //     "reason"  : "get list success",
        //     "data": [
        //         {
        //             "lake_id" : "{lake_id}",
        //             "lake_info" : {
        //                 "lake_name"    : "sample_lake",
        //                 "lake_plan"    : "basic",
        //                 "region"       : "aws1.kor",
        //                 "timezone"     : "Asia/Seoul"
        //             }
        //         },
        //         ......
        //     ]
        // }
    })

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/v1/lakes"

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


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

# CASE - GET LAKE List

response = requests.get(URL, headers=headers, verify=False)
print(response.content.decode("utf-8"))

# Return Format
# {
#     "success" : true,
#     "reason"  : "get list success",
#     "data": [
#         {
#             "lake_id" : "{lake_id}",
#             "lake_info" : {
#                 "lake_name"    : "sample_lake",
#                 "lake_plan"    : "basic",
#                 "region"       : "aws1.kor",
#                 "timezone"     : "Asia/Seoul"
#             }
#         },
#         ......
#     ]
# }