Versions Compared

Version Old Version 8 New Version Current
Changes made by

machlake (Unlicensed)

machlake (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Paste code macro
languagehttp
themeSunburst
GET https://{lake_id${CloudVendor}.${CountryCode}.machlake.com/v1/lakes/${lake_id}/tag
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

...

Paste code macro
languagehttp
themeSunburst
GET https://lake01aws1.us.machlake.com/v1/lakes/xbacd1234/tag?name=newtag01
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

...

Paste code macro
languagejson
themeSunburst
Status 200
 
{
    "success": true,
    "statusreason": "get tag meta success",
    "data": {
        "name": "newtag01"
    }
}

...

Expand
titlewindow(batch)

github

Code Block
chcp 65001 
:: Text Encoding to UTF-8 in CMD
:: Example For Get Tag View API by using curl in window script
:: written by yeony kim
:: sensor1, sensor2 is applied in lake

set API_KEY=YOUR_API_KEY

set CONTENTLAKE_HEADER="ID=YOUR_LAKE_ID
set CLOUD_VENDOR=YOUR_CLOUD_VENDOR
set CLOUD_REGION=YOUR_CLOUD_REGION

set CONTENT_HEADER="Content-Type: application/json"
set API_HEADER="x-api-key: %API_KEY%"
set LAKE_ID=c5ehcdmcb0jc72ia6pug
set URL="https://%LAKE_ID%%CLOUD_VENDOR%.%CLOUD_REGION%.machlake.com/v1/lakes/%LAKE_ID%/tag"

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

:: CASE - Get Tag Information

set TAG_NAME=sensorsensor1

curl -k -G %URL% -H %CONTENT_HEADER% -H %API_HEADER% \
    --data-urlencode "name=%TAG_NAME%"

:: Return Format / not exist tag name in lake
:: {"message":"no such name : sensor","status":"error"}

set TAG_NAME=sensor1

curl -k -G %URL% -H %CONTENT_HEADER% -H %API_HEADER% --data-urlencode "name=%TAG_NAME%"
:: Return Format
:: {"data":{"name":"sensor1"},"status":"success"}


::     "success": true,
::     "reason": "get tag meta success",
::     "data": {"name": "sensor01"}
:: }


:: ------------------------------------------------------------------------------------------------- ::
Expand
titleLinux(shell)

github

Code Block
# Text Encoding to UTF-8 in CMD
# Example For Get Tag View API by using curl in ubuntu
# written by yeony kim
# sensor1, sensor2 is applied in lake

API_KEY=

CONTENT_HEADER=Content-Type:application/json
API_HEADER=x-api-key:$API_KEY
LAKE_ID=c5ehcdmcb0jc72ia6pug
URL=https://$LAKE_ID.machlake.com/lakes/tag

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

:: CASE - Get Tag Information when no exist tag name

set TAG_NAME=wrong_name

curl -k -G %URL% -H %CONTENT_HEADER% -H %API_HEADER% \
    --data-urlencode "name=%TAG_NAME%"

:: Return Format
:: status code : 400 Bad Request
:: {
::     "success": false,
::     "reason": "no such name : wrong_name"
:: }
Expand
titleLinux(shell)

github

Code Block
languagebash
# 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 - GetGET TagLAKE InformationList

TAG_NAME=sensor

curl -k -GX GET $URL -H $CONTENT_HEADER -H $API_HEADER --data-urlencode "name=$TAG_NAME"

# Return Format
/# not{
exist# tag name in lake # {"messagesuccess":"no such name : sensor","status":"error"}

TAG_NAME=sensor1

curl -k -G $URL -H $CONTENT_HEADER -H $API_HEADER --data-urlencode "name=$TAG_NAME"
# Return Format
# {"data":{"name":"sensor1"},"status":"success"}

# ------------------------------------------------------------------------------------------------- #
Expand
titlejavacsript

github

Code Block
languagejs
// Example For Get Tag View API by using request in nodejs
// written by yeony kim
// sensor1, sensor2 is applied in lake

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

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

// CASE - Get Tag Information

