文档中心

数据结构

最近更新时间：2024.04.12 14:10:17

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

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

AccountInfo

名称	类型	示例值	描述
AccountName	String	default	账号名称。
Description	String	默认账号	账号描述。
InstanceId	String	redis-cn0212gzmh2xs****	账号所属的实例 ID。
RoleName	String	ReadWrite	账号所属角色。支持如下默认角色： `Administrator`：允许对所有 KEY 使用所有命令。 `ReadWrite`：允许对所有 KEY 使用除 `admin` 类之外的所有命令。 `ReadOnly`：允许对所有 KEY 使用 `read` 类中的所有命令。 `NotDangerous`：允许对所有 KEY 使用除 `dangerous` 类之外的所有命令。

AllowListInfo

名称	类型	示例值	描述
AllowListDesc	String	test	白名单的备注。
AllowListIPNum	Integer	3	白名单内的 IP 地址（或地址段）总数。
AllowListId	String	acl-cn02zv7944lzokt****	白名单 ID。
AllowListName	String	api_test	白名单名称。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNum	Integer	1	白名单下绑定的实例总数。

AssociatedInstanceInfo

名称	类型	示例值	描述
InstanceId	String	redis-cn02j292it8lc****	已绑定当前白名单的实例ID。
InstanceName	String	test	已绑定当前白名单的实例名称。
VPC	String	vpc-1g0moeeypecjk8ibuxwu8****	实例所属的私有网络 ID。

BackupInfo

名称	类型	示例值	描述
BackupPointId	String	b-cn02xmmrp751i9cdzcphjmk4****	当前备份的 ID。
BackupStrategy	String	ManualBackup	备份方式，取值范围如下： `ManualBackup`：手动备份。 `AutomatedBackup`：自动备份。
BackupType	String	Full	备份类型。当前仅支持 `Full`（即全量自动备份）。
EndTime	String	2021-11-11T06:06:50Z	备份结束时间（UTC 时间）。
InstanceDetail	Structure of InstanceDetailInfo	请参见返回示例。	实例信息列表。更多详情，请参见数据结构。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
Size	Long	0	备份大小。单位：MiB。
StartTime	String	2021-11-09T02:57:54Z	备份开始时间（UTC 时间）。
Status	String	Available	备份状态。取值范围如下： `Creating`：备份创建中。 `Available`：备份可用。 `Unavailable`：备份不可用。 `Deleting`：备份删除中。
BackupPointName	String	b-cn02xmmrp751i9cdzcphjmk4****	当前备份的名称。
TTL	Integer	7	备份保留天数，默认保留 7 天。
ProjectName	String	default	备份所属的项目名称。

BackupPointDownloadUrlInfo

名称	类型	示例值	描述
ShardId	String	server-redis-cn0212gzmh2xs****-0	RDB 文件所在的分片 ID。
PrivateDownloadUrl	String	http://redis-dts-beijing.ivolces.com/bytedance.redis.redis-cn0212gzmh2xs**/20221226182521/0/20221226182521/0.rdb?**	RDB 文件的私网下载地址。
PublicDownloadUrl	String	http://redis-dts-beijing.volces.com/bytedance.redis.redis-cn0212gzmh2xs**/20221226182521/0/20221226182521/0.rdb?**	RDB 文件的公网下载地址。
RdbFileSize	Long	8359	RDB 文件大小，单位：Byte。

BigKeyInfo

名称	类型	示例值	描述
DBName	String	2	大 Key 所属数据库的名称。
KeyInfo	String	key:000000000015	大 Key 的名称。
KeyType	String	string	大 Key 的数据类型。
ValueLen	String	1	大 Key 中所包含的元素数量。说明 String 类型的大 Key 元素数量默认为 1。非 String 类型的大 Key 会返回具体的元素数量。
ValueSize	String	10241	大 Key 的内存占用量，单位：Byte。说明 String 类型的大 Key 会返回具体的内存占用量。非 String 类型的大 Key 内存占用量默认为空。

CapacityInfo

名称	类型	示例值	描述
Total	Long	1024	当前实例的内存总容量。单位：MiB。
Used	Long	100	当前实例已用容量。单位：MiB。

InstanceInfo

