falcon_plus_api v0.1.0 FalconPlusApi.Api.Dashboard

Summary

Functions

graph_create(sig, post_param, addr \\ nil, options \\ [])

Request

{
  "screen_id": 953,
  "title": "laiwei-test-graph1",
  "endpoints": ["laiweiofficemac"],
  "counters": ["value/name=pfc.push.ms","value/name=pfc.push.size"],
  "timespan": 1800, 
  "graph_type": "h", 
  "method": "AVG",
  "position": 0
}

Response

Status: 200

{"message":"ok"}

For errors responses, see the response status codes documentation.

graph_create_tmpgraph(sig, post_param, addr \\ nil, options \\ [])

Request

{"endpoints":["e1", "e2"], "counters":["c1", "c2"]}

Response

Status: 200

{
  "ck": "68c07419dbd7ac65977c97d05d99440d",
  "counters": "c1|c2",
  "endpoints": "e1|e2",
  "id": 365195
}

For errors responses, see the response status codes documentation.

graph_delete(sig, url_param, post_param, addr \\ nil, options \\ [])

Response

Status: 200

{"message":"ok"}

For errors responses, see the response status codes documentation.

graph_get(sig, param, addr \\ nil, options \\ [])

Response

Status: 200

{
  "counters":["value/name=pfc.push.ms", "value/name=pfc.push.size"],
  "endpoints":["laiweiofficemac"],
  "falcon_tags":"",
  "graph_id":4626,
  "graph_type":"h",
  "method":"",
  "position":4626,
  "screen_id":953,
  "timespan":3600,
  "title":"test"
}```


For errors responses, see the [response status codes documentation](#/response-status-codes).
graph_get_tmpgraph_by_id(sig, param, addr \\ nil, options \\ [])

Response

Status: 200

{"counters":["agent.alive"],"endpoints":["laiweiofficemac"]}

For errors responses, see the response status codes documentation.

graph_update(sig, url_param, post_param, addr \\ nil, options \\ [])

Request

{
  "counters": ["value/name=pfc.push.ms","value/name=pfc.push.size", "agent.alive"],
  "falcon_tags": "srv=falcon"
}

Response

Status: 200

{"message":"ok"}

For errors responses, see the response status codes documentation.

graphs_gets_by_screenid(sig, param, addr \\ nil, options \\ [])

Response

Status: 200

[
  {
      "counters": [
          "value/name=pfc.push.ms"
      ],
      "endpoints": [
          "laiweiofficemac"
      ],
      "falcon_tags": "",
      "graph_id": 4640,
      "graph_type": "h",
      "method": "",
      "position": 0,
      "screen_id": 991,
      "timespan": 3600,
      "title": "dddd"
  },
  {
      "counters": [
          "aaa"
      ],
      "endpoints": [
          "xxx"
      ],
      "falcon_tags": "",
      "graph_id": 4641,
      "graph_type": "h",
      "method": "SUM",
      "position": 0,
      "screen_id": 991,
      "timespan": 3600,
      "title": "dddd"
  }
]

For errors responses, see the response status codes documentation.

screen_create(sig, post_param, addr \\ nil, options \\ [])

Request

Content-type: application/x-www-form-urlencoded

name=laiwei-sceen1&pid=0

Response

Status: 200 {"name":"laiwei-sceen1","pid":0,"screen_id":961}

For errors responses, see the response status codes documentation.

screen_delete(sig, url_param, post_param, addr \\ nil, options \\ [])

Response

Status: 200 {"message":"ok"}

For errors responses, see the response status codes documentation.

screen_get_by_id(sig, param, addr \\ nil, options \\ [])

Response

Status: 200 {"id":961,"pid":0,"name":"laiwei-sceen1"}

For errors responses, see the response status codes documentation.

screen_gets_all(sig, addr \\ nil, options \\ [])

Request

Content-type: application/x-www-form-urlencoded limit=100

Response

Status: 200

[
  {
      "id": 952,
      "name": "a1",
      "pid": 0
  },
  {
      "id": 953,
      "name": "aa1",
      "pid": 952
  },
  {
      "id": 968,
      "name": "laiwei-screen2",
      "pid": 1
  },
  {
      "id": 972,
      "name": "laiwei-sceen1",
      "pid": 0
  },
  {
      "id": 991,
      "name": "xnew",
      "pid": 972
  },
  {
      "id": 993,
      "name": "clone3",
      "pid": 972
  },
  {
      "id": 995,
      "name": "op",
      "pid": 0
  }
]

For errors responses, see the response status codes documentation.

screen_gets_by_pid(sig, param, addr \\ nil, options \\ [])

Response

Status: 200

[
  {
      "id": 952,
      "name": "a1",
      "pid": 0
  },
  {
      "id": 961,
      "name": "laiwei-sceen1",
      "pid": 0
  }
]

For errors responses, see the response status codes documentation.

screen_update(sig, url_param, post_param, addr \\ nil, options \\ [])

Request

Content-type: application/x-www-form-urlencoded

name=laiwei-sceen1&pid=0

Response

Status: 200 {"message":"ok"}

For errors responses, see the response status codes documentation.