Struct ClusterInfo 

pub struct ClusterInfo {

    pub uid: Option<u32>,
    pub name: String,
    pub created: Option<String>,
    pub last_changed_time: Option<String>,
    pub version: Option<String>,
    pub license_expired: Option<bool>,
    pub nodes: Option<Vec<u32>>,
    pub databases: Option<Vec<u32>>,
    pub status: Option<String>,
    pub email_alerts: Option<bool>,
    pub rack_aware: Option<bool>,
    pub bigstore_driver: Option<String>,
    pub cnm_http_port: Option<u16>,
    pub cnm_https_port: Option<u16>,
    pub total_memory: Option<u64>,
    pub used_memory: Option<u64>,
    pub total_shards: Option<u32>,
    pub alert_settings: Option<Value>,
    pub block_cluster_changes: Option<bool>,
    pub ccs_internode_encryption: Option<bool>,
    pub cluster_api_internal_port: Option<u32>,
    pub cluster_ssh_public_key: Option<String>,
    pub cm_port: Option<u32>,
    pub cm_server_version: Option<u32>,
    pub cm_session_timeout_minutes: Option<u32>,
    pub cnm_http_max_threads_per_worker: Option<u32>,
    pub cnm_http_workers: Option<u32>,
    pub control_cipher_suites: Option<String>,
    pub control_cipher_suites_tls_1_3: Option<String>,
    pub crdb_coordinator_ignore_requests: Option<bool>,
    pub crdb_coordinator_port: Option<u32>,
    pub crdt_supported_featureset_version: Option<u32>,
    pub crdt_supported_protocol_versions: Option<Vec<String>>,
    pub created_time: Option<String>,
    pub data_cipher_list: Option<String>,
    pub data_cipher_suites_tls_1_3: Option<Vec<Value>>,
    pub debuginfo_path: Option<String>,
    pub encrypt_pkeys: Option<bool>,
    pub entra_id_cache_ttl: Option<u32>,
    pub envoy_admin_port: Option<u32>,
    pub envoy_external_authorization: Option<bool>,
    pub envoy_max_downstream_connections: Option<u32>,
    pub envoy_mgmt_server_port: Option<u32>,
    pub gossip_envoy_admin_port: Option<u32>,
    pub handle_metrics_redirects: Option<bool>,
    pub handle_redirects: Option<bool>,
    pub http_support: Option<bool>,
    pub logrotate_settings: Option<Value>,
    pub mask_bdb_credentials: Option<bool>,
    pub metrics_system: Option<u32>,
    pub min_control_tls_version: Option<String>,
    pub min_data_tls_version: Option<String>,
    pub min_sentinel_tls_version: Option<String>,
    pub module_upload_max_size_mb: Option<u32>,
    pub mtls_authorized_subjects: Option<Vec<String>>,
    pub mtls_certificate_authentication: Option<bool>,
    pub mtls_client_cert_subject_validation_type: Option<String>,
    pub multi_commands_opt: Option<String>,
    pub options_method_forbidden: Option<bool>,
    pub password_complexity: Option<bool>,
    pub password_expiration_duration: Option<u32>,
    pub password_hashing_algorithm: Option<String>,
    pub password_min_length: Option<u32>,
    pub proxy_certificate: Option<String>,
    pub reserved_ports: Option<Vec<u32>>,
    pub robust_crdt_syncer: Option<bool>,
    pub s3_certificate_verification: Option<bool>,
    pub sentinel_cipher_suites: Option<Vec<String>>,
    pub sentinel_cipher_suites_tls_1_3: Option<String>,
    pub sentinel_tls_mode: Option<String>,
    pub slave_ha: Option<bool>,
    pub slave_ha_bdb_cooldown_period: Option<u32>,
    pub slave_ha_cooldown_period: Option<u32>,
    pub slave_ha_grace_period: Option<u32>,
    pub slowlog_in_sanitized_support: Option<bool>,
    pub smtp_tls_mode: Option<String>,
    pub smtp_use_tls: Option<bool>,
    pub syncer_certificate: Option<String>,
    pub system_reserved_ports: Option<Vec<u32>>,
    pub upgrade_in_progress: Option<bool>,
    pub upgrade_mode: Option<bool>,
    pub use_external_ipv6: Option<bool>,
    pub use_ipv6: Option<bool>,
    pub wait_command: Option<bool>,
    pub extra: Value,
}

Cluster information from the REST API

Fields

uid: Option<u32>

Cluster unique ID (read-only)

name: String

Cluster’s fully qualified domain name (read-only)

created: Option<String>

Cluster creation date (read-only)

last_changed_time: Option<String>

Last changed time (read-only)

version: Option<String>

Software version

license_expired: Option<bool>

License expiration status

nodes: Option<Vec<u32>>

List of node UIDs in the cluster

databases: Option<Vec<u32>>

List of database UIDs in the cluster

status: Option<String>

Cluster status

email_alerts: Option<bool>

Enables/disables node/cluster email alerts

rack_aware: Option<bool>

Indicates if cluster operates in rack-aware mode

bigstore_driver: Option<String>

Storage engine for Auto Tiering (‘speedb’ or ‘rocksdb’)

cnm_http_port: Option<u16>

API HTTP listening port (range: 1024-65535)

cnm_https_port: Option<u16>

API HTTPS listening port (range: 1024-65535)

total_memory: Option<u64>

Total memory available in the cluster

used_memory: Option<u64>

Total memory used in the cluster

total_shards: Option<u32>

Total number of shards in the cluster

alert_settings: Option<Value>

