Get network metric with edge gateway

GET 
/organizations/:organizationId/edge-gateways/:edgeGatewayId/metrics/network

Get network metric with edge gateway

Request

Path Parameters

organizationId stringrequired

The ID of organization.

edgeGatewayId stringrequired

Edge Gateway ID

Query Parameters

period number

Possible values: [60, 300, 900, 3600, 86400, 604800, 2592000]

Default value: 300

Period of metric. (unit: sec)

periodTime number

Possible values: >= 1 and <= 129600

Default value: 60

Period time of metric. (unit: sec)

statistic string

Possible values: [Average, Minimum, Maximum]

Default value: Average

Statistic of metric.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the edge gateway.
pingMax objectrequired
timestamps number[]required
values number[]required
pingMin objectrequired
timestamps number[]required
values number[]required
pingAverage objectrequired
timestamps number[]required
values number[]required
pingMdev objectrequired
timestamps number[]required
values number[]required
pingTotalPackets objectrequired
timestamps number[]required
values number[]required
pingLossPackets objectrequired
timestamps number[]required
values number[]required

Example (from schema)

{
  "data": {
    "pingMax": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    },
    "pingMin": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    },
    "pingAverage": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    },
    "pingMdev": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    },
    "pingTotalPackets": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    },
    "pingLossPackets": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    }
  }
}

Example

{
  "data": {
    "pingMax": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        120,
        115
      ]
    },
    "pingMin": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        40,
        45
      ]
    },
    "pingAverage": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        80,
        75
      ]
    },
    "pingMdev": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        5,
        7
      ]
    },
    "pingTotalPackets": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        100,
        100
      ]
    },
    "pingLossPackets": {
      "timestamps": [
        1704067200000,
        1706659200000
      ],
      "values": [
        0,
        1
      ]
    }
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...