数据结构

最近更新时间: 2026-04-10 00:03:39

CommandTake

命令耗时

被如下接口引用:DescribeInstanceMonitorTopNCmdTook

名称 必选 允许NULL 类型 描述
Cmd String 命令
示例值:
Took Int64 耗时
示例值:

InstanceSet

实例详细信息列表

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
InstanceName String 实例名称
示例值:
InstanceId String 实例Id
示例值:
Appid Int64 用户的Appid
示例值:
ProjectId Int64 项目Id
示例值:
RegionId Int64 地域id 1--广州 4--上海 5-- 中国香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)16--成都 17--德国 18--韩国 19--重庆 21--印度 22--美东(弗吉尼亚)23--泰国 24--俄罗斯 25--日本
示例值:
ZoneId Int64 区域id
示例值:
VpcId Int64 vpc网络id 如:75101
示例值:
SubnetId Int64 vpc网络下子网id 如:46315
示例值:
Status Int64 实例当前状态,0:待初始化;1:实例在流程中;2:实例运行中;-2:实例已隔离;-3:实例待删除
示例值:
WanIp String 实例vip
示例值:
Port Int64 实例端口号
示例值:
Createtime String 实例创建时间
示例值:
Size Float 实例容量大小,单位:MB
示例值:
SizeUsed Float 该字段已废弃
示例值:
Type Int64 实例类型,1:Redis2.8集群版;2:Redis2.8主从版;3:CKV主从版(Redis3.2);4:CKV集群版(Redis3.2);5:Redis2.8单机版;6:Redis4.0主从版;7:Redis4.0集群版;
示例值:
AutoRenewFlag Int64 实例是否设置自动续费标识,1:设置自动续费;0:未设置自动续费
示例值:
DeadlineTime String 实例到期时间
示例值:
Engine String 引擎:社区版Redis、云CKV
示例值:
ProductType String 产品类型:Redis2.8集群版、Redis2.8主从版、Redis3.2主从版(CKV主从版)、Redis3.2集群版(CKV集群版)、Redis2.8单机版、Redis4.0集群版
示例值:
UniqVpcId String vpc网络id 如:vpc-fk33jsf43kgv
示例值:
UniqSubnetId String vpc网络下子网id 如:subnet-fd3j6l35mm0
示例值:
BillingMode Int64 计费模式:0-按量计费,1-包年包月
示例值:
InstanceTitle String 实例运行状态描述:如”实例运行中“
示例值:
OfflineTime String 计划下线时间
示例值:
SubStatus Int64 流程中的实例,返回子状态
示例值:
Tags Array of String 反亲和性标签
示例值:
InstanceNode Array of InstanceNode 实例节点信息
示例值:查看
RedisShardSize Int64 分片大小
示例值:
RedisShardNum Int64 分片数量
示例值:
RedisReplicasNum Int64 副本数量
示例值:
PriceId Int64 计费Id
示例值:
CloseTime String 隔离时间
示例值:
SlaveReadWeight Int64 从节点读取权重
示例值:
InstanceTags Array of InstanceTagInfo 实例关联的标签信息
示例值:查看
ProjectName String 项目名称
示例值:
NoAuth Bool 是否为免密实例,true-免密实例;false-非免密实例
示例值:
ClientLimit Int64 客户端连接数
示例值:
DtsStatus Int64 DTS状态(内部参数,用户可忽略)
示例值:
NetLimit Int64 分片带宽上限,单位MB
示例值:
PasswordFree Int64 免密实例标识(内部参数,用户可忽略)
示例值:
ReadOnly Int64 实例只读标识(内部参数,用户可忽略)
示例值:
Vip6 String 内部参数,用户可忽略
示例值:
RemainBandwidthDuration String 内部参数,用户可忽略
示例值:

InstanceTagInfo

实例标签信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
TagKey String 标签键
示例值:
TagValue String 标签值
示例值:

DelayDistribution

延时分布详情

被如下接口引用:DescribeInstanceMonitorBigKeySizeDist、DescribeInstanceMonitorTookDist

名称 必选 允许NULL 类型 描述
Ladder Int64 分布阶梯
示例值:
Size Int64 大小
示例值:

RedisNodeInfo

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

被如下接口引用:CreateInstances

名称 必选 允许NULL 类型 描述
NodeId Int64 主节点或者副本节点的ID,创建时不需要传递此参数。
示例值:
NodeType Int64 节点类型,0 为主节点,1 为副本节点
示例值:
ZoneId Uint64 主节点或者副本节点的可用区ID
示例值:
ZoneName String 主节点或者副本节点的可用区名称
示例值:

