Open Context Protocol is live! 🚀 Read the launch post
getInstanceBandwidth

getInstanceBandwidth

Instance Bandwidth

Details

  • Method: GET
  • Path: /instances/{instance-id}/bandwidth
  • Operation ID: get-instance-bandwidth

Parameters

{}

Response Schema

{
  "type": "object",
  "properties": {
    "bandwidth": {
      "type": "object",
      "description": "This object will contain objects that represent days in the month (UTC). The date is denoted by the nested objects keys.",
      "properties": {
        "2020-10-10": {
          "title": "bandwidth",
          "type": "object",
          "description": "Bandwidth information.",
          "x-examples": {},
          "x-tags": [
            "bandwidth"
          ],
          "properties": {
            "incoming_bytes": {
              "type": "integer",
              "description": "Total bytes received by this instance on the date (UTC) denoted by the object key."
            },
            "outgoing_bytes": {
              "description": "Total bytes sent by this instance on the date (UTC) denoted by the object key.",
              "type": "integer"
            }
          }
        },
        "2020-10-11": {
          "title": "bandwidth",
          "type": "object",
          "description": "Bandwidth information.",
          "x-examples": {},
          "x-tags": [
            "bandwidth"
          ],
          "properties": {
            "incoming_bytes": {
              "type": "integer",
              "description": "Total bytes received by this instance on the date (UTC) denoted by the object key."
            },
            "outgoing_bytes": {
              "description": "Total bytes sent by this instance on the date (UTC) denoted by the object key.",
              "type": "integer"
            }
          }
        }
      }
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('vultr')

# Call this tool
result = await agent.call_tool('getInstanceBandwidth', {
    # Add required parameters here
})