Gráficos de rede

Buscar gráfico de uso de rede de uma conexão

API de busca do gráfico sobre o uso de rede de uma conexão.

Uma conexão pode ou não estar associada com classes do DBC (Classe do DBC). Se a conexão não estiver associada com classes do DBC, os retornos dos campos dbc_classes_upload e dbc_classes_download serão vazios ([]).

Se apenas o upload da conexão não estiver associado com classes do DBC, somente o retorno do campo dbc_classes_upload será vazio ([]). Caso apenas o download da conexão não estiver associado com classes do DBC, somente retorno do campo dbc_classes_download será vazio ([]).

GET /api/graphs/networks/id

Exemplo de requisição

GET /api/graphs/networks/iface:1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

from itflex_sdk.net_charts.types import GetConnectionChartRequest

request = GetConnectionChartRequest(id="iface:1")
response = sdk.net_charts.get_connection_chart_by_id(request)
print(response.payload)

const response = sdk.graphs.getConnectionChart({ id: "iface:1" });
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "iface:1",
  "name": "testing",
  "type": "wan",
  "link_upload_speed": 3000,
  "link_download_speed": 4000,
  "upload_policy_id": 1,
  "download_policy_id": null,
  "interface_upload": [
    {
      "class_id": null,
      "name": "connection",
      "data": [
        {
          "dt": "2018-12-13T16:07:37.907Z",
          "speed": 1200,
        },
        {
          "dt": "2018-12-13T16:12:37.907Z",
          "speed": 800,
        },
        {
          "dt": "2018-12-13T16:17:37.907Z",
          "speed": 1000,
        },
      ],
    },
  ],
  "interface_download": [
    {
      "class_id": null,
      "name": "connection",
      "data": [
        {
          "dt": "2018-11-13T11:07:37.907Z",
          "speed": 1300,
        },
        {
          "dt": "2018-11-13T11:12:37.907Z",
          "speed": 900,
        },
        {
          "dt": "2018-11-13T11:17:37.907Z",
          "speed": 500,
        },
      ],
    }
  ],
  "dbc_classes_upload": [
    {
      "class_id": 1,
      "name": "http",
      "data": [
        {
          "dt": "2018-09-13T11:07:37.907Z",
          "speed": 300,
        },
        {
          "dt": "2018-09-13T11:12:37.907Z",
          "speed": 500,
        },
        {
          "dt": "2018-09-13T11:17:37.907Z",
          "speed": 900,
        },
      ],
    },
    {
      "class_id": 3,
      "name": "voip",
      "data": [
        {
          "dt": "2018-05-13T11:07:37.907Z",
          "speed": 1300,
        },
        {
          "dt": "2018-05-13T11:12:37.907Z",
          "speed": 1500,
        },
        {
          "dt": "2018-05-13T11:17:37.907Z",
          "speed": 1900,
        },
      ],
    }
  ],
  "dbc_classes_download": [],
}

ConnectionChart(
  id="iface:1",
  name="testing",
  type="wan",
  link_upload_speed=3000,
  link_download_speed=4000,
  upload_policy_id=1,
  download_policy_id=None,
  interface_upload=[
    NetworkChartLine(
      class_id=None,
      name='connection',
      data=[
        NetworkPoint(
          dt='2018-12-13T16:07:37.907Z',
          speed=1200,
        ),
        NetworkPoint(
          dt='2018-12-13T16:12:37.907Z',
          speed=800,
        ),
        NetworkPoint(
          dt='2018-12-13T16:17:37.907Z',
          speed=1000,
        ),
      ],
    },
  ],
  interface_download=[
    NetworkChartLine(
      class_id=None,
      name='connection',
      data=[
        NetworkPoint(
          dt='2018-11-13T11:07:37.907Z',
          speed=1300,
        ),
        NetworkPoint(
          dt='2018-11-13T11:12:37.907Z',
          speed=900,
        ),
        NetworkPoint(
          dt='2018-11-13T11:17:37.907Z',
          speed=500,
        ),
      ],
    },
  ],
  dbc_classes_upload=[
    NetworkChartLine(
      class_id=1,
      name='http',
      data=[
        NetworkPoint(
          dt='2018-09-13T11:07:37.907Z',
          speed=300,
        ),
        NetworkPoint(
          dt='2018-09-13T11:12:37.907Z',
          speed=500,
        ),
        NetworkPoint(
          dt='2018-09-13T11:17:37.907Z',
          speed=900,
        ),
      ],
    ),
    NetworkChartLine(
      class_id=3,
      name='voip',
      data=[
        NetworkPoint(
          dt='2018-05-13T11:07:37.907Z',
          speed=1300,
        ),
        NetworkPoint(
          dt='2018-09-13T11:12:37.907Z',
          speed=1500,
        ),
        NetworkPoint(
          dt='2018-09-13T11:17:37.907Z',
          speed=1900,
        ),
      ],
    ),
  ],
  dbc_classes_download=[],
)

