数据结构

最近更新时间: 2024-09-11 15:04:59

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

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 产品引擎,腾讯云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 是否支持副本只读

RegionConf

地域信息

被如下接口引用:DescribeProductInfo

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

ChargeStandard

阶梯计费列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
ChargeDesc String 价格描述,主要表示04天 415天这种阶梯描述
Price Float 价格
ChargeUnit String 价格单位 hour or month

BigKeyTypeInfo

大Key类型分布详情

被如下接口引用:DescribeInstanceMonitorBigKeyTypeDist

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

GoodsDetail

商品详情

被如下接口引用:

名称 必选 允许NULL 类型 描述
MemSize Int64 实例容量, 单位:MB
TimeSpan Int64 购买时长, 单位以:timeUnit为准
TimeUnit Int64 购买时长单位, m- 月, d - 天
RedisIds Array of String 关联的redisId列表
CurDeadline String 续费前,实例到期时间

DescribeInstanceDTSInstanceInfo

详细DTS实例信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionId Int64 地域ID
InstanceId String 实例ID
SetId Int64 仓库ID
ZoneId Int64 可用区ID
Type Int64 实例类型
InstanceName String 实例名称
Vip String 实例访问地址
Status Int64 状态

ZoneCapacity

区域不同类型的Redis的容量 Type int64 json:"Type" // 配置类型, 1 集群版, 2 单机版 TypeName string json:"TypeName" // 类型名称: 集群版, 单机版 MinMemSize int64 json:"MinMemSize" // 单位MB MaxMemSize int64 json:"MaxMemSize" // 单位MB MinBuyNum int64 json:"MinBuyNum" MaxBuyNum int64 json:"MaxBuyNum" Saleout bool json:"Saleout" //是否售罄

被如下接口引用:

名称 必选 允许NULL 类型 描述
TypeName String 实例类型名称
Type Int64 实例类型,1 – 集群版;2 – 主从版;3-新一代主从版
Saleout Bool 是否售罄
MaxBuyNum Int64 单次购买的最小实例数
MinBuyNum Int64 单次购买的最大实例数
Engine String 引擎:社区版Redis,腾讯云CKV
Version String 版本:Redis-2.8,Redis-3.2,Redis-4.0
Sizes Array of String 售卖规格大小,单位:G
DumpNumber Array of String 副本数量

DelayDistribution

延时分布详情

被如下接口引用:DescribeInstanceMonitorBigKeySizeDist、DescribeInstanceMonitorTookDist

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

SlowlogDetail

慢日志信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
ExecTime String 执行时间
Duration Int64 执行持续时间
Command String 执行命令
CmdLine String 执行整个命令

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代表的地址集合。

CommandTake

命令耗时

被如下接口引用:DescribeInstanceMonitorTopNCmdTook

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

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 节点存储倾斜度

SourceInfo

访问来源信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Ip String 来源IP
Conn Int64 连接数
Cmd Int64 命令

TendisNodes

tendis节点信息

被如下接口引用:DescribeInstanceNodeInfo

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

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-账号已删除

RedisRegion

地域列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionId Int64 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)
RegionCityNameEn String 地域英文名
RegionCityNameCn String 地域中文名
RegionCityNameLong String 地域完整信息

SecurityGroupsInboundAndOutbound

安全组出入规则

被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup

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

DealDetailsGoodsDetail

货物订单详细信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
CurDeadline String 当前截至时间
MemSize Float 实例大小
OldMemSize Float 实例原大小
NewMemsize Float 实例当前大小
TimeSpan Float 时间长度
TimeUnit String 时间单位
RedisIds Array of String 实例ID集合

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 文件过期时间,空表示不过期

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:修改完成

InstanceSets

实例详细信息列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
InstanceName String 实例名称
InstanceId String 实例Id
Appid Int64 用户Appid
ProjectId Int64 项目Id
RegionId Int64 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)
ZoneId Int64 区域Id
VpcId Int64 vpc网络id 如:75101
SubnetId Int64 vpc网络下子网id 如:46315
Status Int64 实例当前状态,0:待初始化;1:实例在流程中;2:实例运行中;-2:实例已隔离
WanIp String 实例Vip
Port Int64 实例端口号
Createtime String 实例创建时间
Size Float 实例容量大小,单位:MB
SizeUsed Float 实例当前已使用容量,单位:MB
Type Int64 实例类型,1:集群版;2:主从版
AutoRenewFlag Int64 实例是否设置自动续费标识,1:设置自动续费;0:未设置自动续费
DeadlineTime String 实例到期时间
Engine String 引擎:社区版Redis、腾讯云CKV
ProductType String 产品类型:Redis2.8集群版、Redis2.8主从版、Redis3.2主从版、Redis3.2集群版、Redis2.8单机版、Redis4.0集群版
UniqVpcId String vpc网络id 如:vpc-fk33jsf43kgv
UniqSubnetId String vpc网络下子网id 如:subnet-fd3j6l35mm0

