You need to enable JavaScript to run this app.
导航

数据结构

最近更新时间2024.02.07 12:41:53

首次发布时间2021.11.15 16:07:17

本文汇总缓存数据库 Redis 版的 API 接口中使用的数据结构定义详情。

AccountInfo

名称类型示例值描述
AccountNameStringdefault账号名称。
DescriptionString默认账号账号描述。
InstanceIdStringredis-cn0212gzmh2xs****账号所属的实例 ID。

RoleName

String

ReadWrite

账号所属角色。支持如下默认角色:

  • Administrator:允许对所有 KEY 使用所有命令。
  • ReadWrite:允许对所有 KEY 使用除 admin 类之外的所有命令。
  • ReadOnly:允许对所有 KEY 使用 read 类中的所有命令。
  • NotDangerous:允许对所有 KEY 使用除 dangerous 类之外的所有命令。

AllowListInfo

名称类型示例值描述
AllowListDescStringtest白名单的备注。
AllowListIPNumInteger3白名单内的 IP 地址(或地址段)总数。
AllowListIdStringacl-cn02zv7944lzokt****白名单 ID。
AllowListNameStringapi_test白名单名称。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNumInteger1白名单下绑定的实例总数。

AssociatedInstanceInfo

名称类型示例值描述
InstanceIdStringredis-cn02j292it8lc****已绑定当前白名单的实例ID。
InstanceNameStringtest已绑定当前白名单的实例名称。
VPCStringvpc-1g0moeeypecjk8ibuxwu8****实例所属的私有网络 ID。

BackupInfo

名称类型示例值描述
BackupPointIdStringb-cn02xmmrp751i9cdzcphjmk4****当前备份的 ID。

BackupStrategy

String

ManualBackup

备份方式,取值范围如下:

  • ManualBackup:手动备份。
  • AutomatedBackup:自动备份。
BackupTypeStringFull备份类型。当前仅支持 Full(即全量自动备份)。
EndTimeString2021-11-11T06:06:50Z备份结束时间(UTC 时间)。
InstanceDetailStructure of InstanceDetailInfo请参见返回示例实例信息列表。更多详情,请参见数据结构
InstanceIdStringredis-cn0212gzmh2xs****实例 ID。
SizeLong0备份大小。单位:MiB。
StartTimeString2021-11-09T02:57:54Z备份开始时间(UTC 时间)。

Status

String

Available

备份状态。取值范围如下:

  • Creating:备份创建中。
  • Available:备份可用。
  • Unavailable:备份不可用。
  • Deleting:备份删除中。
BackupPointNameStringb-cn02xmmrp751i9cdzcphjmk4****当前备份的名称。
TTLInteger7备份保留天数,默认保留 7 天。
ProjectNameStringdefault备份所属的项目名称。

BackupPointDownloadUrlInfo

名称类型示例值描述
ShardIdStringserver-redis-cn0212gzmh2xs****-0RDB 文件所在的分片 ID。
PrivateDownloadUrlStringhttp://redis-dts-beijing.ivolces.com/bytedance.redis.redis-cn0212gzmh2xs****/20221226182521/0/20221226182521/0.rdb?****RDB 文件的私网下载地址。
PublicDownloadUrlStringhttp://redis-dts-beijing.volces.com/bytedance.redis.redis-cn0212gzmh2xs****/20221226182521/0/20221226182521/0.rdb?****RDB 文件的公网下载地址。
RdbFileSizeLong8359RDB 文件大小,单位:Byte。

BigKeyInfo

名称类型示例值描述
DBNameString2大 Key 所属数据库的名称。
KeyInfoStringkey:000000000015大 Key 的名称。
KeyTypeStringstring大 Key 的数据类型。

ValueLen

String

1

大 Key 中所包含的元素数量。

说明

  • String 类型的大 Key 元素数量默认为 1。
  • 非 String 类型的大 Key 会返回具体的元素数量。

ValueSize

String

10241

大 Key 的内存占用量,单位:Byte。

说明

  • String 类型的大 Key 会返回具体的内存占用量。
  • 非 String 类型的大 Key 内存占用量默认为空。

CapacityInfo

名称类型示例值描述
TotalLong1024当前实例的内存总容量。单位:MiB。
UsedLong100当前实例已用容量。单位:MiB。

InstanceInfo

名称类型示例值描述
CapacityStructure of CapacityInfo{
  "Total": 2048,
 "Used": 57
}
实例的内存容量信息。更多详情,请参见数据结构

ChargeType

String

PrePaid

计费类型,取值范围如下:

  • PostPaid:按量计费。
  • PrePaid:包年包月。

关于计费类型的更多信息,请参见按量计费包年包月

CreateTimeString2021-01-12T14:24:32Z实例的创建时间(UTC 时间)。

DeletionProtection

String

enabled

实例的删除保护功能状态。取值范围如下:

  • enabled:开启。
  • disabled:关闭。
EngineVersionString5.0Redis 版本。