Alert settings configuration for cluster and nodes

block_cluster_changes: Option<bool>

Whether cluster changes are currently blocked (maintenance mode)

ccs_internode_encryption: Option<bool>

Whether CCS (Cluster Configuration Store) internode encryption is enabled

cluster_api_internal_port: Option<u32>

Internal port used by the cluster API

cluster_ssh_public_key: Option<String>

SSH public key for cluster authentication

cm_port: Option<u32>

Port used by Cluster Manager (CM)

cm_server_version: Option<u32>

Version of the Cluster Manager server

cm_session_timeout_minutes: Option<u32>

Session timeout for Cluster Manager in minutes

cnm_http_max_threads_per_worker: Option<u32>

Maximum threads per worker for CNM HTTP server

cnm_http_workers: Option<u32>

Number of workers for CNM HTTP server

control_cipher_suites: Option<String>

Cipher suites for control plane TLS connections

control_cipher_suites_tls_1_3: Option<String>

Cipher suites for control plane TLS 1.3 connections

crdb_coordinator_ignore_requests: Option<bool>

Whether CRDB coordinator should ignore incoming requests

crdb_coordinator_port: Option<u32>

Port used by CRDB (Conflict-free Replicated Database) coordinator

crdt_supported_featureset_version: Option<u32>

Supported CRDT featureset version number

crdt_supported_protocol_versions: Option<Vec<String>>

List of supported CRDT protocol versions

created_time: Option<String>

Timestamp when the cluster was created

data_cipher_list: Option<String>

Cipher list for data plane connections

data_cipher_suites_tls_1_3: Option<Vec<Value>>

Cipher suites for data plane TLS 1.3 connections

debuginfo_path: Option<String>

Path to debug information files

encrypt_pkeys: Option<bool>

Whether private keys should be encrypted

entra_id_cache_ttl: Option<u32>

Time-to-live for Entra ID (Azure AD) cache in seconds

envoy_admin_port: Option<u32>

Admin port for Envoy proxy

envoy_external_authorization: Option<bool>

Whether Envoy external authorization is enabled

envoy_max_downstream_connections: Option<u32>

Maximum number of downstream connections for Envoy

envoy_mgmt_server_port: Option<u32>

Port for Envoy management server

gossip_envoy_admin_port: Option<u32>

Admin port for gossip Envoy proxy

handle_metrics_redirects: Option<bool>

Whether to handle metrics endpoint redirects

handle_redirects: Option<bool>

Whether to handle HTTP redirects

http_support: Option<bool>

Whether HTTP support is enabled (in addition to HTTPS)

logrotate_settings: Option<Value>

Configuration for log rotation

mask_bdb_credentials: Option<bool>

Whether to mask database credentials in logs

metrics_system: Option<u32>

Type of metrics system in use

min_control_tls_version: Option<String>

Minimum TLS version for control plane connections

min_data_tls_version: Option<String>

Minimum TLS version for data plane connections

min_sentinel_tls_version: Option<String>

Minimum TLS version for sentinel connections

module_upload_max_size_mb: Option<u32>

Maximum size allowed for module uploads in megabytes

mtls_authorized_subjects: Option<Vec<String>>

List of authorized subject names for mutual TLS authentication

mtls_certificate_authentication: Option<bool>

Certificate authentication mode for mutual TLS

mtls_client_cert_subject_validation_type: Option<String>

Validation type for MTLS client certificate subjects

multi_commands_opt: Option<String>

Optimization level for multi-command operations

options_method_forbidden: Option<bool>

Whether HTTP OPTIONS method is forbidden

password_complexity: Option<bool>

Requirements for password complexity

password_expiration_duration: Option<u32>

Duration in seconds before passwords expire

password_hashing_algorithm: Option<String>

Algorithm used for hashing passwords

password_min_length: Option<u32>

Minimum required length for passwords

proxy_certificate: Option<String>

Certificate used by proxy servers

reserved_ports: Option<Vec<u32>>

List of ports reserved for system use

robust_crdt_syncer: Option<bool>

Whether robust CRDT syncer mode is enabled

s3_certificate_verification: Option<bool>

Whether to verify S3 certificates

sentinel_cipher_suites: Option<Vec<String>>

Cipher suites for sentinel TLS connections

sentinel_cipher_suites_tls_1_3: Option<String>

Cipher suites for sentinel TLS 1.3 connections

sentinel_tls_mode: Option<String>

TLS mode for sentinel connections

slave_ha: Option<bool>

Whether slave high availability is enabled

slave_ha_bdb_cooldown_period: Option<u32>

Cooldown period for database slave HA in seconds

slave_ha_cooldown_period: Option<u32>

General cooldown period for slave HA in seconds

slave_ha_grace_period: Option<u32>

Grace period for slave HA operations in seconds

slowlog_in_sanitized_support: Option<bool>

Whether slowlog sanitization is supported

smtp_tls_mode: Option<String>

TLS mode for SMTP connections

smtp_use_tls: Option<bool>

Whether to use TLS for SMTP connections

syncer_certificate: Option<String>

Certificate used by syncer processes

system_reserved_ports: Option<Vec<u32>>

Ports reserved for system processes

upgrade_in_progress: Option<bool>

Whether a cluster upgrade is currently in progress

upgrade_mode: Option<bool>

Current upgrade mode for the cluster

use_external_ipv6: Option<bool>

Use external IPv6

use_ipv6: Option<bool>

Use IPv6

wait_command: Option<bool>

Wait command support

extra: Value

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClusterInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClusterInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.