BDB 对象

表示数据库的对象

Redis 企业软件

一个 API 对象，表示集群中的托管数据库。

名字 类型/值 & 描述
uid 整数;数据库的集群唯一 ID。可以在创建期间设置，但不能更新。
account_id 整数;SM 账户 ID
action_uid 字符串;当前正在运行的作的 UID（只读）
aof_policy 仅追加文件数据持久性
策略值：
'appendfsync-every-sec'
'appendfsync-always'
authentication_admin_pass 字符串;用于管理 BDB 的密码（用于从 BDB 进行 SYNC）
authentication_redis_pass 字符串;Redis AUTH 密码身份验证。
仅用于 Redis 数据库。对于 memcached 数据库，忽略该数据库。（从 Redis Enterprise v7.2 开始弃用，在版本 6.0.X 中替换为多个密码功能）
authentication_sasl_pass 字符串;二进制 memcache SASL 密码
authentication_sasl_uname 字符串;二进制 memcache SASL 用户名（模式不允许特殊字符 &，<，>，”）
authentication_ssl_client_certs 
[{
  "client_cert": string
}, ...]
授权客户端证书
列表 client_cert：X.509 PEM （base64） 编码证书
authentication_ssl_crdt_certs 
[{
  "client_cert": string
}, ...]
client_cert授权的 CRDT 证书
列表：X.509 PEM （base64） 编码证书
authorized_names 字符串数组;其他已认证的名称（从 Redis Enterprise v6.4.2 开始弃用;请改用 authorized_subjects）
authorized_subjects 
[{
  "CN": string,
  "O": string,
  "OU": [array of strings],
  "L": string,
  "ST": string,
  "C": string
}, ...]
在 TLS 客户端身份验证期间用于其他证书验证的有效使用者列表。所有 Subject 属性都区分大小写。
必需的主题字段：“
CN”代表通用名称
可选主题字段：“
O”代表组织
“OU”代表组织单位（字符串数组）“
L”代表地区（城市）“
ST”代表州/省“C”代表 2 个字母的国家/地区
代码
auto_upgrade 布尔值 （默认值： false）;集群升级后自动升级数据库
avoid_nodes 字符串数组;放置数据库分片并绑定其端点时要避免的集群节点 UID
background_op 自 Redis Enterprise Software v7.8.2 起已弃用。用GET /v1/actions/bdb/<bdb_uid>相反。
（只读）;progress：当前作中已完成步骤的百分比
[{
  "status": string,
  "name": string,
  "error": object,
  "progress": number
}, ...]
备份 布尔值 （默认值： false）;定期数据库备份策略
backup_failure_reason 上次备份过程失败的原因（只读）
值：
'no-permission'
'错误文件路径'
'general-error'
backup_history integer （默认值： 0）;备份历史记录保留策略（天数，0 表示永久）
backup_interval 整数;启动自动备份的时间间隔（以秒为单位）
backup_interval_offset 整数;启动自动备份时与轮次备份间隔的偏移量（以秒为单位）（应小于 backup_interval）
backup_location 复杂对象;自动数据库备份的目标。
叫GET /jsonschema检索对象的结构。
backup_progress 数字， （范围： 0-100）;数据库计划的定期备份进度（百分比）（只读）
backup_status 计划定期备份过程的状态（只读）
值：
'exporting'
'成功'
'failed'
大商店 布尔值 （默认值： false）;数据库 bigstore 选项
bigstore_ram_size integer （默认值： 0）;bigstore RAM 部分的内存大小。
bigstore_ram_weights 
[{
  "shard_uid": integer,
  "weight": number
}, ...]
分片 UID 及其 bigstore RAM 权重的列表;
shard_uid：分片 UID;
weight：RAM 分布的相对权重
client_cert_subject_validation_type 启用其他证书验证，以进一步限制在 TLS 客户端身份验证期间与具有有效证书的客户端的连接。
值：
disabled：使用有效证书对客户端进行身份验证。不强制执行其他验证。
san_cn：仅当客户端证书的公用名 （CN） 与有效使用者列表中的条目匹配时，客户端证书才有效。忽略其他 Subject 属性。
full_subject：仅当客户端证书的 Subject 属性与有效 Subject 列表中的条目匹配时，客户端证书才有效。
连接 integer （默认为 5）;内部代理连接数
conns_type 连接限制类型
Values：
'per-thread'
'per-shard'
CRDT 布尔值 （默认值： false）;使用基于 CRDT 的数据类型进行多主复制
crdt_causal_consistency 布尔值 （默认值： false）;因果一致的 CRDB。
crdt_config_version 整数;副本集配置版本，仅供内部使用。
crdt_featureset_version 整数;CRDB 活动 FeatureSet 版本
crdt_ghost_replica_ids 字符串;删除了副本 ID，仅供内部使用。
crdt_guid 字符串;此数据库所属的 CRDB 的 GUID，仅供内部使用。
crdt_modules 字符串;CRDB 模块信息。JSON 列表的字符串表示形式，包含 hashmap。
crdt_protocol_version 整数;CRDB 活动协议版本
crdt_repl_backlog_size 字符串;主动-主动复制积压大小（“auto”或大小（以字节为单位）
crdt_replica_id 整数;本地副本 ID，仅供内部使用。
crdt_replicas 字符串;副本集配置，仅供内部使用。
crdt_sources syncer_sources 对象的数组;要从中同步的 CRDB 数据库的远程端点/对等体。参见 'bdb -> replica_sources' 部分
crdt_sync 启用、禁用或暂停从指定crdt_sources同步。仅适用于主动-主动数据库。有关详细信息，请参阅 replica_sync。
值：
'enabled'，
'disabled'，
'paused'，
'stopped'
crdt_sync_connection_alarm_timeout_seconds integer （默认值： 0）;如果同步器连接到主动-主动数据库的时间超过指定的秒数，请引发连接警报
crdt_sync_dist 布尔;在 master-master 中启用/禁用分布式同步器
crdt_syncer_auto_oom_unlatch boolean （默认值： true）;Syncer 在此数据库引发 Out-Of-Memory 错误后自动尝试从 Peer 节点恢复同步。否则，同步器退出
crdt_xadd_id_uniqueness_mode XADD 严格 ID 唯一性模式。仅限 CRDT。
值：
'liberal'
'strict''
semi-strict'
created_time 字符串;创建数据库的日期和时间（只读）
data_internode_encryption 布尔;此数据库的数据平面节点间通信是否应该加密
data_persistence 数据库磁盘持久性策略。对于快照持久性，必须提供
snapshot_policy值：
'disabled'
'snapshot'
'aof'
dataset_import_sources 复杂对象;执行导入作时要从中导入的源文件位置描述对象的数组。这是只写的，设置后无法读取。
叫GET /v1/jsonschema检索对象的结构。
db_conns_auditing 布尔;启用/停用数据库连接审计
default_user boolean （默认值： true）;允许/禁止默认用户连接
disabled_commands string （默认值： ）;在 db 中禁用的 Redis 命令
dns_address_master 字符串;数据库私有地址终端节点 FQDN（只读）（自 Redis Enterprise v4.3.3 起已弃用）
email_alerts 布尔值 （默认值： false）;为此数据库发送电子邮件警报
端点 字符串;最新绑定的终端节点。通过 update 重新配置终端节点时使用
endpoint_ip 复杂对象;托管 BDB 终端节点的节点的外部 IP 地址。GET /jsonschema检索对象的结构。（只读）（自 Redis Enterprise v4.3.3 起已弃用）
endpoint_node 整数;托管 BDB 终端节点的节点 UID（只读）（自 Redis Enterprise v4.3.3 起已弃用）
端点 数组;数据库访问终端节点列表（只读）
uid：此源
的唯一标识 dns_name：终端节点的 DNS 名称
port：终端节点的 TCP 端口号
addr：终端节点的可访问地址
proxy_policy：用于代理绑定到终端节点
的策略 exclude_proxies：要排除的代理列表 include_proxies：要的
代理列表include
addr_type：指示端点是基于内部 IP 还是外部 IP
oss_cluster_api_preferred_ip_type：指示 OSS 集群 API 中的首选 IP 类型：内部/外部
oss_cluster_api_preferred_endpoint_type：指示 OSS 集群 API 中的首选端点类型：ip/hostname
enforce_client_authentication 要求对数据库的 SSL 连接的客户端证书进行身份验证。如果设置为 'enabled'，则应以 authentication_ssl_client_certs 或 authentication_ssl_crdt_certs
值提供证书：
'enabled'
'disabled'
eviction_policy 数据库驱逐策略（Redis 样式）。
值：
'volatile-lru'
'volatile-ttl'
'volatile-random'
'allkeys-lru'
'allkeys-random'
'noeviction'
'volatile-lfu'
'allkeys-lfu'Redis
数据库默认值：'volatile-lru'memcached
数据库默认值：'allkeys-lru'
export_failure_reason 上次导出过程失败的原因（只读）
值：
'no-permission'
'wrong-file-path'
'general-error'
export_progress 数字， （范围： 0-100）;数据库手动触发的导出进度（百分比）（只读）
export_status 手动触发的导出过程的状态（只读）
值：
'exporting'
'succeeded'
''failed'
generate_text_monitor 布尔;启用/禁用 syncer 监控信息的生成
gradual_src_max_sources integer （默认值： 1）;最多并行同步 N 个源（应启用 gradual_src_mode 才能使其生效）
gradual_src_mode 指示是否应激活
（同步源的）逐步同步 值：
'enabled'
'disabled'
gradual_sync_max_shards_per_source integer （默认值： 1）;每个源最多并行同步 N 个分片（应启用 gradual_sync_mode 才能生效）
gradual_sync_mode 指示是否应激活（源分片的）逐步同步（'auto' 用于自动决策）
值：
'enabled'
'disabled'
'auto'
hash_slots_policy 用于哈希槽处理
的策略 值：
'legacy'： slots range is '1-4096'
'16k'： slots range is '0-16383'
implicit_shard_key 布尔值 （默认值： false）;控制在键与任何正则表达式规则不匹配时发生的行为。
true：如果一个 key 不匹配任何规则，则整个 key 将用于哈希函数
false：如果一个 key 不匹配任何规则，将返回错误。
import_failure_reason 导入失败原因（只读）
值：
'download-error'
'file-corrupted'
'general-error'
'file-larger-than-mem-limit：<n 字节的预期数据集>：<n 字节配置的 bdb limit>'
'key-too-long'
'invalid-bulk-length'
'out-of-memory'
import_progress 数字， （范围： 0-100）;数据库导入进度（百分比）（只读）
import_status 数据库导入过程状态（只读）
值：
'idle'
'initializing'
'importing'
'succeeded'
'failed'
内部 布尔值 （默认值： false）;这是集群内部使用的数据库吗
last_backup_time 字符串;上次成功备份的时间（只读）
last_changed_time 字符串;上次管理配置更改 （只读）
last_export_time 字符串;上次成功导出的时间（只读）
max_aof_file_size 整数;分片的 AOF 文件的最大大小 （字节）。默认 300GB，（在 bigstore DB 上为 150GB）
max_aof_load_time integer （默认值： 3600）;分片的 AOF 重新加载应花费的最长时间 （秒）。
max_client_pipeline integer （默认值： 200）;每个连接的最大管道命令数。最大值为 2047。
max_connections integer （默认值： 0）;允许的最大客户端连接数（0 个无限制）
max_pipelined integer （默认值： 2000）;确定每个分片连接在代理管道中的最大命令数。
master_persistence 布尔值 （默认值： false）;如果为 true，则除了副本分片外，还保留副本分片中的复制和持久性数据库。
memory_size integer （默认值： 0）;数据库内存限制（0 表示无限制），以字节表示。
metrics_export_all 布尔;启用/禁用通过指标导出器公开所有分片指标
MKMS boolean （默认值： true）;是否支持 MKMS （Multi Key Multi Slots） 命令？
module_list 
[{
  "module_id": string,
  "module_args": [
    u'string',
    u'null'],
  "module_name": string,
  "semantic_version": string
}, ...]
与数据库