BigKeyTypeInfo

大Key类型分布详情

被如下接口引用:DescribeInstanceMonitorBigKeyTypeDist

名称 必选 允许NULL 类型 描述
Type String 类型
示例值:
Count Int64 数量
示例值:
Size Int64 大小
示例值:
Updatetime Int64 时间戳
示例值:

BackupDownloadInfo

备份下载信息

被如下接口引用:DescribeBackupUrl

名称 必选 允许NULL 类型 描述
FileName String 文件名
示例值:
FileSize Int64 文件大小
示例值:
DownloadUrl String 下载地址
示例值:
InnerDownloadUrl String 内部下载地址
示例值:

InstanceIntegerParam

实例整型参数描述

被如下接口引用:DescribeInstanceParams

名称 必选 允许NULL 类型 描述
ParamName String 参数名
示例值:
ValueType String 参数类型:integer
示例值:
NeedRestart String 修改后是否需要重启:true,false
示例值:
DefaultValue String 参数默认值
示例值:
CurrentValue String 当前运行参数值
示例值:
Tips String 参数说明
示例值:
Min String 参数最小值
示例值:
Max String 参数最大值
示例值:
Status Int64 参数状态, 1: 修改中, 2:修改完成
示例值:

TagInfo

Tag信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
TagKey String TagKey
示例值:
TagValue String TagValue
示例值:

Inbound

安全组入站规则

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称 必选 允许NULL 类型 描述
Action String 策略,ACCEPT或者DROP。
示例值:
AddressModule String 地址组id代表的地址集合。
示例值:
CidrIp String 来源Ip或Ip段,例如192.168.0.0/16。
示例值:
Desc String 描述。
示例值:
IpProtocol String 网络协议,支持udp、tcp等。
示例值:
PortRange String 端口。
示例值:
ServiceModule String 服务组id代表的协议和端口集合。
示例值:
Id String 安全组id代表的地址集合。
示例值:

SecurityGroupsInboundAndOutbound

安全组出入规则

被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup

名称 必选 允许NULL 类型 描述
Action String 执行动作
示例值:
Ip String IP地址
示例值:
Port String 端口号
示例值:
Proto String 协议类型
示例值:

InstanceParamHistory

实例参数修改历史

被如下接口引用:DescribeInstanceParamRecords

名称 必选 允许NULL 类型 描述
ParamName String 参数名称
示例值:
PreValue String 修改前值
示例值:
NewValue String 修改后值
示例值:
Status Int64 状态:1-参数配置修改中;2-参数配置修改成功;3-参数配置修改失败
示例值:
ModifyTime String 修改时间
示例值:

TendisNodes

tendis节点信息

被如下接口引用:DescribeInstanceNodeInfo

名称 必选 允许NULL 类型 描述
NodeId String 节点ID
示例值:
NodeRole String 节点角色
示例值:

RedisNodes

Redis节点信息

被如下接口引用:DescribeInstanceNodeInfo

名称 必选 允许NULL 类型 描述
NodeId String 节点ID
示例值:
NodeRole String 节点角色
示例值:
ClusterId Int64 分片ID
示例值:
ZoneId Int64 可用区ID
示例值:

Tags

是否为虚拟机

被如下接口引用:AddMachine、DescribeMachine

名称 必选 允许NULL 类型 描述
IsVm String 是否为虚拟机
示例值:

ResourceTagApi

实例标签

被如下接口引用:CreateInstances

名称 必选 允许NULL 类型 描述
TagKey String tagKey
示例值:
TagValue String tagValue
示例值:

InstanceParam

实例参数

被如下接口引用:CreateParamTemplate、ModifyInstanceParams、ModifyParamTemplate

名称 必选 允许NULL 类型 描述
Key String 设置参数的名字
示例值:
Value String 设置参数的值
示例值:

InstanceClusterShard

实例分片列表信息

被如下接口引用:DescribeInstanceShards

名称 必选 允许NULL 类型 描述
ShardName String 分片节点名称
示例值:
ShardId String 分片节点Id
示例值:
Role Int64 角色
示例值:
Keys Int64 Key数量
示例值:
Slots String slot信息
示例值:
Storage Int64 使用容量
示例值:
StorageSlope Float 容量倾斜率
示例值:
Runid String 实例运行时节点Id
示例值:
Connected Int64 服务状态:0-down;1-on
示例值:

RedisBackupSet

实例的备份数组

被如下接口引用:DescribeInstanceBackups