名称	类型	示例值	描述
Capacity	Structure of CapacityInfo	{ "Total": 2048, "Used": 57 }	实例的内存容量信息。更多详情，请参见数据结构。
ChargeType	String	PrePaid	计费类型，取值范围如下： `PostPaid`：按量计费。 `PrePaid`：包年包月。关于计费类型的更多信息，请参见按量计费和包年包月。
CreateTime	String	2021-01-12T14:24:32Z	实例的创建时间（UTC 时间）。
DeletionProtection	String	enabled	实例的删除保护功能状态。取值范围如下： `enabled`：开启。 `disabled`：关闭。
EngineVersion	String	5.0	Redis 版本。
ExpiredTime	String	2021-02-28T00:00:00Z	实例到期时间（UTC 时间）。说明仅当计费类型为 `PrePaid` 时返回该参数。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
InstanceName	String	test	实例名称。
NodeNumber	Integer	3	每个分片中的节点数。
ProjectName	String	default	实例所属的项目名称。
RegionId	String	cn-beijing	实例所属地域的地域 ID。
ShardCapacity	Float	2	每个分片的内存容量。单位：GiB。
ShardNumber	Integer	2	实例中的分片数。
ShardedCluster	Integer	1	当前实例是否已启用分片集群，取值范围如下： `0`：不启用。 `1`：启用。
Status	String	Running	实例状态。关于实例状态的更多信息，请参见实例状态说明。
VpcId	String	vpc-rs5811nceqyov0x58x4****	实例的私有网络 ID。
ZoneIds	Array of String	[“cn-beijing-a”]	实例所在的可用区列表。
Tags	Array of TagInfo	[ { "Key": "department", "Value": "game" }, { "Key": "owner", "Value": "Alice" } ]	实例已绑定的标签信息。关于 Tags 的更多说明，请参见数据结构。
InstanceClass	String	PrimarySecondary	实例类型。取值范围如下： `PrimarySecondary`：主备实例。 `Standalone`：单节点实例。关于实例类型的更多说明，请参见核心组件和产品架构。
MultiAZ	String	disabled	设置实例的可用区部署方案。取值范围如下： `enabled`：多可用区部署方案。 `disabled`：单可用区部署方案。关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。

InstanceDetailInfo

名称	类型	示例值	描述
AccountId	Integer	210000****	实例所属的账号 ID。
ArchType	String	Cluster	实例的架构类型。取值范围如下： `Standard`：未启用分片集群实例。 `Cluster`：启用分片集群实例。
ChargeType	String	PrePaid	计费类型，取值范围如下： `PostPaid`：按量计费。 `PrePaid`：包年包月。关于计费类型的更多信息，请参见按量计费和包年包月。
AutoRenew	Boolean	false	实例是否已开启自动续费，取值范围如下： `false`：不开启自动续费。 `true`：开启自动续费。说明仅包年包月实例（即 `ChargeType` 为 `PrePaid`），会返回该参数。
DeletionProtection	String	enabled	实例的删除保护功能状态。取值范围如下： `enabled`：开启。 `disabled`：关闭。
EngineVersion	String	5.0	Redis 版本。
ExpiredTime	String	2021-02-28T00:00:00Z	实例到期时间（UTC 时间）。说明仅当计费类型为 `PrePaid` 时返回该参数。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
InstanceName	String	test	实例名称。
MaintenanceTime	String	02:00-03:00	实例的可维护时间段（UTC 时间）。关于可维护时间段的更多信息，请参见设置可维护时间段。
NetworkType	String	VPC	实例的网络类型，当前仅支持私有网络 VPC 类型。
RegionId	String	cn-beijing	实例所在地域。
Replicas	Integer	2	每个分片中的节点数。
ShardCapacity	Long	256	每个分片的内存容量。单位：MiB。
ShardCount	Integer	1	实例分片数。
TotalCapacity	Long	256	实例总容量。单位：MiB。
UsedCapacity	Long	0	当前实例已用容量。单位：MiB。
VpcInfo	Structure of VpcInfo	{ "ID": "vpc-3tf2ofnsmi3vj0wtaauq", "Name": "redis-test-vpc1" }	私有网络 VPC 信息。更多详情，请参见数据结构。
ZoneIds	Array of String	[ "cn-beijing-a" ]	可用区列表。

InstanceShardInfo

名称	类型	示例值	描述
ShardId	String	server-redis-cnlf55bkfgx2s****-0	分片 ID。
NodeNumber	Integer	2	分片中的节点数量。
ServerNodes	Array of ServerNodeInfo	请参见返回示例。	分片中所有 Server 节点的详情列表。关于 `ServerNodes` 的详细说明，请参见数据结构。

ParamInfo

名称	类型	示例值	描述
CurrentValue	String	25	参数当前运行值。
DefaultValue	String	25	参数的默认值。
Description	String	内存碎片整理占用的最大 CPU 百分比。取值范围：1~40。	配置参数的描述。
EditableForInstance	Boolean	true	当前实例是否支持编辑该参数。取值范围如下： `true`：支持。 `false`：不支持。
NeedReboot	Boolean	false	修改该配置项是否需要重启。取值范围如下： `true`：需要重启。 `false`：不需要重启。
Options	Array of OptionInfo	null	选择器类型配置参数的可选项列表。关于 `Options` 的详细信息，请参见数据结构。说明仅当配置参数类型为选择器类型（即 `Type` 为 `Radio`）时，支持该参数。
ParamName	String	active-defrag-cycle-max	配置参数的名称。关于 Redis 实例支持的参数详情，请参见参数支持。
Range	String	[1,40]	数值类型配置参数的取值范围。说明仅部分数值型的配置参数支持该参数。
Type	String	number	配置参数类型，取值范围如下： `radio`：选择器类型。 `number`：数值类型。 `string`：字符串类型。
Unit	String	GB	数值类型配置参数的单位。说明仅部分数值型的配置参数支持该参数。