module_id关联的模块列表：模块 UID（已弃用;使用module_nameinstead）
module_args： 模块命令行参数 （模式不允许特殊字符 &，<，>，“）
module_name： 模块的名称
semantic_version： 模块的语义版本（已弃用;使用module_args相反）

module_id 和 semantic_version 自 Redis Enterprise Software v7.4.2 起是可选的，自 v7.8.2 起已弃用。
mtls_allow_outdated_certs 布尔;用于证书验证的可选 mTLS 放宽标志
mtls_allow_weak_hashing 布尔;用于证书验证的可选 mTLS 放宽标志
名字 字符串;数据库名称。只有字母、数字或连字符是有效字符。名称必须以字母或数字开头和结尾。
oss_cluster 布尔值 （默认值： false）;OSS 集群模式选项。无法启用'hash_slots_policy': 'legacy'
oss_cluster_api_preferred_endpoint_type OSS 集群 API
中的端点类型 值：
'ip'
'hostname'
oss_cluster_api_preferred_ip_type OSS 集群 API 中的内部/外部 IP 类型。新端点
的默认值 值：
'internal'
'external'
oss_sharding 布尔值 （默认值： false）;替代shard_key_regex常见的 OSS 分片哈希策略
港口 整数;数据库可用的 TCP 端口。如果省略并返回为 0，则自动生成
proxy_policy 用于代理绑定到终端节点
的默认策略 Values：
'single'
'all-master-shards'
'all-nodes'
rack_aware 布尔值 （默认值： false）;要求数据库始终跨多个机架进行复制
recovery_wait_time integer （默认值： -1）;定义在自动恢复期间等待持久性文件可用的秒数。等待时间到期后，自动恢复完成，但可能会丢失数据。默认的-1意思是永远等待。
redis_version 字符串;redis-server 进程的版本：例如 6.0、5.0-big
repl_backlog_size 字符串;Redis 复制积压大小（“auto”或大小（以字节为单位））
replica_sources syncer_sources 对象的数组;要从中同步的数据库的远程终结点。参见 'bdb -> replica_sources' 部分
replica_sync 启用、禁用或暂停从指定replica_sources
同步值：
'enabled'
'disabled'
'paused'
''stopped'
replica_sync_connection_alarm_timeout_seconds integer （默认值： 0）;如果 syncer 连接到副本所需的时间超过指定的秒数，请发出连接警报
replica_sync_dist 布尔;在 replica-of 中启用/禁用分布式同步器
复制 布尔值 （默认值： false）;内存中数据库复制模式
回复 3 boolean （默认值： true）;启用或停用 RESP3 支持
roles_permissions 
[{
  "role_uid": integer,
  "redis_acl_uid": integer
}, ...]
sched_policy 控制在将流量转发到分片时如何使用服务器端连接。
值：
cmp：最接近max_pipelined策略。选择具有最多管道命令且尚未达到 max_pipelined 限制的连接。
mru：尝试使用最近使用的连接。
spread：尝试使用所有连接。
mnp：最小管道策略。选择具有最少管道命令的连接。
shard_block_crossslot_keys 布尔值 （默认值： false）;在 Lua 脚本中，防止使用当前分片拥有的范围内不同哈希槽的键
shard_block_foreign_keys boolean （默认值： true）;在 Lua 脚本中，foreign_keys防止使用可能位于不同分片中的键（外键）
shard_key_regex 自定义基于 keyname 的分片规则。
[{"regex": string}, ...]
要使用默认规则，您应该将值设置为：
[{"regex": ".*\\{(?<tag>.*)\\}.*"}, {"regex": "(?<tag>.*)"}]
shard_list 整数数组;所有数据库分片的集群唯一 ID。
分片 布尔值 （默认值： false）;集群模式（服务器端分片）。如果为 true，则分片哈希规则必须由oss_sharding或shard_key_regex
shards_count 整数， （范围： 1-512） （默认值： 1）;数据库服务器端分片数
shards_placement 控制分片
的密度 Values：
'dense'：分片驻留在尽可能
少的节点上 'sparse'：分片驻留在尽可能多的节点上
skip_import_analyze 启用/禁用在导入 RDB 文件时
跳过分析阶段 值：
'enabled'
'disabled'
slave_buffer Redis 副本输出缓冲区限制
值：
'auto'
值（以 MB
为单位 hard：soft：time）
slave_ha 布尔;为此数据库启用副本高可用性机制（默认采用集群设置）
slave_ha_priority 整数;副本高可用性机制中 BDB 的优先级
snapshot_policy snapshot_policy 对象的数组;基于快照的数据持久性策略。如果数据集中至少有 M 次写入更改，则每 N 秒拍摄一次数据集快照
SSL协议 布尔值 （默认值： false）;需要经过 SSL 身份验证和加密的数据库连接（自 Redis Enterprise v5.0.1 起已弃用）
地位 数据库生命周期状态（只读）
值：
'pending'
、active
、change-pending、
'delete-pending'
、import-pending、
'create-failed'、
recovery'
support_syncer_reconf 布尔;确定 syncer 是否处理自己的配置更改。如果为 false，则 DMC 在配置更改时重新启动 syncer。
同步 （从 Redis Enterprise v5.0.1 开始弃用，请改用 replica_sync 或 crdt_sync）启用、禁用或暂停从指定sync_sources
同步值：
'enabled'
'disabled'
'paused'
''stopped'
sync_dedicated_threads integer （范围： 0-10） （默认值： 5）;线程的专用副本数
sync_sources 
[{
  "uid": integer,
  "uri": string,
  "compression": integer,
  "status": string,
  "rdb_transferred": integer,
  "rdb_size": integer,
  "last_update": string,
  "lag": integer,
  "last_error": string
}, ...]
（从 Redis Enterprise v5.0.1 开始弃用，改用 replica_sources 或 crdt_sources）要从中同步的数据库的远程端点。请参阅“bdb -> replica_sources”部分
uid：此源
uri 的数字唯一标识：源 Redis URI
压缩：复制链接
状态的压缩级别：此源
的同步状态 rdb_transferred：在同步阶段
从源的 RDB 传输的字节数 rdb_size：在同步阶段
要传输的源的 RDB 大小 last_update：从源
接收上次更新的时间滞后：源和目标之间的滞后（以毫秒为单位）（同步时）
last_error：从源同步时遇到的最后一个错误
syncer_log_level 要记录的最低 syncer log level 。将仅记录具有此级别或更高级别的日志。
值：
'crit'
'error'
'warn''info'

'trace'
'debug'
syncer_mode 用于数据库实例之间复制的 syncer 要么在单个节点上（集中式），要么位于根据代理策略具有代理的每个节点上（分布式）。（只读）
值：
'distributed'
'centralized'
标签 
[{
  "key": string,
  "value": string
}, ...]
附加到数据库的标记对象的可选列表。每个标签都需要一个键值对。
key：表示标签的含义，并且在标签中必须是唯一的（模式不允许特殊字符 &，<，>，“）
value：标签的值。
tls_mode 需要对数据库
进行 TLS 身份验证和加密的连接值：
'enabled'
'disabled'
'replica_ssl'
tracking_table_max_keys 整数;客户端缓存失效表大小。0 使缓存不受限制。
类型 数据库
类型 值：
'redis'
'memcached'
use_nodes 字符串数组;用于数据库分片和绑定终端节点的集群节点 UID
版本 字符串;数据库兼容版本：Redis/memcached 完整版本号，如 6.0.6。此值只能在数据库创建和数据库升级期间更改。
wait_command boolean （默认值： true）;支持 Redis 等待命令（只读）
为本页评分
返回顶部 ↑