名称 必选 允许NULL 类型 描述
StartTime String 开始备份的时间
示例值:
BackupId String 备份ID
示例值:
BackupType String 备份类型。 manualBackupInstance:用户发起的手动备份; systemBackupInstance:凌晨系统发起的备份
示例值:
Status Int64 备份状态。  1:"备份被其它流程锁定";  2:"备份正常,没有被任何流程锁定";  -1:"备份已过期"; 3:"备份正在被导出";  4:"备份导出成功"
示例值:
Remark String 备份的备注信息
示例值:
Locked Int64 备份是否被锁定,0:未被锁定;1:已被锁定
示例值:
FullBackup Int64 0-全量备份,1-增量备份
示例值:
InstanceType Int64 实例类型
示例值:
BackupSize Int64 备份大小
示例值:
EndTime String 备份结束时间
示例值:
FileType String 备份文件类型根据实例类型对应
示例值:
ExpireTime String 文件过期时间,空表示不过期
示例值:

SecurityGroupDetail

安全组详情

被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup

名称 必选 允许NULL 类型 描述
ProjectId Int64 项目Id
示例值:
CreateTime String 创建时间
示例值:
SecurityGroupId String 安全组Id
示例值:
SecurityGroupName String 安全组名称
示例值:
SecurityGroupRemark String 安全组标记
示例值:
InboundRule Array of SecurityGroupsInboundAndOutbound 安全组入站规则
示例值:查看
OutboundRule Array of SecurityGroupsInboundAndOutbound 安全组出站规则
示例值:查看

ParameterDetail

Redis参数模板参数详情

被如下接口引用:DescribeParamTemplateInfo

名称 必选 允许NULL 类型 描述
Name String 参数名称。
示例值:
ParamType String 参数类型。
示例值:
Default String 参数默认值。
示例值:
Description String 参数描述。
示例值:
CurrentValue String 参数当前值。
示例值:
NeedReboot Int64 修改参数后,是否需要重启数据库以使参数生效。 - 0:不需要重启。 - 1:需要重启。
示例值:
Max String 参数允许的最大值。
示例值:
Min String 参数允许的最小值。
示例值:
EnumValue String 参数可选枚举值。如果为非枚举参数,则为空。
示例值:

InstanceSecurityGroupDetail

实例安全组信息

被如下接口引用:DescribeInstanceSecurityGroup

名称 必选 允许NULL 类型 描述
InstanceId String 实例Id
示例值:
SecurityGroupDetails Array of SecurityGroupDetail 安全组信息
示例值:查看

InstanceClusterNode

实例节点类型

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Name String 节点名称
示例值:
RunId String 实例运行时节点Id
示例值:
Role Int64 集群角色:0-master;1-slave
示例值:
Status Int64 节点状态:0-readwrite, 1-read, 2-backup
示例值:
Connected Int64 服务状态:0-down;1-on
示例值:
CreateTime String 节点创建时间
示例值:
DownTime String 节点下线时间
示例值:
Slots String 节点slot分布
示例值:
Keys Int64 节点key分布
示例值:
Qps Int64 节点qps
示例值:
QpsSlope Float 节点qps倾斜度
示例值:
Storage Int64 节点存储
示例值:
StorageSlope Float 节点存储倾斜度
示例值:

SecurityGroup

安全组规则

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称 必选 允许NULL 类型 描述
CreateTime String 创建时间,时间格式:yyyy-mm-dd hh:mm:ss。
示例值:
ProjectId Uint64 项目ID。
示例值:
SecurityGroupId String 安全组ID。
示例值:
SecurityGroupName String 安全组名称。
示例值:
SecurityGroupRemark String 安全组备注。
示例值:
Outbound Array of Outbound 出站规则。
示例值:查看
Inbound Array of Inbound 入站规则。
示例值:查看

SourceCommand

访问命令

被如下接口引用:DescribeInstanceMonitorTopNCmd

名称 必选 允许NULL 类型 描述
Cmd String 命令
示例值:
Count Int64 执行次数
示例值:

InstanceSlowlogDetail

慢查询详情

被如下接口引用:DescribeSlowLog

名称 必选 允许NULL 类型 描述
Duration Int64 慢查询耗时
示例值:
Client String 客户端地址
示例值:
Command String 命令
示例值:
CommandLine String 详细命令行信息
示例值:
ExecuteTime String 执行时间
示例值:

RegionConf

地域信息

被如下接口引用:DescribeProductInfo

名称 必选 允许NULL 类型 描述
RegionId String 地域ID
示例值:
RegionName String 地域名称
示例值:
RegionShortName String 地域简称
示例值:
Area String 地域所在大区名称
示例值:
ZoneSet Array of ZoneCapacityConf 可用区信息
示例值:查看

