API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云数据库 KeeWiDB>数据结构

数据结构

最近更新时间：2025-03-07 01:19:52

我的收藏

本页目录：

BackupInfo

实例的备份信息

被如下接口引用：DescribeInstanceBackups。

名称 类型 描述
StartTime String 备份开始时间。
示例值："2022-03-24 11:52:20"
BackupId String 备份 ID。
示例值："999b6b89c60-f01a-11eb-9d37-7d65897b5c22"
BackupType String 备份类型。
  • 1：手动备份，指根据业务运维排障需求，立即执行备份任务的操作。
  • 0：自动备份，指根据自动备份策略定时自动发起的备份任务。
  • 2：生成RDB，指根据业务需求，发起的生成文件为rdb类型的备份任务。

示例值："1"
Remark String 备份的备注信息.
示例值：备份测试
Status Integer 备份状态。
  • 1：备份任务被其它流程锁定。
  • 2：备份正常，没有被任何流程锁定。
  • -1：备份已过期。
  • 3：备份正在被导出。
  • 4：备份导出成功。

示例值：2
Locked Integer 备份是否被锁定。
  • 0：未被锁定。
  • 1：已被锁定。

示例值：0

BinlogInfo

实例增量备份信息

被如下接口引用：DescribeInstanceBackups, DescribeInstanceBinlogs。

名称 类型 描述
StartTime String 备份开始时间。
示例值："2022-03-24 11:52:20"
EndTime String 备份结束时间。
示例值："2022-03-24 12:52:20"
BackupId String 备份 ID。
示例值："999b6b89c60"
Filename String 备份文件名。
示例值："test"
FileSize Integer 备份文件大小，单位：Byte。
示例值：106924

Inbound

安全组入站规则

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称 类型 描述
Action String 策略，ACCEPT或者DROP。
示例值：ACCEPT
AddressModule String 地址组id代表的地址集合。
示例值：set
CidrIp String 来源Ip或Ip段，例如192.168.0.0/16。
示例值：0.0.0.0/0
Desc String 描述。
示例值：XX上云安全组默认入站规则
IpProtocol String 网络协议，支持udp、tcp等。
示例值：ALL
PortRange String 端口。
示例值：ALL
ServiceModule String 服务组id代表的协议和端口集合。
示例值：keewidb
Id String 安全组id代表的地址集合。
示例值：set

InstanceEnumParam

实例枚举类型参数描述，keewidb暂无枚举值

被如下接口引用：DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名
示例值：lazyfree-lazy-eviction
ValueType String 参数类型：enum
示例值：enum
NeedRestart String 修改后是否需要重启：true，false
示例值：false
DefaultValue String 参数默认值
示例值：yes
CurrentValue String 当前运行参数值
示例值：yes
Tips String 参数说明
示例值：lazyfree switch on eviction
EnumValue Array of String 参数可取值
示例值：["yes", "no"]
Status Integer 参数状态, 1: 修改中， 2：修改完成
示例值：2

InstanceInfo

实例详细信息

被如下接口引用：DescribeInstances。

名称 类型 描述
InstanceName String 实例名称。
示例值：实例1
InstanceId String 实例 ID。
示例值：kee-7asi981q
Appid Integer 用户的Appid。
示例值：121100000
ProjectId Integer 项目 ID。
示例值：12
RegionId Integer 地域ID。
  • 1：广州。
  • 4：上海。
  • 8：北京。

示例值：1
ZoneId Integer 可用区 ID。
示例值：100001
VpcId Integer VPC 网络 ID， 如：75101。该参数当前暂保留，可忽略。
示例值：75101
Status Integer 实例当前状态。
  • 0：待初始化。
  • 1：实例在流程中。
  • 2：实例运行中。
  • -2：实例已隔离。
  • -3：实例待删除。

示例值：2
SubnetId Integer VPC 网络下子网 ID， 如：46315。该参数当前暂保留，可忽略。
示例值：10
WanIp String 实例 VIP。
示例值：10.20.3.1
Port Integer 实例端口号。
示例值：6379
Createtime String 实例创建时间。
示例值：2022-01-15 10:20:00
Size Float 实例持久内存总容量大小，单位：MB。
示例值：1451
Type Integer 实例类型。
  • 13：标准版。
  • 14：集群版。

示例值：14
AutoRenewFlag Integer 实例是否设置自动续费标识。
  • 1：设置自动续费。
  • 0：未设置自动续费。

示例值：1
DeadlineTime String 实例到期时间。
示例值：2022-02-15 10:20:00
Engine String 存储引擎。
示例值：TendisV2_Storage
ProductType String 产品类型。
  • standalone ：标准版。
  • cluster ：集群版。

