Metrics

Get a Deployment Metrics

Get the metrics for a specific deployment based on the start_time, end_time and steps. raw parameter can be set to true to get the raw data.

get/v1/metrics/deployment/{request_id}

Request

Base URL: https://api.edgegap.com
URL: https://api.edgegap.com/v1/metrics/deployment/{request_id}
Auth: API key in header authorization

Query parameters

start_timestring

Starting time for the query. Default to deployment start time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-10 00:00:00.00

end_timestring

End time for the metrics. Default to now.Must be greater than start_time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-19 00:00:00.00

stepsstring

Steps between each metrics.

	Example: 30s, 1m, 5m 10m, 1h

rawstring

If set to true, will return the raw data. Default to false.

Response

Success

Example response

{
  "total": {
    "receive_total": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "transmit_total": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "disk_read_total": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "disk_write_total": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    }
  },
  "cpu": {
    "labels": [
      "00:00:00"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "cpu_throttle_rate": {
    "labels": [
      "00:00:00"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "cpu_throttle_total": {
    "labels": [
      "00:00:00"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "mem": {
    "labels": [
      "00:00:00"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "network": {
    "receive": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "transmit": {
      "labels": [
        "00:00:00"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.