ParamTemplateInfo

参数模板信息

被如下接口引用:DescribeDefaultParamTemplates、DescribeParamTemplates

名称 必选 允许NULL 类型 描述
TemplateId String 参数模板 ID。
示例值:
Name String 参数模板名称。
示例值:
Description String 参数模板描述。
示例值:
ProductType Uint64 6:Redis 4.0内存版(标准架构)。 7:Redis 4.0内存版(集群架构)。 8:Redis 5.0内存版(标准架构)。 9:Redis 5.0内存版(集群架构)
示例值:

InstanceMultiParam

实例多选项类型参数描述

被如下接口引用:DescribeInstanceParams

名称 必选 允许NULL 类型 描述
ParamName String 参数名
示例值:
ValueType String 参数类型:multi
示例值:
NeedRestart String 修改后是否需要重启:true,false
示例值:
DefaultValue String 参数默认值
示例值:
CurrentValue String 当前运行参数值
示例值:
Tips String 参数说明
示例值:
EnumValue Array of String 参数说明
示例值:
Status Int64 参数状态, 1: 修改中, 2:修改完成
示例值:

TaskInfoDetail

任务信息详情

被如下接口引用:DescribeTaskList

名称 必选 允许NULL 类型 描述
TaskId Int64 任务Id
示例值:
StartTime String 开始时间
示例值:
TaskType String 任务类型
示例值:
InstanceName String 实例名称
示例值:
InstanceId String 实例Id
示例值:
ProjectId Int64 项目Id
示例值:
Progress Float 任务进度
示例值:
EndTime String 结束时间
示例值:
Result Int64 任务状态
示例值:

HotKeyInfo

热Key详细信息

被如下接口引用:DescribeInstanceMonitorHotKey

名称 必选 允许NULL 类型 描述
Key String 热Key
示例值:
Type String 类型
示例值:
Count Int64 数量
示例值:

Machines

机器

被如下接口引用:DescribeMachine

名称 必选 允许NULL 类型 描述
MachineIP String 设备IP
示例值:
Zone String 可用区
示例值:
EngineRoom String 机房
示例值:
Chassis String 机架信息
示例值:
MachineInterface Int64 机器总进程数
示例值:
Switcher String 交换机
示例值:
MachineType String cache/proxy
示例值:
Remark String 设备备注
示例值:
MemorySize Int64 设备内存
示例值:
MemoryInUse Int64 使用内存
示例值:
ProcessNumber Int64 进程数
示例值:
Status Int64 设备状态: 1 启用 0 禁用
示例值:
Tags Tags 是否是虚拟机
示例值:查看
IsVm Bool 是否是虚拟机
示例值:
PoolName String poolname
示例值:
PoolArch String poolarch
示例值:
PoolId String poolid
示例值:
Grocery String Grocery
示例值:

SingleResourcePoolInfo

资源池信息

被如下接口引用:DescribeResourcePools

名称 必选 允许NULL 类型 描述
PoolId String PoolId
示例值:
PoolName String PoolName
示例值:
PoolArch String PoolArch
示例值:
Status Int64 Status
示例值:
MachineList Array of String 0:init 1:use 2:disable -2:delete
示例值:
ProxyNum Int64 ProxyNum
示例值:
CacheNum Int64 CacheNum
示例值:
TotalMem Float TotalMem
示例值:
UseMem Int64 UseMem
示例值:
CreateTime String CreateTime
示例值:
Region Int64 Region
示例值:
Zone Int64 Zone
示例值:
Grocery Int64 Grocery
示例值:
GroceryName String GroceryName
示例值:

InstanceTextParam

实例字符型参数描述

被如下接口引用:DescribeInstanceParams

名称 必选 允许NULL 类型 描述
ParamName String 参数名
示例值:
ValueType String 参数类型:text
示例值:
NeedRestart String 修改后是否需要重启:true,false
示例值:
DefaultValue String 参数默认值
示例值:
CurrentValue String 当前运行参数值
示例值:
Tips String 参数说明
示例值:
TextValue Array of String 参数可取值
示例值:
Status Int64 参数状态, 1: 修改中, 2:修改完成
示例值:

Outbound

安全组出站规则

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称 必选 允许NULL 类型 描述
Action String 策略,ACCEPT或者DROP。
示例值:
AddressModule String 地址组id代表的地址集合。
示例值:
CidrIp String 来源Ip或Ip段,例如192.168.0.0/16。
示例值:
Desc String 描述。
示例值:
IpProtocol String 网络协议,支持udp、tcp等。
示例值:
PortRange String 端口。
示例值:
ServiceModule String 服务组id代表的协议和端口集合。
示例值:
Id String 安全组id代表的地址集合。
示例值:

