xrpl-dev-portal/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md

html, parent, seo, labels

html	parent	seo	labels
server_state.html	server-info-methods.html	description Retrieve status of the server in machine-readable format.	Core Server

server_state

[Source]

The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the [server_info method][], but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)

The Clio server does not support server_state directly, but you can ask for the server_state of the rippled server that Clio is connected to. Specify "ledger_index": "current" (WebSocket) or "params": [{"ledger_index": "current"}] (JSON-RPC).

Request Format

An example of the request format:

{% tabs %}

{% tab label="WebSocket" %}

{
  "id": 2,
  "command": "server_state",
  "ledger_index": "current"
}

{% /tab %}

{% tab label="JSON-RPC" %}

{
    "method": "server_state",
    "params": [
        {"ledger_index": "current"}
    ]
}

{% /tab %}

{% tab label="Commandline" %}

#Syntax: server_state
rippled server_state

{% /tab %}

{% /tabs %}

{% try-it method="server_state" server="xrplcluster" /%}

The request does not takes any parameters.

Response Format

An example of a successful response:

{% tabs %}

{% tab label="WebSocket" %}

{
  "id": 1,
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "64572720-65887201",
      "io_latency_ms": 1,
      "jq_trans_overflow": "0",
      "last_close": {
        "converge_time": 3005,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 256,
      "load_factor_fee_escalation": 256,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "365006",
      "peer_disconnects_resources": "336",
      "peers": 216,
      "pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
      "server_state": "full",
      "server_state_duration_us": "3588969453592",
      "state_accounting": {
        "connected": {
          "duration_us": "301410595",
          "transitions": "2"
        },
        "disconnected": {
          "duration_us": "1207534",
          "transitions": "2"
        },
        "full": {
          "duration_us": "3589171798767",
          "transitions": "2"
        },
        "syncing": {
          "duration_us": "6182323",
          "transitions": "2"
        },
        "tracking": {
          "duration_us": "43",
          "transitions": "2"
        }
      },
      "time": "2021-Aug-24 20:44:43.466048 UTC",
      "uptime": 3589480,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153081,
        "hash": "B52AC3876412A152FE9C0442801E685D148D05448D0238587DBA256330A98FD3",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887201
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response"
}

{% /tab %}

{% tab label="JSON-RPC" %}

200 OK

Headers

{
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "65844785-65887184",
      "io_latency_ms": 3,
      "jq_trans_overflow": "580",
      "last_close": {
        "converge_time": 3012,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 134022,
      "load_factor_fee_escalation": 134022,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "792367",
      "peer_disconnects_resources": "7273",
      "peers": 72,
      "pubkey_node": "n9LNvsFiYfFf8va6pma2PHGJKVLSyZweN1iBAkJQSeHw4GjM8gvN",
      "server_state": "full",
      "server_state_duration_us": "422128665555",
      "state_accounting": {
        "connected": {
          "duration_us": "172799714",
          "transitions": "1"
        },
        "disconnected": {
          "duration_us": "309059",
          "transitions": "1"
        },
        "full": {
          "duration_us": "6020429212246",
          "transitions": "143"
        },
        "syncing": {
          "duration_us": "413813232",
          "transitions": "152"
        },
        "tracking": {
          "duration_us": "266553605",
          "transitions": "152"
        }
      },
      "time": "2021-Aug-24 20:43:43.043406 UTC",
      "uptime": 6021282,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153020,
        "hash": "ABEF3D24015E8B6B7184B4ABCEDC0E0E3AA4F0677FAB91C40B1E500707C1F3E5",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887184
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

{% /tab %}

{% tab label="Commandline" %}

Loading: "/etc/opt/ripple/rippled.cfg"
2020-Mar-24 01:30:08.646201720 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005

Headers

{
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "65844785-65887184",
      "io_latency_ms": 3,
      "jq_trans_overflow": "580",
      "last_close": {
        "converge_time": 3012,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 134022,
      "load_factor_fee_escalation": 134022,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "792367",
      "peer_disconnects_resources": "7273",
      "peers": 72,
      "pubkey_node": "n9LNvsFiYfFf8va6pma2PHGJKVLSyZweN1iBAkJQSeHw4GjM8gvN",
      "server_state": "full",
      "server_state_duration_us": "422128665555",
      "state_accounting": {
        "connected": {
          "duration_us": "172799714",
          "transitions": "1"
        },
        "disconnected": {
          "duration_us": "309059",
          "transitions": "1"
        },
        "full": {
          "duration_us": "6020429212246",
          "transitions": "143"
        },
        "syncing": {
          "duration_us": "413813232",
          "transitions": "152"
        },
        "tracking": {
          "duration_us": "266553605",
          "transitions": "152"
        }
      },
      "time": "2021-Aug-24 20:43:43.043406 UTC",
      "uptime": 6021282,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153020,
        "hash": "ABEF3D24015E8B6B7184B4ABCEDC0E0E3AA4F0677FAB91C40B1E500707C1F3E5",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887184
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

{% /tab %}

{% /tabs %}

The response follows the [standard format][], with a successful result containing a state object as its only field.

The state object may have some arrangement of the following fields:

Field	Type	Description
amendment_blocked	Boolean	(May be omitted) If true, this server is amendment blocked. If the server is not amendment blocked, the response omits this field.
build_version	String	The version number of the running rippled version.
complete_ledgers	String	Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. It is possible to be a disjoint sequence, e.g. "2500-5000,32570-7695432". If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string empty.
closed_ledger	Object	(May be omitted) Information on the most recently closed ledger that has not been validated by consensus, as a Server Ledger Object. If the most recently validated ledger is available, the response omits this field and includes validated_ledger instead.
io_latency_ms	Number	Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the rippled server is probably having serious load issues.
jq_trans_overflow	String - Number	The number of times this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see Capacity Planning.
last_close	Object	Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating.
last_close.converge_time	Number	The amount of time it took to reach a consensus on the most recently validated ledger version, in milliseconds.
last_close.proposers	Number	How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version.
load	Object	(Admin only) Detailed information about the current load state of the server.
load.job_types	Array	(Admin only) Information about the rate of different types of jobs the server is doing and how much time it spends on each.
load.threads	Number	(Admin only) The number of threads in the server's main job pool.
load_base	Number	The baseline amount of server load used in [transaction cost][] calculations. If the load_factor is equal to the load_base, then only the base transaction cost is enforced. If the load_factor is higher than the load_base, then transaction costs are multiplied by the ratio between them. For example, if the load_factor is double the load_base, then transaction costs are doubled.
load_factor	Number	The load factor the server is currently enforcing. The ratio between this value and the load_base determines the multiplier for transaction costs. The load factor is determined by the highest of the individual server's load factor, the cluster's load factor, the open ledger cost, and the overall network's load factor.
load_factor_fee_escalation	Number	(May be omitted) The current multiplier to the transaction cost to get into the open ledger, in [fee levels][].
load_factor_fee_queue	Number	(May be omitted) The current multiplier to the transaction cost to get into the queue, if the queue is full, in fee levels.
load_factor_fee_reference	Number	(May be omitted) The transaction cost with no load scaling, in fee levels.
load_factor_server	Number	(May be omitted) The load factor the server is enforcing, based on load to the server, cluster, and network, but not factoring in the open ledger cost.
network_ledger	String	(May be omitted) When starting the server with the --net parameter, this field contains the string waiting while the server is syncing to the network. The field is omitted otherwise.
peers	Number	How many other rippled servers this one is currently connected to.
ports	Array	A list of ports where the server is listening for API commands. Each entry in the array is a Port Descriptor object. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.12.0" %}New in: rippled 1.12.0{% /badge %}
pubkey_node	String	Public key used to verify this server for peer-to-peer communications. This node key pair is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the [node_seed] config option, which is useful for clustering.
pubkey_validator	String	(Admin only) Public key used by this node to sign ledger validations. This validation key pair is derived from the [validator_token] or [validation_seed] config field.
server_state	String	A string indicating to what extent the server is participating in the network. See Possible Server States for more details.
server_state_duration_us	Number	The number of consecutive microseconds the server has been in the current state.
state_accounting	Object	A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. The contents of this field are formatted as State Accounting Objects.
time	String	The current time in UTC, according to the server's clock.
uptime	Number	Number of consecutive seconds that the server has been operational.
validated_ledger	Object	(May be omitted) Information about the most recent fully-validated ledger, as a Server Ledger Object. If the most recent validated ledger is not available, the response omits this field and includes closed_ledger instead.
validation_quorum	Number	Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations.
validator_list_expires	Number	(Admin only) When the current validator list expires, in [seconds since the Ripple Epoch][], or 0 if the server has yet to load a published validator list.

{% partial file="/docs/_snippets/port-descriptor-object.md" /%}

{% partial file="/docs/_snippets/state-accounting-object.md" /%}

Server Ledger Object

The response provides either a validated_ledger field or a closed_ledger field. Either field contains an object with the following fields:

Field	Value	Description
base_fee	Number	The base fee, in drops of XRP, for propagating a transaction to the network, as of this ledger version.
close_time	Number	The official close time time of this ledger version, in [seconds since the Ripple Epoch][]. This value is rounded; see Ledger Close Times for details.
hash	String - [Hash][]	The unique hash of this ledger version, as hexadecimal.
reserve_base	Number	The minimum account reserve, as of the most recent validated ledger version.
reserve_inc	Number	The owner reserve for each item an account owns, as of the most recent validated ledger version.
seq	Number	The [ledger index][] of this ledger version.

Note that the [server_info method][] provides a similar object with slightly different formatting (using decimal XRP instead of drops, for example).

Possible Errors

• Any of the [universal error types][].

{% raw-partial file="/docs/_snippets/common-links.md" /%}