示例值：cluster
UniqVpcId String VPC 网络 ID， 如：vpc-fk33jsf4****。
示例值：vpc-fk33jsf43kgv
UniqSubnetId String VPC 网络下子网 ID，如：subnet-fd3j6l3****。
示例值：subnet-fd3j6l35mm0
BillingMode Integer 计费模式。
  • 0：按量计费。
  • 1：包年包月。

示例值：1
InstanceTitle String 实例运行状态描述：如”实例运行中“。
示例值：实例运行中
OfflineTime String 计划下线时间。
示例值：2022-02-15 10:20:00
SubStatus Integer 流程中的实例，返回子状态。
示例值：0
Tags Array of String 反亲和性标签
示例值：anti-affinity: "true"
RedisShardSize Integer 分片大小。
示例值：4096
RedisShardNum Integer 分片数量。
示例值：3
RedisReplicasNum Integer 副本数量。
示例值：1
PriceId Integer 计费 ID。
示例值：102638
CloseTime String 隔离时间。
示例值：0000-00-00 00:00:00
SlaveReadWeight Integer 从节点读取权重。
示例值：1
InstanceTags Array of InstanceTagInfo 实例关联的标签信息。
ProjectName String 项目名称。
示例值：Default
NoAuth Boolean 是否为免密实例；
  • true：免密实例。
  • false：非免密实例。

示例值：true
ClientLimit Integer 客户端连接数。
示例值：30000
DtsStatus Integer DTS状态（内部参数，用户可忽略）。
示例值：0
NetLimit Integer 分片带宽上限，单位 MB。
示例值：1800
PasswordFree Integer 免密实例标识（内部参数，用户可忽略）。
示例值：0
ReadOnly Integer 实例只读标识（内部参数，用户可忽略）。
示例值：0
Vip6 String 内部参数，用户可忽略。
示例值：2001:0db8:85a3:0000:0000:8a2e:0370:7334
RemainBandwidthDuration String 内部参数，用户可忽略。
示例值：内部参数，用户可忽略。
DiskSize Integer 实例的磁盘容量大小。
示例值：400
MonitorVersion String 监控版本。
  • 1m：分钟粒度监控。
  • 5s：5秒粒度监控。

示例值：5s
ClientLimitMin Integer 客户端最大连接数可设置的最小值。
示例值：1000
ClientLimitMax Integer 客户端最大连接数可设置的最大值。
示例值：10000
NodeSet Array of NodeInfo 实例的节点详细信息。
注意：此字段可能返回 null，表示取不到有效值。
Region String 实例所在的地域信息，比如ap-guangzhou。
示例值：ap-guangzhou
MachineMemory Integer 实例内存容量，单位：GB。KeeWiDB 内存容量
示例值：4
DiskShardSize Integer 单分片磁盘大小，单位：MB
示例值：143360
DiskShardNum Integer 3
示例值：磁盘分片数
DiskReplicasNum Integer 1
示例值：磁盘副本数
Compression String 数据压缩开关。
  • ON：开启。
  • OFF：关闭。

示例值：ON

InstanceIntegerParam

实例整型参数描述

被如下接口引用：DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名
示例值：cluster-node-timeout
ValueType String 参数类型：integer
示例值：integer
NeedRestart String 修改后是否需要重启：true，false
示例值：false
DefaultValue String 参数默认值
示例值：15000
CurrentValue String 当前运行参数值
示例值：15000
Tips String 参数说明
示例值：集群模式下当节点在指定时间内(毫秒)不可达则被认为处于失败状态
Min String 参数最小值
示例值：15000
Max String 参数最大值
示例值：120000
Status Integer 参数状态, 1: 修改中， 2：修改完成
示例值：2
Unit String 参数单位
示例值：ms

InstanceMultiParam

实例多选项类型参数描述

被如下接口引用：DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名
示例值：cluster-node-timeout
ValueType String 参数类型：multi
示例值：integer
NeedRestart String 修改后是否需要重启：true，false
示例值：true
DefaultValue String 参数默认值
示例值：15000
CurrentValue String 当前运行参数值
示例值：15000
Tips String 参数说明
示例值：Cluster node timeout is the amount of milliseconds a node must be unreachable for it to be considered in failure state
EnumValue Array of String 参数说明
示例值：["12000","15000"]
Status Integer 参数状态, 1: 修改中， 2：修改完成
示例值：1

InstanceNodeInfo

实例节点信息

被如下接口引用：DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String 节点ID
示例值：edcfcc21cef97eabbbeeb52067de8eddffc85772
NodeRole String 节点角色
示例值：master

InstanceParam

实例参数

被如下接口引用：ModifyInstanceParams。

名称 类型 必选 描述
Key String 是 设置参数的名字
示例值：cluster-node-timeout
Value String 是 设置参数的值
示例值：15000