app.get(
    '/get_tag_view_no_tag_name', function(req, res) {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,
#           var request = require('request'); "query_call":0,
#         const QueryParams = new URLSearchParams()
 "traffic":4743829,
#         QueryParams.set("name", "sensor")     "storage":3032870912,
#   var option = {       "state":"running" 
#    url: URL + "?" + QueryParams.toString()},
#            headers: "plan_limit":{
#                'Content-Type': 'application/json',
"max_tag":1000,
#                'x-api-key': API_KEY"max_query":10000,
#             }"max_disk":32212254720,
#        };         request.get(option, function(error, response, body) {"max_concurrent":100000,
#             "limit_select_tag":1000,
  if (!error && response.statusCode === 200) {#             "limit_select_value":100,
#        res.writeHead(200);     "limit_append_value":100,
#           res.end(body);  "limit_append_tag":1000,
#              console.log(body)"default_tag_count":10000
#         },
#   } else {    "tag_schema":[
#            console.log('error');  {
#                 console.log(error, response)"col_name":"name",
#                  if (response !== undefined) {"col_type":"varchar",
#                 "col_length":40
#        res.writeHead(200);     }
#         ],
#     res.end(body);    "value_schema":[
#             {
#  console.log(body) // {"message":"no such name : sensor","status          "col_name":"error"}time",
#                  }"col_type":"datetime"
#             },
#          })   {
#  } )  // CASE - Get Tag Information  app.get(     '/get_tag_view_tag_name', function(req, res) {"col_name":"value",
#             var request = require('request');
  "col_type":"double"
#       const QueryParams = new URLSearchParams()  }
#       QueryParams.set("name", "sensor1") ]
#     }
 var option = {
            url: URL + "?" + QueryParams.toString(),
            headers: {
                'Content-Type': 'application/json',
                'x-api-key': API_KEY
            },
        };
        request.get(option, function(error, response, body) {
            if (!error && response.statusCode === 200)# }
Expand
titlejavacsript

github

Code Block
languagejs
// Example For Get Tag View API by using request in nodejs

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

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

var request = require('request');


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

// CASE - Get Tag Information

request.get({
    url: URL, 
    qs: {
        name: "sensor1"
    },
 res.writeHead(200);   headers: {
            res.end(body);"x-api-key": API_KEY
    }}, 
    function(error, response, body) {
        console.log(body);
        // Return Format
 } else {     // {
        //  console.log('error');   "success": true,
        //    console.log(error, response)
    "reason": "get tag meta success",
        //    if (response !== undefined) {
 "data": {"name": "sensor01"}
        // }
    })

   res.writeHead(200);
                    res.end(body);
                    console.log(body) // {"data":{"name":"sensor1"},"status":"success"}
                }/* ------------------------------------------------------------------------------------------------- */

// CASE - Get Tag Information when no exist tag name

request.get({
    url: URL, 
    qs: {
     }   name: "wrong_name"
    }),
    }headers: ){
  app.listen(8888, function() {     console.log('http://127.0.0.1:8888/get_tag_view_no_tag_name is result for tag name not exist in lake')
    console.log('http://127.0.0.1:8888/get_tag_view_tag_name is result for tag name exsit in lake')
})
Expand
titlepython

github

Code Block
languagepy
"""
Example For Get Tag View API by using requests in python
written by yeony kim
sensor1, sensor2 is applied in lake
"""

import requests

API_KEY = "YOUR_API_TOKEN"
LAKE_ID = "c5ehcdmcb0jc72ia6pug"
URL = f"https://{LAKE_ID}.machlake.com/lakes/tag"

headers = {
    'Content-Type': 'application/json',
    'x-api-key': API_KEY
}"x-api-key": API_KEY
    }}, 
    function(error, response, body) {
        console.log(body);
        // Return Format
        // status code : 400 Bad Request
        // {
        //     "success": false,
        //     "reason": "no such name : wrong_name"
        // }
    })
Expand
titlepython

github

Code Block
languagepy
"""
Example For Get Tag View API by using requests in python
written by yeony kim
"""

import requests

API_KEY = "YOUR_API_TOKEN"
LAKE_ID = "YOUR_LAKE_ID"
CLOUD_VENDOR="CLOUD_VENDOR"
CLOUD_REGION="CLOUD_REGION"

URL = f"https://{CLOUD_VENDOR}.{CLOUD_REGION}.machlake.com/v1/lakes/{LAKE_ID}/tag"

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


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

# CASE - Get Tag Information

params = {
    "name": "sensor1"
}

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

# Return Format
# {
#     "success": true,
#     "reason": "get tag meta success",
#     "data": {"name": "sensor01"}
# }


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

# CASE - Get Tag Information when no exist tag name

params = {
    '"name'": 'sensor'"wrong_name"
}

response = requests.get(URL, headers=headers,  params=params, verify=False)
print(response.content.decode('utf-8'))  # {"message":"no such name : sensor","status":"error"}.content.decode("utf-8"))

# CASEReturn -Format
Get# Tagstatus Informationcode : params400 =Bad {Request
#    'name': 'sensor1'
}{
#  response = requests.get(URL, headers=headers,  params=params, verify=False)
print(response.content.decode('utf-8'))  # {"data":{"name":"sensor1"},"status":"success"} "success": false,
#     "reason": "no such name : wrong_name"
# }