数据结构
最近更新时间: 2025-10-20 17:05:53
Grocerys
仓库信息
被如下接口引用:AddResourcePool、DisableResourcePool、EnableResourcePool、OfflineResourcePool
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 否 | 否 | String | 地区 |
| Zone | 否 | 否 | String | 区域 |
| Grocery | 否 | 否 | 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-账号已删除 |
TaskInfoDetail
任务信息详情
被如下接口引用:DescribeTaskList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TaskId | 是 | 是 | Int64 | 任务Id |
| StartTime | 是 | 是 | String | 开始时间 |
| TaskType | 是 | 是 | String | 任务类型 |
| InstanceName | 是 | 是 | String | 实例名称 |
| InstanceId | 是 | 是 | String | 实例Id |
| ProjectId | 是 | 是 | Int64 | 项目Id |
| Progress | 是 | 是 | Float | 任务进度 |
| EndTime | 是 | 是 | String | 结束时间 |
| Result | 是 | 是 | Int64 | 任务状态 |
BigKeyInfo
大Key详情
被如下接口引用:DescribeInstanceMonitorBigKey
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DB | 是 | 否 | Int64 | 所属的database |
| Key | 是 | 否 | String | 大Key |
| Type | 是 | 否 | String | 类型 |
| Size | 是 | 否 | Int64 | 大小 |
| Updatetime | 是 | 否 | 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:修改完成 |
InstanceGreyStrategyData
实例灰度策略信息
被如下接口引用:InstanceGreyStrategy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Proxy | 是 | 是 | Int64 | 代理 |
| Clientlist | 是 | 是 | Int64 | 客户端列表 |
| Switch | 是 | 是 | Int64 | 切换 |
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代表的地址集合。 |
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:修改完成 |
InstanceNode
实例节点
被如下接口引用:DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Int64 | Id |
| InstanceClusterNode | 是 | 否 | Array of InstanceClusterNode | 节点详细信息 |
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,用于查询任务详情。 |
DelayDistribution
延时分布详情
被如下接口引用:DescribeInstanceMonitorBigKeySizeDist、DescribeInstanceMonitorTookDist
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ladder | 是 | 否 | Int64 | 分布阶梯 |
| Size | 是 | 否 | Int64 | 大小 |
ParameterDetail
Redis参数模板参数详情
被如下接口引用:DescribeParamTemplateInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 否 | 否 | String | 参数名称。 |
| ParamType | 否 | 否 | String | 参数类型。 |
| Default | 否 | 否 | String | 参数默认值。 |
| Description | 否 | 否 | String | 参数描述。 |
| CurrentValue | 否 | 否 | String | 参数当前值。 |
| NeedReboot | 否 | 否 | Int64 | 修改参数后,是否需要重启数据库以使参数生效。 - 0:不需要重启。 - 1:需要重启。 |
| Max | 否 | 否 | String | 参数允许的最大值。 |
| Min | 否 | 否 | String | 参数允许的最小值。 |
| EnumValue | 否 | 否 | String | 参数可选枚举值。如果为非枚举参数,则为空。 |
HotKeyInfo
热Key详细信息
被如下接口引用:DescribeInstanceMonitorHotKey
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 热Key |
| Type | 是 | 否 | String | 类型 |
| Count | 是 | 否 | Int64 | 数量 |
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 | 是否支持副本只读 |
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 | 可用区信息 |
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 |
DealDetailsGoodsDetail
货物订单详细信息
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CurDeadline | 是 | 否 | String | 当前截至时间 |
| MemSize | 是 | 否 | Float | 实例大小 |
| OldMemSize | 是 | 否 | Float | 实例原大小 |
| NewMemsize | 是 | 否 | Float | 实例当前大小 |
| TimeSpan | 是 | 否 | Float | 时间长度 |
| TimeUnit | 是 | 否 | String | 时间单位 |
| RedisIds | 是 | 否 | Array of String | 实例ID集合 |
ProxyNodes
Proxy节点信息
被如下接口引用:DescribeInstanceNodeInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 是 | String | 节点ID |
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 | 慢日志详细信息数组 |
SourceCommand
访问命令
被如下接口引用:DescribeInstanceMonitorTopNCmd
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cmd | 是 | 否 | String | 命令 |
| Count | 是 | 否 | 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,TX云CKV |
| Version | 是 | 否 | String | 版本:Redis-2.8,Redis-3.2,Redis-4.0 |
| Sizes | 是 | 否 | Array of String | 售卖规格大小,单位:G |
| DumpNumber | 是 | 否 | Array of String | 副本数量 |
RedisNodeInfo
描述Redis实例的主节点或者副本节点信息
被如下接口引用:CreateInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 否 | 否 | Int64 | 主节点或者副本节点的ID,创建时不需要传递此参数。 |
| NodeType | 否 | 否 | Int64 | 节点类型,0 为主节点,1 为副本节点 |
| ZoneId | 否 | 否 | Uint64 | 主节点或者副本节点的可用区ID |
| ZoneName | 否 | 否 | String | 主节点或者副本节点的可用区名称 |
InstanceTagInfo
实例标签信息
被如下接口引用:DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键 |
| TagValue | 是 | 否 | String | 标签值 |
SlowlogDetail
慢日志信息
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ExecTime | 是 | 否 | String | 执行时间 |
| Duration | 是 | 否 | Int64 | 执行持续时间 |
| Command | 是 | 否 | String | 执行命令 |
| CmdLine | 是 | 否 | String | 执行整个命令 |
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 |
BackupDownloadInfo
备份下载信息
被如下接口引用:DescribeBackupUrl
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileName | 否 | 否 | String | 文件名 |
| FileSize | 否 | 否 | Int64 | 文件大小 |
| DownloadUrl | 否 | 否 | String | 下载地址 |
| InnerDownloadUrl | 否 | 否 | String | 内部下载地址 |
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 | 可用区信息 |
DescribeInstanceDTSInstanceInfo
详细DTS实例信息
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 是 | 是 | Int64 | 地域ID |
| InstanceId | 是 | 是 | String | 实例ID |
| SetId | 是 | 是 | Int64 | 仓库ID |
| ZoneId | 是 | 是 | Int64 | 可用区ID |
| Type | 是 | 是 | Int64 | 实例类型 |
| InstanceName | 是 | 是 | String | 实例名称 |
| Vip | 是 | 是 | String | 实例访问地址 |
| Status | 是 | 是 | Int64 | 状态 |
GoodsDetail
商品详情
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MemSize | 是 | 否 | Int64 | 实例容量, 单位:MB |
| TimeSpan | 是 | 否 | Int64 | 购买时长, 单位以:timeUnit为准 |
| TimeUnit | 是 | 否 | Int64 | 购买时长单位, m- 月, d - 天 |
| RedisIds | 是 | 否 | Array of String | 关联的redisId列表 |
| CurDeadline | 是 | 否 | String | 续费前,实例到期时间 |
ResourceTagApi
实例标签
被如下接口引用:CreateInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 否 | 否 | String | tagKey |
| TagValue | 否 | 否 | String | tagValue |
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 | 内部参数,用户可忽略 |
ResourcePoolInfo
ResourcePoolInfo
被如下接口引用:DescribeResourcePools
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PoolName | 否 | 否 | String | PoolName |
| Info | 否 | 否 | Array of SingleResourcePoolInfo | Info |
SecurityGroupDetail
安全组详情
被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProjectId | 是 | 否 | Int64 | 项目Id |
| CreateTime | 是 | 否 | String | 创建时间 |
| SecurityGroupId | 是 | 否 | String | 安全组Id |
| SecurityGroupName | 是 | 否 | String | 安全组名称 |
| SecurityGroupRemark | 是 | 否 | String | 安全组标记 |
| InboundRule | 是 | 否 | Array of SecurityGroupsInboundAndOutbound | 安全组入站规则 |
| OutboundRule | 是 | 否 | Array of SecurityGroupsInboundAndOutbound | 安全组出站规则 |
BigKeyTypeInfo
大Key类型分布详情
被如下接口引用:DescribeInstanceMonitorBigKeyTypeDist
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 类型 |
| Count | 是 | 否 | Int64 | 数量 |
| Size | 是 | 否 | Int64 | 大小 |
| Updatetime | 是 | 否 | Int64 | 时间戳 |
Tags
是否为虚拟机
被如下接口引用:AddMachine、DescribeMachine
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IsVm | 否 | 否 | String | 是否为虚拟机 |
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:修改完成 |
Regions
Regions列表
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 是 | 否 | Int64 | 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷) |
| RegionCityNameEn | 是 | 否 | String | 地域名字(英文) |
| RegionCityNameCn | 是 | 否 | String | 地域名字(中文) |
| RegionCityNameLong | 是 | 否 | String | 地域城市 |
InstanceParamHistory
实例参数修改历史
被如下接口引用:DescribeInstanceParamRecords
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ParamName | 是 | 否 | String | 参数名称 |
| PreValue | 是 | 否 | String | 修改前值 |
| NewValue | 是 | 否 | String | 修改后值 |
| Status | 是 | 否 | Int64 | 状态:1-参数配置修改中;2-参数配置修改成功;3-参数配置修改失败 |
| ModifyTime | 是 | 否 | 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代表的地址集合。 |
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 | 入站规则。 |
InstanceSecurityGroupDetail
实例安全组信息
被如下接口引用:DescribeInstanceSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例Id |
| SecurityGroupDetails | 是 | 否 | Array of SecurityGroupDetail | 安全组信息 |
ZoneCapacityTypeConf
Zone配置
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ZoneId | 是 | 否 | Int64 | 可用区id |
| ZoneName | 是 | 否 | String | 可用区名称 |
| Saleout | 是 | 否 | Bool | 是否售罄 |
| IsDefault | 是 | 否 | Bool | 是否默认区域 |
| ZoneCapacity | 是 | 否 | Array of ZoneCapacity | 实例类型数组 |
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、TX云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 |
RedisNodes
Redis节点信息
被如下接口引用:DescribeInstanceNodeInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 否 | String | 节点ID |
| NodeRole | 是 | 否 | String | 节点角色 |
| ClusterId | 是 | 否 | Int64 | 分片ID |
| ZoneId | 是 | 否 | Int64 | 可用区ID |
TendisNodes
tendis节点信息
被如下接口引用:DescribeInstanceNodeInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 否 | String | 节点ID |
| NodeRole | 是 | 否 | String | 节点角色 |
CommandTake
命令耗时
被如下接口引用:DescribeInstanceMonitorTopNCmdTook
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cmd | 是 | 否 | String | 命令 |
| Took | 是 | 否 | Int64 | 耗时 |
ChargeStandard
阶梯计费列表
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ChargeDesc | 是 | 否 | String | 价格描述,主要表示0 |
| Price | 是 | 否 | Float | 价格 |
| ChargeUnit | 是 | 否 | String | 价格单位 hour or month |
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 |
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 |
InstanceGreyStrategyData2
实例灰度信息
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Proxy | 是 | 否 | Int64 | 代理 |
| Switch | 是 | 否 | Int64 | 切换 |
| Clientlist | 是 | 否 | Int64 | 客户端列表 |
InstanceParam
实例参数
被如下接口引用:CreateParamTemplate、ModifyInstanceParams、ModifyParamTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 设置参数的名字 |
| Value | 是 | 否 | String | 设置参数的值 |
TagInfo
Tag信息
被如下接口引用:DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 否 | 否 | String | TagKey |
| TagValue | 否 | 否 | String | TagValue |
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 | 文件过期时间,空表示不过期 |
RedisRegion
地域列表
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 是 | 否 | Int64 | 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷) |
| RegionCityNameEn | 是 | 否 | String | 地域英文名 |
| RegionCityNameCn | 是 | 否 | String | 地域中文名 |
| RegionCityNameLong | 是 | 否 | String | 地域完整信息 |
SourceInfo
访问来源信息
被如下接口引用:
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 是 | 否 | String | 来源IP |
| Conn | 是 | 否 | Int64 | 连接数 |
| Cmd | 是 | 否 | Int64 | 命令 |
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 | 节点下线时间 |
SecurityGroupsInboundAndOutbound
安全组出入规则
被如下接口引用:DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 执行动作 |
| Ip | 是 | 否 | String | IP地址 |
| Port | 是 | 否 | String | 端口号 |
| Proto | 是 | 否 | 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 |
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内存版(集群架构) |