InstanceParamHistory

实例参数修改历史

被如下接口引用：DescribeInstanceParamRecords。

名称 类型 描述
ParamName String 参数名称
示例值：cluster-node-timeout
PreValue String 修改前值
示例值：15000
NewValue String 修改后值
示例值：16000
Status Integer 状态：1-参数配置修改中；2-参数配置修改成功；3-参数配置修改失败
示例值：2
ModifyTime String 修改时间
示例值：2024-12-02 10:52:47

InstanceProxySlowlogDetail

代理慢查询详情

被如下接口引用：DescribeProxySlowLog。

名称 类型 描述
Duration Integer 慢查询耗时
示例值：524
Client String 客户端地址
示例值：218.89..
Command String 命令
示例值：zremrangebyscore
CommandLine String 详细命令行信息
示例值：zremrangebyscore myzset 2 3
ExecuteTime String 执行时间
示例值：2024-12-24 18:43:11

InstanceTagInfo

实例标签信息

被如下接口引用：DescribeInstances。

名称 类型 必选 描述
TagKey String 否 标签键
示例值：key1
TagValue String 否 标签值
示例值：value1

InstanceTextParam

实例字符型参数描述

被如下接口引用：DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名
示例值：slowlog-max-len
ValueType String 参数类型：text
示例值：text
NeedRestart String 修改后是否需要重启：true，false
示例值：true
DefaultValue String 参数默认值
示例值：128
CurrentValue String 当前运行参数值
示例值：128
Tips String 参数说明
示例值：Cluster node timeout is the amount of milliseconds a node must be unreachable for it to be considered in failure state
TextValue Array of String 参数可取值
示例值：0-1024
Status Integer 参数状态, 1: 修改中， 2：修改完成
示例值：2

KeeWiDBNode

KeeWiDB节点的运行信息

被如下接口引用：DescribeInstanceReplicas。

名称 类型 描述
NodeId String 节点的序列ID。
示例值：b69eda124a34c1b713e81f7cb947161b06214328
Status String 节点的状态。
示例值：Normal
Role String 节点角色。
示例值：master

NodeInfo

描述实例的主节点或者副本节点信息

被如下接口引用：DescribeInstances。

名称 类型 必选 描述
NodeType Integer 是 节点类型，0 为主节点，1 为副本节点
示例值：1
NodeId Integer 否 主节点或者副本节点的ID，创建时不需要传递此参数。
示例值：1
ZoneId Integer 否 主节点或者副本节点的可用区ID
示例值：100001
ZoneName String 否 主节点或者副本节点的可用区名称
示例值：ap-guangzhou-1

Outbound

安全组出站规则

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称 类型 描述
Action String 策略，ACCEPT或者DROP。
示例值：DROP
AddressModule String 地址组id代表的地址集合。
示例值：set
CidrIp String 来源Ip或Ip段，例如192.168.0.0/16。
示例值：9.9.0.0/16
Desc String 描述。
示例值：**上云安全组默认入站规则
IpProtocol String 网络协议，支持udp、tcp等。
示例值：ALL
PortRange String 端口。
示例值：6379
ServiceModule String 服务组id代表的协议和端口集合。
示例值：keewidb
Id String 安全组id代表的地址集合。
示例值：set

ProductConf

产品规格信息

被如下接口引用：DescribeProductInfo。

名称 类型 描述
Type Integer 产品类型，13-KeewiDB标准架构，14-KeewiDB集群架构
示例值：14
TypeName String KeewiDB标准架构，KeewiDB集群架构
示例值：KeewiDB集群架构
MinBuyNum Integer 购买时的最小数量
示例值：1
MaxBuyNum Integer 购买时的最大数量
示例值：5
Saleout Boolean 产品是否售罄
示例值：false
Engine String 产品引擎，keewidb
示例值：keewidb
Version String 兼容版本，Redis-2.8，Redis-3.2，Redis-4.0
示例值：Redis-4.0
ReplicaNum Array of String 副本数量
示例值：["1"]
PayMode String 支持的计费模式，1-包年包月，0-按量计费
示例值："1"

ProxyNodeInfo

Proxy节点信息

被如下接口引用：DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String 节点ID
示例值：c70aa82ff684f36f8fe8b7c61cb77e568**

RedisNodeInfo

Redis节点信息

被如下接口引用：DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String 节点ID
示例值：edcfcc21cef97eabbbeeb52067de8eddffc85772
NodeRole String 节点角色
示例值：master
ClusterId Integer 分片ID
示例值：1
ZoneId Integer 可用区ID
示例值：100002

RegionConf

地域售卖信息

被如下接口引用：DescribeProductInfo。