ExpiredTime

String

2021-02-28T00:00:00Z

实例到期时间(UTC 时间)。

说明

仅当计费类型为 PrePaid 时返回该参数。

InstanceIdStringredis-cn0212gzmh2xs****实例 ID。
InstanceNameStringtest实例名称。
NodeNumberInteger3每个分片中的节点数。
ProjectNameStringdefault实例所属的项目名称。
RegionIdStringcn-beijing实例所属地域的地域 ID。
ShardCapacityFloat2每个分片的内存容量。单位:GiB。
ShardNumberInteger2实例中的分片数。

ShardedCluster

Integer

1

当前实例是否已启用分片集群,取值范围如下:

  • 0:不启用。
  • 1:启用。
StatusStringRunning实例状态。关于实例状态的更多信息,请参见实例状态说明
VpcIdStringvpc-rs5811nceqyov0x58x4****实例的私有网络 ID。
ZoneIdsArray of String[“cn-beijing-a”]实例所在的可用区列表。
TagsArray of TagInfo[
{
"Key": "department",
"Value": "game"
},
{
"Key": "owner",
"Value": "Alice"
}
]
实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构

InstanceClass

String

PrimarySecondary

实例类型。取值范围如下:

  • PrimarySecondary:主备实例。
  • Standalone:单节点实例。

关于实例类型的更多说明,请参见核心组件和产品架构

MultiAZ

String

disabled

设置实例的可用区部署方案。取值范围如下:

  • enabled:多可用区部署方案。
  • disabled:单可用区部署方案。

关于可用区部署方案的更多说明,请参见多可用区同城容灾解决方案

InstanceDetailInfo

名称类型示例值描述
AccountIdInteger210000****实例所属的账号 ID。

ArchType

String

Cluster

实例的架构类型。取值范围如下:

  • Standard:未启用分片集群实例。
  • Cluster:启用分片集群实例。

ChargeType

String

PrePaid

计费类型,取值范围如下:

  • PostPaid:按量计费。
  • PrePaid:包年包月。

关于计费类型的更多信息,请参见按量计费包年包月

AutoRenew

Boolean

false

实例是否已开启自动续费,取值范围如下:

  • false:不开启自动续费。
  • true:开启自动续费。

说明

仅包年包月实例(即 ChargeTypePrePaid),会返回该参数。

DeletionProtection

String

enabled

实例的删除保护功能状态。取值范围如下:

  • enabled:开启。
  • disabled:关闭。
EngineVersionString5.0Redis 版本。

ExpiredTime

String

2021-02-28T00:00:00Z

实例到期时间(UTC 时间)。

说明

仅当计费类型为 PrePaid 时返回该参数。

InstanceIdStringredis-cn0212gzmh2xs****实例 ID。
InstanceNameStringtest实例名称。
MaintenanceTimeString02:00-03:00实例的可维护时间段(UTC 时间)。关于可维护时间段的更多信息,请参见设置可维护时间段
NetworkTypeStringVPC实例的网络类型,当前仅支持私有网络 VPC 类型。
RegionIdStringcn-beijing实例所在地域。
ReplicasInteger2每个分片中的节点数。
ShardCapacityLong256每个分片的内存容量。单位:MiB。
ShardCountInteger1实例分片数。
TotalCapacityLong256实例总容量。单位:MiB。
UsedCapacityLong0当前实例已用容量。单位:MiB。
VpcInfoStructure of VpcInfo{
"ID": "vpc-3tf2ofnsmi3vj0wtaauq",
"Name": "redis-test-vpc1"
}
私有网络 VPC 信息。更多详情,请参见 VpcInfo
ZoneIdsArray of String[
"cn-beijing-a"
]
可用区列表。

InstanceShardInfo

名称类型示例值描述
ShardIdStringserver-redis-cnlf55bkfgx2s****-0分片 ID。
NodeNumberInteger2分片中的节点数量。
ServerNodesArray of ServerNodeInfo请参见返回示例分片中所有 Server 节点的详情列表。关于 ServerNodes 的详细说明,请参见数据结构

ParamInfo

名称类型示例值描述
CurrentValueString25参数当前运行值。
DefaultValueString25参数的默认值。
DescriptionString内存碎片整理占用的最大 CPU 百分比。取值范围:1~40。配置参数的描述。

EditableForInstance

Boolean

true

当前实例是否支持编辑该参数。取值范围如下:

  • true:支持。
  • false:不支持。

NeedReboot

Boolean

false

修改该配置项是否需要重启。取值范围如下:

  • true:需要重启。
  • false:不需要重启。

Options

Array of OptionInfo

null

选择器类型配置参数的可选项列表。关于 Options 的详细信息,请参见 数据结构

说明

仅当配置参数类型为选择器类型(即 TypeRadio)时,支持该参数。

ParamNameStringactive-defrag-cycle-max配置参数的名称。关于 Redis 实例支持的参数详情,请参见参数支持

