Type alias ServerStatusInformation

ServerStatusInformation: {
    address?: string;
    agency?: {
        agencyComm: {
            endpoints: string[];
        };
    };
    agent?: {
        endpoint: string;
        id: string;
        leaderId: string;
        leading: boolean;
        term: number;
    };
    coordinator?: {
        foxxmaster: string[];
        isFoxxmaster: boolean[];
    };
    foxxApi: boolean;
    host: string;
    hostname?: string;
    license: "community" | "enterprise";
    mode: "server" | "console";
    operationMode: "server" | "console";
    pid: number;
    server: "arango";
    serverInfo: {
        maintenance: boolean;
        persistedId?: string;
        progress: {
            feature: string;
            phase: string;
            recoveryTick: number;
        };
        readOnly: boolean;
        rebootId?: number;
        role: "SINGLE" | "COORDINATOR" | "PRIMARY" | "AGENT";
        serverId?: string;
        state?: "STARTUP" | "SERVING" | "SHUTDOWN";
        version: string;
        writeOpsEnabled: boolean;
    };
}

Information about the server status.

Type declaration

  • Optional address?: string

    (Cluster Coordinators and DB-Servers only.) The address of the server.

  • Optional agency?: {
        agencyComm: {
            endpoints: string[];
        };
    }

    (Cluster Coordinators and DB-Servers only.) Information about the Agency.

    • agencyComm: {
          endpoints: string[];
      }

      Information about the communication with the Agency.

      • endpoints: string[]

        A list of possible Agency endpoints.

  • Optional agent?: {
        endpoint: string;
        id: string;
        leaderId: string;
        leading: boolean;
        term: number;
    }

    (Cluster Agents only.) Information about the Agents.

    • endpoint: string

      The endpoint of the queried Agent.

    • id: string

      Server ID of the queried Agent.

    • leaderId: string

      Server ID of the leading Agent.

    • leading: boolean

      Whether the queried Agent is the leader.

    • term: number

      The current term number.

  • Optional coordinator?: {
        foxxmaster: string[];
        isFoxxmaster: boolean[];
    }

    (Cluster Coordinators only.) Information about the Coordinators.

    • foxxmaster: string[]

      The server ID of the Coordinator that is the Foxx master.

    • isFoxxmaster: boolean[]

      Whether the queried Coordinator is the Foxx master.

  • foxxApi: boolean

    Whether the Foxx API is enabled.

  • host: string

    A host identifier defined by the HOST or NODE_NAME environment variable, or a fallback value using a machine identifier or the cluster/Agency address.

  • Optional hostname?: string

    A hostname defined by the HOSTNAME environment variable.

  • license: "community" | "enterprise"

    ArangoDB Edition.

  • mode: "server" | "console"

    Server operation mode.

    Deprecated

    use operationMode instead

  • operationMode: "server" | "console"

    Server operation mode.

  • pid: number

    The process ID of arangod.

  • server: "arango"

    Server type.

  • serverInfo: {
        maintenance: boolean;
        persistedId?: string;
        progress: {
            feature: string;
            phase: string;
            recoveryTick: number;
        };
        readOnly: boolean;
        rebootId?: number;
        role: "SINGLE" | "COORDINATOR" | "PRIMARY" | "AGENT";
        serverId?: string;
        state?: "STARTUP" | "SERVING" | "SHUTDOWN";
        version: string;
        writeOpsEnabled: boolean;
    }

    Information about the server status.

    • maintenance: boolean

      Whether the maintenance mode is enabled.

    • Optional persistedId?: string

      (Cluster only.) The persisted ID.

    • progress: {
          feature: string;
          phase: string;
          recoveryTick: number;
      }

      Startup and recovery information.

      • feature: string

        Internal name of the feature that is currently being prepared, started, stopped or unprepared.

      • phase: string

        Name of the lifecycle phase the instance is currently in.

      • recoveryTick: number

        Current recovery sequence number value.

    • readOnly: boolean

      Whether writes are disabled.

    • Optional rebootId?: number

      (Cluster only.) The reboot ID. Changes on every restart.

    • role: "SINGLE" | "COORDINATOR" | "PRIMARY" | "AGENT"

      Either "SINGLE", "COORDINATOR", "PRIMARY" (DB-Server), or "AGENT"

    • Optional serverId?: string

      (Cluster Coordinators and DB-Servers only.) The server ID.

    • Optional state?: "STARTUP" | "SERVING" | "SHUTDOWN"

      (Cluster Coordinators and DB-Servers only.) Either "STARTUP", "SERVING", or "SHUTDOWN".

    • version: string

      The server version string.

    • writeOpsEnabled: boolean

      Whether writes are enabled.

      Deprecated

      Use readOnly instead.

Settings

Theme