名称 类型 描述
RegionId String 地域ID
示例值：ap-guangzhou
RegionName String 地域名称
示例值：广州
RegionShortName String 地域简称
示例值：GZ
Area String 地域所在大区名称
示例值：华南地区
ZoneSet Array of ZoneCapacityConf 可用区信息
示例值：[]

ReplicaGroup

实例副本组信息

被如下接口引用：DescribeInstanceReplicas。

名称 类型 描述
GroupId Integer 节点 ID。
示例值：125101
GroupName String 节点组的名称，主节点为空。
示例值：ng-1
ZoneId String 节点的可用区ID，比如ap-guangzhou-1。
示例值：ap-guangzhou-1
Role String 节点组角色。
  • master：为主节点。
  • replica：为副本节点。

示例值：master
KeeWiDBNodes Array of KeeWiDBNode 节点组节点列表。

ResourceTag

实例绑定标签

被如下接口引用：CreateInstances。

名称 类型 必选 描述
TagKey String 是 标签 Key。
示例值：key1
TagValue String 是 标签 Value。
示例值：value1

SecurityGroup

安全组规则

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称 类型 描述
CreateTime String 创建时间，时间格式：yyyy-mm-dd hh:mm:ss。
示例值：2019-09-05 14:52:30
ProjectId Integer 项目ID。
示例值：11100
SecurityGroupId String 安全组ID。
示例值：sg-ep0g9***
SecurityGroupName String 安全组名称。
示例值：安全组名称-放开外网
SecurityGroupRemark String 安全组备注。
示例值：禁止使用-有安全风险
Outbound Array of Outbound 出站规则。
Inbound Array of Inbound 入站规则。

TaskInfoDetail

任务信息详情

被如下接口引用：DescribeTaskList。

名称 类型 描述
TaskId Integer 任务Id
示例值：16481
StartTime String 开始时间
示例值：2022-03-12 15:06:23
TaskType String 任务类型
示例值：FLOW_BACKUPINSTANCE
InstanceName String 实例名称
示例值：实例1
InstanceId String 实例Id
示例值：kee-4hyqewjs
ProjectId Integer 项目Id
示例值：0
Progress Float 任务进度
示例值：0
EndTime String 结束时间
示例值：2022-03-12 15:08:23
Result Integer 任务状态
示例值：0
OperatorUin String 操作者用户uin
示例值：10112432xxx

TendisSlowLogDetail

实例慢查询详情

被如下接口引用：DescribeTendisSlowLog。

名称 类型 描述
ExecuteTime String 执行时间
示例值：2024-12-25 13:43:08
Duration Integer 慢查询耗时（毫秒）
示例值：197
Command String 命令
示例值：ZADD
CommandLine String 详细命令行信息
示例值：ZADD students 95 "Alice"
Node String 节点ID
示例值：6fd96ca18603e1fd05c48ec6f99a69cc89**

TradeDealDetail

订单交易信息

被如下接口引用：DescribeInstanceDealDetail。

名称 类型 描述
DealId String 订单号ID，调用云API时使用此ID
示例值：192314****
DealName String 长订单ID，反馈订单问题给官方客服使用此ID
示例值：2024112**
ZoneId Integer 可用区id
示例值：100002
GoodsNum Integer 订单关联的实例数
示例值：1
Creater String 创建用户uin
示例值：10001464****
CreatTime String 订单创建时间
示例值：2024-11-25 18:12:34
OverdueTime String 订单超时时间
示例值：2024-12-10 18:12:34
EndTime String 订单完成时间
示例值：2024-11-25 18:30:34
Status Integer 订单状态 1：未支付 2:已支付，未发货 3:发货中 4:发货成功 5:发货失败 6:已退款 7:已关闭订单 8:订单过期 9:订单已失效 10:产品已失效 11:代付拒绝 12:支付中
示例值：4
Description String 订单状态描述
示例值：发货中
Price Float 订单实际总价，单位：分
示例值：1039
InstanceIds Array of String 实例ID
示例值：100035,100036

ZoneCapacityConf

可用区内产品售卖信息

被如下接口引用：DescribeProductInfo。

名称 类型 描述
ZoneId String 可用区ID
示例值：ap-guangzhou-3
ZoneName String 可用区名称
示例值：广州三区
IsSaleout Boolean 可用区是否售罄
示例值：false
IsDefault Boolean 是否为默认可用区
示例值：false
NetWorkType Array of String 网络类型：basenet -- 基础网络；vpcnet -- VPC网络
示例值：["vpcnet"]
ProductSet Array of ProductConf 产品规格等信息
示例值：[]
OldZoneId Integer Int类型可用区ID
示例值：100003
中国站
文档活动
message-icon联系我们
目录