View Lake

[ 1 HTTP Request ] [ 1.1 Parameters ] [ 2 Request Example ] [ 3 Response Example ] [ 4 Sample Code ]

This API returns details of the specified Data Lake. And, you must enter a specific date, and based on this date, you can get information about the usage status of the lake. Date must be a date in the month for which detailed information is required, and use the format "YYYY-MM-DD". For example, if you need information for July 2021, send it as 2021-07-10 => 2021-07-{choose among the dates before the present}.

HTTP Request

Parameters

no parameters

Request Example

Response Example

Sample Code

github

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

set API_KEY=YOUR_API_KEY
set LAKE_ID=YOUR_LAKE_ID

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


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

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

:: CASE - GET LAKE List

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

:: Return Format
:: {
::     "success":true,
::     "reason":"get lake info success",
::     "data":{
::         "lake_id":"xbcd0001",
::         "lake_info":{
::             "lake_name":"sample_lake",
::             "lake_plan":"basic",
::             "lake_type":"N",
::             "region":"aws1.kor",
::             "timezone":"America/Los_Angeles",
::             "create_time":"2021-09-30 10:30:05",
::             "update_time":"2021-10-01 14:59:12"
::         },
::         "lake_status":{
::             "count_of_tag":128,
::             "count_of_value":123456,
::             "query_call":0,
::             "traffic":4743829,
::             "storage":3032870912,
::             "state":"running" 
::         },
::         "plan_limit":{
::             "max_tag":1000,
::             "max_query":10000,
::             "max_disk":32212254720,
::             "max_concurrent":100000,
::             "limit_select_tag":1000,
::             "limit_select_value":100,
::             "limit_append_value":100,
::             "limit_append_tag":1000,
::             "default_tag_count":10000
::         },
::         "tag_schema":[
::             {
::                 "col_name":"name",
::                 "col_type":"varchar",
::                 "col_length":40
::             }
::         ],
::         "value_schema":[
::             {
::                 "col_name":"time",
::                 "col_type":"datetime"
::             },
::             {
::                 "col_name":"value",
::                 "col_type":"double"
::             }
::         ]
::     }
:: }

github

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

API_KEY=$YOUR_API_KEY
LAKE_ID=$YOUR_LAKE_ID

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

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

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

# CASE - GET LAKE List

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

# Return Format
# {
#     "success":true,
#     "reason":"get lake info success",
#     "data":{
#         "lake_id":"xbcd0001",
#         "lake_info":{
#             "lake_name":"sample_lake",
#             "lake_plan":"basic",
#             "lake_type":"N",
#             "region":"aws1.kor",
#             "timezone":"America/Los_Angeles",
#             "create_time":"2021-09-30 10:30:05",
#             "update_time":"2021-10-01 14:59:12"
#         },
#         "lake_status":{
#             "count_of_tag":128,
#             "count_of_value":123456,
#             "query_call":0,
#             "traffic":4743829,
#             "storage":3032870912,
#             "state":"running" 
#         },
#         "plan_limit":{
#             "max_tag":1000,
#             "max_query":10000,
#             "max_disk":32212254720,
#             "max_concurrent":100000,
#             "limit_select_tag":1000,
#             "limit_select_value":100,
#             "limit_append_value":100,
#             "limit_append_tag":1000,
#             "default_tag_count":10000
#         },
#         "tag_schema":[
#             {
#                 "col_name":"name",
#                 "col_type":"varchar",
#                 "col_length":40
#             }
#         ],
#         "value_schema":[
#             {
#                 "col_name":"time",
#                 "col_type":"datetime"
#             },
#             {
#                 "col_name":"value",
#                 "col_type":"double"
#             }
#         ]
#     }
# }

github

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

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

const API_KEY = "YOUR_API_TOKEN";
const LAKE_ID = "YOUR_LAKE_ID";
const URL = `https://api.machlake.com/v1/lakes/${LAKE_ID}`;

var request = require('request');

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

// CASE - GET LAKE view

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 lake info success",
        //     "data":{
        //         "lake_id":"{lake_id}",
        //         "lake_info":{
        //             "lake_name":"sample_lake",
        //             "lake_plan":"basic",
        //             "lake_type":"N",
        //             "region":"aws1.kor",
        //             "timezone":"America/Los_Angeles",
        //             "create_time":"2021-09-30 10:30:05",
        //             "update_time":"2021-10-01 14:59:12"
        //         },
        //         "lake_status":{
        //             "count_of_tag":128,
        //             "count_of_value":123456,
        //             "query_call":0,
        //             "traffic":4743829,
        //             "storage":3032870912,
        //             "state":"running" 
        //         },
        //         "plan_limit":{
        //             "max_tag":1000,
        //             "max_query":10000,
        //             "max_disk":32212254720,
        //             "max_concurrent":100000,
        //             "limit_select_tag":1000,
        //             "limit_select_value":100,
        //             "limit_append_value":100,
        //             "limit_append_tag":1000,
        //             "default_tag_count":10000
        //         },
        //         "tag_schema":[
        //             {
        //                 "col_name":"name",
        //                 "col_type":"varchar",
        //                 "col_length":40
        //             }
        //         ],
        //         "value_schema":[
        //             {
        //                 "col_name":"time",
        //                 "col_type":"datetime"
        //             },
        //             {
        //                 "col_name":"value",
        //                 "col_type":"double"
        //             }
        //         ]
        //     }
        // }
    });

github

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

import requests

API_KEY = "YOUR_API_TOKEN"
LAKE_ID = "YOUR_LAKE_ID"

URL = f"https://api.machlake.com/v1/lakes/{LAKE_ID}"

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 lake info success",
#     "data":{
#         "lake_id":"xbcd0001",
#         "lake_info":{
#             "lake_name":"sample_lake",
#             "lake_plan":"basic",
#             "lake_type":"N",
#             "region":"aws1.kor",
#             "timezone":"America/Los_Angeles",
#             "create_time":"2021-09-30 10:30:05",
#             "update_time":"2021-10-01 14:59:12"
#         },
#         "lake_status":{
#             "count_of_tag":128,
#             "count_of_value":123456,
#             "query_call":0,
#             "traffic":4743829,
#             "storage":3032870912,
#             "state":"running" 
#         },
#         "plan_limit":{
#             "max_tag":1000,
#             "max_query":10000,
#             "max_disk":32212254720,
#             "max_concurrent":100000,
#             "limit_select_tag":1000,
#             "limit_select_value":100,
#             "limit_append_value":100,
#             "limit_append_tag":1000,
#             "default_tag_count":10000
#         },
#         "tag_schema":[
#             {
#                 "col_name":"name",
#                 "col_type":"varchar",
#                 "col_length":40
#             }
#         ],
#         "value_schema":[
#             {
#                 "col_name":"time",
#                 "col_type":"datetime"
#             },
#             {
#                 "col_name":"value",
#                 "col_type":"double"
#             }
#         ]
#     }
# }

MachLake

View Lake

Analytics

HTTP Request

Parameters

Request Example

Response Example

Sample Code