{
  id: "iface:1",
  name: "testing",
  type: "wan",
  linkUploadSpeed: 3000,
  linkDownloadSpeed: 4000,
  uploadPolicyId: 1,
  downloadPolicyId: null
  interfaceUpload: [
    {
      classId: null,
      name: "connection",
      data: [
        {
          dt: "2018-12-13T16:07:37.907Z",
          speed: 1200
        },
        {
          dt: "2018-12-13T16:12:37.907Z",
          speed: 800
        },
        {
          dt: "2018-12-13T16:17:37.907Z",
          speed: 1000
        }
      ]
    }
  ],
  interfaceDownload: [
    {
      classId: null,
      name: "connection",
      data: [
        {
          dt: "2018-11-13T11:07:37.907Z",
          speed: 1300
        },
        {
          dt: "2018-11-13T11:12:37.907Z",
          speed: 900
        },
        {
          dt: "2018-11-13T11:17:37.907Z",
          speed: 500
        }
      ]
    }
  ],
  dbcClassesUpload: [
    {
      classId: 1,
      name: "http",
      data: [
        {
          dt: "2018-09-13T11:07:37.907Z",
          speed: 300
        },
        {
          dt: "2018-09-13T11:12:37.907Z",
          speed: 500
        },
        {
          dt: "2018-09-13T11:17:37.907Z",
          speed: 900
        }
      ]
    },
    {
      classId: 3,
      name: "voip",
      data: [
        {
          dt: "2018-05-13T11:07:37.907Z",
          speed: 1300
        },
        {
          dt: "2018-09-13T11:12:37.907Z",
          speed: 1500
        },
        {
          dt: "2018-09-13T11:17:37.907Z",
          speed: 1900
        }
      ]
    }
  ],
  dbcClassesDownload: []
}

Formato dos dados

Parâmetros da url

Campo Descrição
id string

Identificador da conexão presente no contexto de Redes

Deve possuir o formato type:id, detalhado em Conexões

Resposta

Campo Descrição
id string

Identificador da conexão presente no contexto de Redes
name string

Nome da conexão
type string

Tipo da conexão

Enum: wan, dmz, guest, lan
link_upload_speed int

Velocidade de upload da conexão
link_download_speed int

Velocidade de download da conexão
upload_policy_id int

Identificador da Política do DBC de upload da conexão

o valor será nulo (null) se a conexão não estiver associada com alguma política do DBC (Política do DBC)
download_policy_id int

Identificador da Política do DBC de download da conexão

o valor será nulo (null) se a conexão não estiver associada com alguma política do DBC (Política do DBC)
interface_upload array<object>

Linhas do gráfico de upload da conexão, sem separação por classes do DBC (Classe do DBC)
interface_upload.class_id int

Identificador do tipo de tráfego (Classe do DBC)

O valor será nulo (null), pois refere-se ao gráfico da conexão sem separação por classes
interface_upload.name string

Nome do tipo de tráfego

Como refere-se ao tráfego da interface toda (não dividido por classes do DBC) o valor será connection
interface_upload.data array<object>

Dados do gráfico de tráfego da conexão, sem separação por classes
interface_download array<object>

Linhas do gráfico de download da conexão, sem separação por classes do DBC (Classe do DBC)
interface_download.class_id int

Identificador do tipo de tráfego (Classe do DBC)

O valor será nulo (null), pois refere-se ao gráfico da conexão sem separação por classes
interface_download.name string

Nome do tipo de tráfego

Como refere-se ao tráfego da interface toda (não dividido por classes do DBC) o valor será connection
interface_download.data array<object>

Dados do gráfico de tráfego da conexão, sem separação por classes
dbc_classes_upload array<object>

Linhas do gráfico de upload da conexão separado por classes do DBC (Classe do DBC)

O valor retornado será vazio ([]) se a conexão não possuir classes DBC
dbc_classes_upload.class_id int

Identificador do tipo de tráfego da classe (Classe do DBC)
dbc_classes_upload.name string

Nome do tipo de tráfego

Caso seja o tráfego padrão (não associado com uma classe), o valor será default
dbc_classes_upload.data array<object>

Dados do gráfico de tráfego da classe da conexão

dbc_classes_download array<object>

Linhas do gráfico de download da conexão separado por classes do DBC (Classe do DBC)

O valor retornado será vazio ([]) se a conexão não possuir classes DBC
dbc_classes_download.class_id int

Identificador do tipo de tráfego da classe (Classe do DBC)
dbc_classes_download.name string

Nome do tipo de tráfego

Caso seja o tráfego padrão (não associado com uma classe), o valor será default
dbc_classes_download.data array<object>

Dados do gráfico de tráfego da classe da conexão