OptionInfo

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

ParamValueInfo

名称	类型	示例值	描述
Name	String	maxmemory-policy	配置参数的名称。关于 Redis 实例支持的参数详情，请参见参数支持。
Value	String	allkeys-lru	配置项的参数值。

RegionInfo

名称	类型	示例值	描述
RegionId	String	cn-beijing	地域 ID。
RegionName	String	华北2（北京）	地域名称。

ServerNodeInfo

名称	类型	示例值	描述
NodeId	String	server-redis-cnlf55bkfgx2s****-0-0	节点 ID。
Status	String	running	节点状态。取值范围如下： `deploy`：启动中。 `running`：运行中。 `loading`：数据加载中。 `error`：错误。
CurrentRole	String	PrimaryNode	节点当前的角色。取值范围如下： `PrimaryNode`：主节点。 `SecondaryNode`：从节点。
ZoneId	String	cn-beijing-a	节点所在的可用区。

SlowQueryInfo

名称	类型	示例值	描述
InstanceId	String	redis-cn02sg5o56sbs****	实例 ID。
NodeId	String	proxy-redis-redis-cn02sg5o56sbs****-0	慢日志所属的节点 ID。
DBName	String	0	数据库名称。说明仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空（即 `-`）。
UserName	String	default	账号名称。说明仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空（即 `-`）。
ExecutionStartTime	String	2022-07-26T12:37:38Z	慢查询语句的执行开始时间，格式为 `yyyy-MM-ddTHH:mmZ`（UTC 时间）。
QueryText	String	INFO	慢查询语句。
QueryTimes	Integer	22073438	慢查询语句执行时长，单位：微秒（μs）。
HostAddress	String	172.22.*.*:47502	发出慢查询请求的客户端地址。说明仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空（即 `-`）。

TagInfo

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

名称	类型	是否必选	示例值	描述
Key	String	是	department	`Key` 参数在不同 API 接口中作用不同，其中：在 CreateDBInstance 请求参数中表示需要绑定标签所对应的标签键。说明该参数留空表示新建实例不绑定任何标签。当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签键。
Value	String	否	game	`Value` 参数在不同 API 接口中作用不同，其中：在 CreateDBInstance 请求参数中表示需要绑定标签所对应的标签值。说明当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签值需满足设置规则，具体规则请参见标签设置规则。在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。

Key

String

是

department

Key 参数在不同 API 接口中作用不同，其中：

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

Value

String

否

game

Value 参数在不同 API 接口中作用不同，其中：

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

TagFilterInfo

名称	类型	是否必选	示例值	描述
Key	String	是	instancetype	用于查询筛选的标签键。说明如需使用标签对实例进行查询筛选，该参数必填。允许传入重复的标签键。单次最多支持同时传入 10 个标签进行查询筛选。
Value	String	否	cluster	用于查询筛选的标签键所对应的标签值。说明若该参数留空，表示不对标签值作限制，会筛选所有绑定了指定标签键的实例。若传入空字符串，表示筛选对应标签键下，标签值为空的实例。

TagResourceInfo

名称	类型	示例值	描述
InstanceId	String	redis-cnlfpoc48rz7g****	实例 ID。
Key	String	instancetype	实例所绑定的标签键。
Value	String	cluster	实例所绑定标签键对应的值。

VisitAddressInfo

名称	类型	示例值	描述
AddrType	String	Private	连接地址类型，取值范围如下： `Private`：私网连接地址。 `Public`：公网连接地址。 `DirectLink`：直连地址。说明仅启用分片集群的 Redis 实例申请了直连地址后，才会返回直连地址信息。关于连接地址的更多信息，请参见连接地址类型。
Address	String	redis-cn0212gzmh2xs****.redis.volcs.com	IP 地址或者域名。
EipId	String	eip-2fef2qcfbfw8w5oxruw3w****	实例公网地址所绑定的 EIP ID。说明仅当连接地址类型（即 `AddrType`）为 `Public` 公网连接地址时，返回该参数。
Port	String	6379	端口号。
VIP	String	10.249.*.*	连接地址所对应的 IP 地址。

VpcInfo

名称	类型	示例值	描述
ID	String	vpc-3tf2ofnsmi3vj0wt****	专有网络 ID。
Name	String	vpc_test	专有网络名称。

ZoneInfo

名称类型示例值描述

ZoneId String cn-beijing-a 可用区 ID。

ZoneName String 可用区A 可用区名称。

名称	类型	示例值	描述
ZoneId	String	cn-beijing-a	可用区 ID。
ZoneName	String	可用区A	可用区名称。
ZoneStatus	String	1	可用区状态，取值范围如下： `1`：目标可用区可正常购买。 `2`：目标可用区已售罄，不可购买。

ZoneStatus

String

可用区状态，取值范围如下：

1：目标可用区可正常购买。
2：目标可用区已售罄，不可购买。