Range

String

[1,40]

数值类型配置参数的取值范围。

说明

仅部分数值型的配置参数支持该参数。

Type

String

number

配置参数类型,取值范围如下:

  • radio:选择器类型。
  • number:数值类型。
  • string:字符串类型。

Unit

String

GB

数值类型配置参数的单位。

说明

仅部分数值型的配置参数支持该参数。

OptionInfo

名称类型示例值描述
ValueStringread_primary_node_only选择器类型的配置参数的可选项。
DescriptionString读请求仅发送到主节点。配置参数的可选项描述。

ParamValueInfo

名称类型示例值描述
NameStringmaxmemory-policy配置参数的名称。关于 Redis 实例支持的参数详情,请参见参数支持
ValueStringallkeys-lru配置项的参数值。

RegionInfo

名称类型示例值描述
RegionIdStringcn-beijing地域 ID。
RegionNameString华北2(北京)地域名称。

ServerNodeInfo

名称类型是否必选示例值描述
NodeIdStringserver-redis-cnlf55bkfgx2s****-0-0节点 ID。

Status

String

running

节点状态。取值范围如下:

  • deploy:启动中。
  • running:运行中。
  • loading:数据加载中。
  • error:错误。

CurrentRole

String

PrimaryNode

节点当前的角色。取值范围如下:

  • PrimaryNode:主节点。
  • SecondaryNode:从节点。
ZoneIdStringcn-beijing-a节点所在的可用区。

SlowQueryInfo

名称类型示例值描述
InstanceIdStringredis-cn02sg5o56sbs****实例 ID。
NodeIdStringproxy-redis-redis-cn02sg5o56sbs****-0慢日志所属的节点 ID。

DBName

String

0

数据库名称。

说明

仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。

UserName

String

default

账号名称。

说明

仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。

ExecutionStartTimeString2022-07-26T12:37:38Z慢查询语句的执行开始时间,格式为 yyyy-MM-ddTHH:mmZ(UTC 时间)。
QueryTextStringINFO慢查询语句。
QueryTimesInt6422073438慢查询语句执行时长,单位:微秒(μs)。

HostAddress

String

172.22.***.***:47502

发出慢查询请求的客户端地址。

说明

仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。

TagInfo

名称类型是否必选示例值描述

Key

String

department

Key 参数在不同 API 接口中作用不同,其中:

  • CreateDBInstance 请求参数中表示需要绑定标签所对应的标签键。

    说明

    • 该参数留空表示新建实例不绑定任何标签。当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。
    • 支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则,具体规则请参见标签设置规则
  • DescribeDBInstancesDescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签键。

Value

String

game

Value 参数在不同 API 接口中作用不同,其中:

  • CreateDBInstance 请求参数中表示需要绑定标签所对应的标签值。

    说明

    • 当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。
    • 最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签值需满足设置规则,具体规则请参见标签设置规则
  • DescribeDBInstancesDescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。

TagFilterInfo

名称类型是否必选示例值描述

Key

String

instancetype

用于查询筛选的标签键。

说明

  • 如需使用标签对实例进行查询筛选,该参数必填。
  • 允许传入重复的标签键。
  • 单次最多支持同时传入 10 个标签进行查询筛选。

Value

String

cluster

用于查询筛选的标签键所对应的标签值。

说明

  • 若该参数留空,表示不对标签值作限制,会筛选所有绑定了指定标签键的实例。
  • 若传入空字符串,表示筛选对应标签键下,标签值为空的实例。

TagResourceInfo

名称类型示例值描述
InstanceIdStringredis-cnlfpoc48rz7g****实例 ID。
KeyStringinstancetype实例所绑定的标签键。
ValueStringcluster实例所绑定标签键对应的值。

VisitAddressInfo

名称类型示例值描述

AddrType

String

Private

连接地址类型,取值范围如下:

  • Private:私网连接地址。
  • Public:公网连接地址。
  • DirectLink:直连地址。

    说明

    仅启用分片集群的 Redis 实例申请了直连地址后,才会返回直连地址信息。关于连接地址的更多信息,请参见连接地址类型

AddressStringredis-cn0212gzmh2xs****.redis.volcs.comIP 地址或者域名。

EipId

String

eip-2fef2qcfbfw8w5oxruw3w****

实例公网地址所绑定的 EIP ID。

说明

仅当连接地址类型(即 AddrType)为 Public 公网连接地址时,返回该参数。

PortString6379端口号。

VpcInfo

名称类型示例值描述
IDStringvpc-3tf2ofnsmi3vj0wt****专有网络 ID。
NameStringvpc_test专有网络名称。

ZoneInfo

名称类型示例值描述
ZoneIdStringcn-beijing-a可用区 ID。
ZoneNameString可用区A可用区名称。

ZoneStatus

String

1

可用区状态,取值范围如下:

  • 1:目标可用区可正常购买。
  • 2:目标可用区已售罄,不可购买。