socialweb.computer

Request and provide VMs on an atproto compute market.

lexicons and xrpc

lexicon

com.fedfork.exec.ops.getVmMemory

query HTTP GET /xrpc/com.fedfork.exec.ops.getVmMemory

A bidder answers the memory cgroup figures of one of its VMs' units. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.

parameters

parametertypedescription
name *string
A ComputeVM name (a DNS label).
maxLength 63

output

encoding application/json

fieldtypedescription
unit *string
current *integer
high *string
max *string
swapMax *string
events *unknown
memory.events: name to count.

errors

errordescription
AuthenticationRequired401: the ops read secret is missing or wrong.
InvalidRequest400: name is not a ComputeVM name (a DNS label of at most 63 characters).
NotFound404: the host has no unit or no readable memory cgroup for that VM.
ReadFailed502: the read failed; the host's log has the detail.

used in

no page of these docs names it yet.

raw schema: lexicons/com/fedfork/exec/ops/getVmMemory.json
{
  "lexicon": 1,
  "id": "com.fedfork.exec.ops.getVmMemory",
  "defs": {
    "main": {
      "type": "query",
      "description": "A bidder answers the memory cgroup figures of one of its VMs' units. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.",
      "parameters": {
        "type": "params",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 63,
            "description": "A ComputeVM name (a DNS label)."
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "unit",
            "current",
            "high",
            "max",
            "swapMax",
            "events"
          ],
          "properties": {
            "unit": {
              "type": "string"
            },
            "current": {
              "type": "integer"
            },
            "high": {
              "type": "string"
            },
            "max": {
              "type": "string"
            },
            "swapMax": {
              "type": "string"
            },
            "events": {
              "type": "unknown",
              "description": "memory.events: name to count."
            }
          }
        }
      },
      "errors": [
        {
          "name": "AuthenticationRequired",
          "description": "401: the ops read secret is missing or wrong."
        },
        {
          "name": "InvalidRequest",
          "description": "400: name is not a ComputeVM name (a DNS label of at most 63 characters)."
        },
        {
          "name": "NotFound",
          "description": "404: the host has no unit or no readable memory cgroup for that VM."
        },
        {
          "name": "ReadFailed",
          "description": "502: the read failed; the host's log has the detail."
        }
      ]
    }
  }
}