InstanceParamHistory

实例参数修改历史

被如下接口引用:DescribeInstanceParamRecords

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

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 入站规则。

HotKeyInfo

热Key详细信息

被如下接口引用:DescribeInstanceMonitorHotKey

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

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:修改完成

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代表的地址集合。

InstanceTagInfo

实例标签信息

被如下接口引用:DescribeInstances

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

RegionConfDeprecated

地域配置

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionId String 地域Id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)
Zones Array of ZoneCapacityTypeConf 地域包含的区域
RegionName String 地域名称
RegionShortName String 地域简称
Area String 地域所在大区名称
ZoneSet Array of ZoneCapacityConf 可用区信息

SecurityGroupDetail

安全组详情

被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup

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

BackupDownloadInfo

备份下载信息

被如下接口引用:DescribeBackupUrl

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

BigKeyInfo

大Key详情

被如下接口引用:DescribeInstanceMonitorBigKey

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

InstanceGreyStrategyData

实例灰度策略信息

被如下接口引用:InstanceGreyStrategy

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

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:修改完成

InstanceSlowlogDetail

慢查询详情

被如下接口引用:DescribeSlowLog

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

RedisNodes

Redis节点信息

被如下接口引用:DescribeInstanceNodeInfo

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

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

InstanceSecurityGroupDetail

实例安全组信息

被如下接口引用:DescribeInstanceSecurityGroup

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

InstanceParam

实例参数

被如下接口引用:ModifyInstanceParams

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

Regions

Regions列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionId Int64 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)
RegionCityNameEn String 地域名字(英文)
RegionCityNameCn String 地域名字(中文)
RegionCityNameLong String 地域城市

InstanceGreyStrategyData2

实例灰度信息

被如下接口引用:

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

RedisInstancePerf

实例性能信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
RedisId String 实例ID
MaxQps Float 最大QPS
Qps Array of Float QPS
Connection Array of Float 连接个数
TotalCount Int64 数据条件
IsTruncate Bool 是否数据被截断
SlowLogs Array of SlowlogDetail 慢日志详细信息数组

InstanceNode

实例节点

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Id Int64 Id
InstanceClusterNode Array of InstanceClusterNode 节点详细信息

SourceCommand

访问命令

被如下接口引用:DescribeInstanceMonitorTopNCmd

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

ZoneCapacityTypeConf

Zone配置

被如下接口引用:

名称 必选 允许NULL 类型 描述
ZoneId Int64 可用区id
ZoneName String 可用区名称
Saleout Bool 是否售罄
IsDefault Bool 是否默认区域
ZoneCapacity Array of ZoneCapacity 实例类型数组

TaskInfoDetail

任务信息详情

被如下接口引用:DescribeTaskList

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

ProxyNodes

Proxy节点信息

被如下接口引用:DescribeInstanceNodeInfo

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

TaskInfo

任务信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
StartTime String 任务的提交时间,格式如: 2017-02-10 16:56:18
TaskType String 任务类型定义为 : '001':task_newInstance:新建实例 '002':task_resizeInstance:升级实例的任务 '004':task_cleanInstance:清空实例的任务; '006':task_deleteInstance:删除实例 '007':task_setPassword':设置密码 '008':task_importRdb:导入Rdb的任务; '009':task_exportBackup:导出备份的任务; '010':task_restoreBackup:恢复实例的任务; '011':task_restoreStream:回档实例的任务(集群版实例可回档3天内任意时间点,但是,最近10分钟的数据不可回档); '012':task_backupInstance:备份实例的任务;
RedisName String 实例名称
RedisId String 实例ID
ProjectId Int64 实例所属的项目ID
Status Int64 任务执行状态,0:待执行;1:执行中;2:成功;3:失败;-1 执行出错
Progress Float 任务执行进度,0:未完成;1:已完成
TaskID Int64 任务流ID,用于查询任务详情。

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 内部参数,用户可忽略

RedisClusterNode

redis集群版的节点信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String Node 名字
RunId String Noder的RunId
Role Int64 0: 主节点, 1:从节点
Status Int64 0: 可读写, 1: 只读, 2: 用于备份
Connected Int64 连接状态,0:连接断开 1: 连接正常
CreateTime String 节点创建时间
DownTime String 节点下线时间

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

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:修改完成