Cluster 对象
表示集群的对象
| Redis 企业软件 |
|---|
表示集群的 API 对象。
| 名字 | 类型/值 | 描述 |
|---|---|---|
| alert_settings | alert_settings 对象 | 集群和节点警报设置 |
| bigstore_driver | 'speedb' 'rocksdb' |
用于 Auto Tiering 的存储引擎 |
| cluster_ssh_public_key | 字符串 | 集群自动生成的 SSH 公钥 |
| cm_port | 整数（范围：1024-65535） | UI HTTPS 侦听端口 |
| cm_session_timeout_minutes | integer （默认值： 15） | 与 CM 的会话的超时（以分钟为单位） |
| cnm_http_max_threads_per_worker | integer （默认值： 10） | 每个工作线程的最大线程数cnm_httpservice （已弃用） |
| cnm_http_port | 整数（范围：1024-65535） | API HTTP 侦听端口 |
| cnm_http_workers | integer （默认值： 1） | 工作线程中的 worker 数量cnm_http服务 |
| cnm_https_port | 整数（范围：1024-65535） | API HTTPS 监听端口 |
| control_cipher_suites | 字符串 | 指定为控制平面启用的密码。密码以 BoringSSL 库理解的格式指定。 |
| control_cipher_suites_tls_1_3 | 字符串 | 指定为控制平面启用的 TLS 1.3 密码。密码以 BoringSSL 库理解的格式指定。（只读） |
| crdb_coordinator_port | 整数，（范围：1024-65535）（默认值：9081） | CRDB 协调器端口 |
| crdt_rest_client_retries | 整数 | 主动-主动管理 API 使用的 REST 客户端的最大重试次数 |
| crdt_rest_client_timeout | 整数 | 主动-主动管理 API 使用的 REST 客户端超时 |
| created_time | 字符串 | 集群创建日期（只读） |
| data_cipher_list | 字符串 | 指定为数据平面启用的密码。密码以 OpenSSL 库理解的格式指定。 |
| data_cipher_suites_tls_1_3 | 字符串 | 为数据层面指定启用的 TLS 1.3 密码。 |
| debuginfo_path | 字符串 | 生成支持包时使用的本地目录的路径 |
| default_non_sharded_proxy_policy | string （默认： single） | 新创建的非分片数据库终端节点的默认proxy_policy（只读） |
| default_sharded_proxy_policy | string （默认：all-master-shards） | 新创建的分片数据库终端节点的默认proxy_policy（只读） |
| email_alerts | 布尔值 （默认值： false） | 发送节点/集群电子邮件警报（需要有效的 SMTP 和 email_from 设置） |
| email_from | 字符串 | 自动电子邮件的发件人电子邮件 |
| encrypt_pkeys | 布尔值 （默认值： false） | 启用或关闭私钥加密 |
| envoy_admin_port | 整数（范围：1024-65535） | Envoy 管理员端口。在运行时更改此端口可能会导致空响应，因为 envoy 充当集群网关。 |
| envoy_max_downstream_connections | 整数（范围：100-2048） | 允许打开的最大下游连接数 Envoy |
| envoy_mgmt_server_port | 整数（范围：1024-65535） | Envoy 管理服务器端口 |
| gossip_envoy_admin_port | 整数（范围：1024-65535） | Gossip envoy admin 端口 |
| handle_redirects | 布尔值 （默认值： false） | 处理 API HTTPS 请求并在内部重定向到主节点 |
| http_support | 布尔值 （默认值： false） | 启用或关闭 HTTP 支持 |
| min_control_TLS_version | '1.2' '1.3' |
控制路径支持的 TLS 协议的最低版本 |
| min_data_TLS_version | '1.2' '1.3' |
数据路径支持的 TLS 协议的最低版本 |
| min_sentinel_TLS_version | '1.2' '1.3' |
数据路径支持的 TLS 协议的最低版本 |
| mtls_authorized_subjects | 数组 | 必需的主题字段：“ CN”代表通用名称 可选主题字段：“ O”代表组织 “OU”代表组织单位（字符串数组）“ L”代表地区（城市）“ ST”代表州/省“C”代表 2 个字母的国家/地区 代码 |
| mtls_certificate_authentication | 布尔 | 要求对与集群的 mTLS 连接的客户端证书进行身份验证。应将 API_CA 证书配置为先决条件。 |
| mtls_client_cert_subject_validation_type | disabledsan_cnfull_subject |
启用其他证书验证，以进一步限制在 TLS 客户端身份验证期间与具有有效证书的客户端的连接。 值： disabled：使用有效证书对客户端进行身份验证。不强制执行其他验证。 san_cn：仅当客户端证书的公用名 （CN） 与有效使用者列表中的条目匹配时，客户端证书才有效。忽略其他 Subject 属性。 full_subject：仅当客户端证书的 Subject 属性与有效 Subject 列表中的条目匹配时，客户端证书才有效。 |
| 名字 | 字符串 | 集群的完全限定域名（只读） |
| password_complexity | 布尔值 （默认值： false） | 强制实施密码复杂性策略 |
| password_expiration_duration | integer （默认值： 0） | 密码在需要用户替换之前有效的天数 |
| password_min_length | 整数 （范围： 8-256） （默认值： 8） | 密码所需的最小长度。 |
| proxy_certificate | 字符串 | 集群的代理证书 |
| proxy_max_ccs_disconnection_time | 整数 | 代理和 CCS 之间的集群范围代理超时策略 |
| rack_aware | 布尔 | Cluster 以机架感知模式（只读）运行 |
| reserved_ports | 字符串数组 | 要避免用于数据库终端节点的保留端口和/或端口范围的列表（例如"reserved_ports": ["11000", "13000-13010"]) |
| s3_url | 字符串 | 指定 S3 导出和导入的 URL |
| saslauthd_ldap_conf | 字符串 | saslauthd LDAP 配置 |
| sentinel_cipher_suites | 数组 | 指定为 Sentinel 服务启用的密码列表。支持的密码是由 cipher_suites.go 软件包实现的密码。 |
| sentinel_cipher_suites_tls_1_3 | 字符串 | 指定为发现 （sentinel） 服务启用的 TLS 1.3 密码列表。支持的密码是由 cipher_suites.go 软件包实现的密码。（只读） |
| sentinel_tls_mode | '允许' '禁用' '必需' |
确定发现服务是允许、阻止还是需要 TLS 连接（以前命名为sentinel_ssl_policy)allowed： 允许同时允许 TLS 和非 TLS 连接 disabled： 仅允许非 TLS 连接 required： 仅允许 TLS 连接 |
| slave_ha | 布尔值 （默认值： false） | 启用副本高可用性机制（只读） |
| slave_ha_bdb_cooldown_period | integer （默认值： 86400） | 在同一数据库的不同节点上运行副本高可用性机制之间的时间（以秒为单位）（只读） |
| slave_ha_cooldown_period | 整数 （默认值： 3600） | 在不同节点上运行副本高可用性机制之间的时间（以秒为单位）（只读） |
| slave_ha_grace_period | 整数 （默认值： 900） | 节点故障与副本高可用性机制开始重新定位分片之间的时间（以秒为单位）（只读） |
| slowlog_in_sanitized_support | 布尔 | 是否在已清理的支持包中包含 slowlogs |
| smtp_host | 字符串 | 用于自动电子邮件的 SMTP 服务器 |
| smtp_password | 字符串 | SMTP 服务器密码 |
| smtp_port | 整数 | 用于自动电子邮件的 SMTP 服务器端口 |
| smtp_tls_mode | '无' 'starttls'' TLS' |
指定要用于 SMTP 访问的 TLS 模式 |
| smtp_use_tls | 布尔值 （默认值： false） | 使用 TLS 进行 SMTP 访问（从 Redis Enterprise v4.3.3 开始弃用，请改用 smtp_tls_mode 字段） |
| smtp_username | 字符串 | SMTP 服务器用户名（模式不允许特殊字符 &，<，>，”） |
| syncer_certificate | 字符串 | 集群的 syncer 证书 |
| upgrade_mode | 布尔值 （默认值： false） | 群集当前是否处于升级模式 |
| use_external_ipv6 | boolean （默认值： true） | redislabs 服务应该监听 IPv6 吗 |
| use_ipv6 | boolean （默认值： true） | redislabs 服务是否应该监听 IPv6（从 Redis Enterprise v6.4.2 开始弃用，替换为 use_external_ipv6） |
| wait_command | boolean （默认值： true） | 支持 Redis 等待命令（只读） |