InstanceEnumParam

实例枚举类型参数描述

被如下接口引用:DescribeInstanceParams

名称 必选 允许NULL 类型 描述
ParamName String 参数名
示例值:
ValueType String 参数类型:enum
示例值:
NeedRestart String 修改后是否需要重启:true,false
示例值:
DefaultValue String 参数默认值
示例值:
CurrentValue String 当前运行参数值
示例值:
Tips String 参数说明
示例值:
EnumValue Array of String 参数可取值
示例值:
Status Int64 参数状态, 1: 修改中, 2:修改完成
示例值:

ZoneCapacityConf

可用区内产品信息

被如下接口引用:DescribeProductInfo

名称 必选 允许NULL 类型 描述
ZoneId String 可用区ID:如ap-guangzhou-3
示例值:
ZoneName String 可用区名称
示例值:
IsSaleout Bool 可用区是否售罄
示例值:
IsDefault Bool 是否为默认可用区
示例值:
NetWorkType Array of String 网络类型:basenet -- 基础网络;vpcnet -- VPC网络
示例值:
ProductSet Array of ProductConf 可用区内产品规格等信息
示例值:查看
OldZoneId Int64 可用区ID:如100003
示例值:

Account

子账号信息

被如下接口引用:DescribeInstanceAccount

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID
示例值:
AccountName String 账号名称(如果是主账号,名称为root)
示例值:
Remark String 账号描述信息
示例值:
Privilege String 读写策略:r-只读,w-只写,rw-读写
示例值:
ReadonlyPolicy Array of String 路由策略:master-主节点,replication-从节点
示例值:
Status Int64 子账号状态:1-账号变更中,2-账号有效,-4-账号已删除
示例值:

TradeDealDetail

订单交易信息

被如下接口引用:DescribeInstanceDealDetail

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

InstanceNode

实例节点

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Id Int64 Id
示例值:
InstanceClusterNode Array of InstanceClusterNode 节点详细信息
示例值:查看

InstanceGreyStrategyData

实例灰度策略信息

被如下接口引用:InstanceGreyStrategy

名称 必选 允许NULL 类型 描述
Proxy Int64 代理
示例值:
Clientlist Int64 客户端列表
示例值:
Switch Int64 切换
示例值:

ProxyNodes

Proxy节点信息

被如下接口引用:DescribeInstanceNodeInfo

名称 必选 允许NULL 类型 描述
NodeId String 节点ID
示例值:

Grocerys

仓库信息

被如下接口引用:AddResourcePool、DisableResourcePool、EnableResourcePool、OfflineResourcePool

名称 必选 允许NULL 类型 描述
Region String 地区
示例值:
Zone String 区域
示例值:
Grocery String 仓库
示例值:

ProductConf

产品信息

被如下接口引用:DescribeProductInfo

名称 必选 允许NULL 类型 描述
Type Int64 产品类型,2-Redis主从版,3-CKV主从版,4-CKV集群版,5-Redis单机版,7-Redis集群版
示例值:
TypeName String 产品名称,Redis主从版,CKV主从版,CKV集群版,Redis单机版,Redis集群版
示例值:
MinBuyNum Int64 购买时的最小数量
示例值:
MaxBuyNum Int64 购买时的最大数量
示例值:
Saleout Bool 产品是否售罄
示例值:
Engine String 产品引擎,TX云CKV或者社区版Redis
示例值:
Version String 兼容版本,Redis-2.8,Redis-3.2,Redis-4.0
示例值:
TotalSize Array of String 规格总大小,单位G
示例值:
ShardSize Array of String 每个分片大小,单位G
示例值:
ReplicaNum Array of String 副本数量
示例值:
ShardNum Array of String 分片数量
示例值:
PayMode String 支持的计费模式,1-包年包月,0-按量计费
示例值:
EnableRepicaReadOnly Bool 是否支持副本只读
示例值:

ResourcePoolInfo

ResourcePoolInfo

被如下接口引用:DescribeResourcePools

名称 必选 允许NULL 类型 描述
PoolName String PoolName
示例值:
Info Array of SingleResourcePoolInfo Info
示例值:查看

BigKeyInfo

大Key详情

被如下接口引用:DescribeInstanceMonitorBigKey

名称 必选 允许NULL 类型 描述
DB Int64 所属的database
示例值:
Key String 大Key
示例值:
Type String 类型
示例值:
Size Int64 大小
示例值:
Updatetime Int64 数据时间戳
示例值: