有奖捉虫:云通信与企业服务文档专题,速来> HOT

Account

子账号信息

被如下接口引用:DescribeInstanceAccount。

名称 类型 描述
InstanceId String 实例 ID。
注意:此字段可能返回 null,表示取不到有效值。
AccountName String 账号名称。
注意:此字段可能返回 null,表示取不到有效值。
Remark String 账号描述信息。
注意:此字段可能返回 null,表示取不到有效值。
Privilege String 读写权限策略。
- r:只读。
- w:只写。
- rw:读写。
注意:此字段可能返回 null,表示取不到有效值。
ReadonlyPolicy Array of String 只读路由策略。
- master:主节点。
- replication:从节点。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 子账号状态.
- 1:账号变更中。
- 2:账号有效。
- 4:账号已删除。
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:"2024-01-03 17:44:25",如果没有则显示为空

BackupDownloadInfo

备份文件下载信息

被如下接口引用:DescribeBackupUrl。

名称 类型 描述
FileName String 备份文件名称。
示例值:1.rdb
FileSize Integer 备份文件大小,单位B,如果为0,表示无效。
示例值:1024
DownloadUrl String 备份文件外网下载地址。下载地址的有效时长为6小时,过期后请重新获取。
示例值:https://redis-database-backup-1251937656.cos.ap-chengdu.myqcl
InnerDownloadUrl String 备份文件内网下载地址。下载地址的有效时长为6小时,过期后请重新获取。
示例值:https://redis-database-backup-1251937656.cos.ap-chengdu.myqcl

BackupLimitVpcItem

已配置的备份文件下载地址对应的 VPC 信息。

被如下接口引用:DescribeBackupDownloadRestriction, DescribeBackupUrl, ModifyBackupDownloadRestriction。

名称 类型 必选 描述
Region String 备份文件的下载地址对应VPC 所属的地域。
示例值:ap-guangzhou
VpcList Array of String 备份文件下载地址的 VPC 列表。
示例值:["vpc-b3ksv7yt", "vpc-a9pl9fiu"]

BigKeyInfo

大Key详情

被如下接口引用:DescribeInstanceMonitorBigKey。

名称 类型 描述
DB Integer 所属的database
Key String 大Key
Type String 类型
Size Integer 大小
Updatetime Integer 数据时间戳

BigKeyTypeInfo

大Key类型分布详情

被如下接口引用:DescribeInstanceMonitorBigKeyTypeDist。

名称 类型 描述
Type String 类型
Count Integer 数量
Size Integer 大小
Updatetime Integer 时间戳

CommandTake

命令耗时

被如下接口引用:DescribeInstanceMonitorTopNCmdTook。

名称 类型 描述
Cmd String 命令
Took Integer 耗时

DelayDistribution

延时分布详情

被如下接口引用:DescribeInstanceMonitorBigKeySizeDist, DescribeInstanceMonitorTookDist。

名称 类型 描述
Ladder Integer 指延时分布阶梯,其与延时区间的对应关系如下所示。
- 1:[0ms,1ms]。
- 5: [1ms,5ms]。
- 10: [5ms,10ms]。
- 50: [10ms,50ms]。
- 200:[50ms,200ms]。
- -1: [200ms,∞]。
Size Integer 延时处于当前分布阶梯的命令数量,单位:个。
Updatetime Integer 修改时间。

DescribeInstanceDTSInstanceInfo

详细DTS实例信息

被如下接口引用:DescribeInstanceDTSInfo。

名称 类型 描述
RegionId Integer 地域ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
SetId Integer 仓库ID
注意:此字段可能返回 null,表示取不到有效值。
ZoneId Integer 可用区ID
注意:此字段可能返回 null,表示取不到有效值。
Type Integer 实例类型
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
Vip String 实例访问地址
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。

Groups

复制组信息

被如下接口引用:DescribeReplicationGroup。

名称 类型 描述
AppId Integer 用户 APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
示例值:100001
RegionId Integer 地域ID 。
- 1:广州
- 4:上海
- 5:中国香港
- 6:多伦多
- 7:上海金融
- 8:北京
- 9:新加坡
- 11:深圳金融
- 15:美西(硅谷)
- 16:成都
- 17:德国
- 18:韩国
- 19:重庆
- 21:印度
- 22:美东(弗吉尼亚)
- 23:泰国
- 25:日本
示例值:1
GroupId String 复制组 ID。格式如:crs-rpl-deind****。
示例值:crs-rpl-deindi7de
GroupName String 复制组名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:crs-rpl-deindi7de
Status Integer 复制组状态。
- 37:绑定复制组中。
- 38:复制组重连中。
- 51:解绑复制组中。
- 52:复制组实例切主中。
- 53:角色变更中。
示例值:0
InstanceCount Integer 复制组数量。
示例值:20
Instances Array of Instances 复制组中的实例信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:复制组实例
Remark String 备注信息。
注意:此字段可能返回 null,表示取不到有效值。

HotKeyInfo

热Key详细信息

被如下接口引用:DescribeInstanceMonitorHotKey。

名称 类型 描述
Key String 热 Key 的名称。
Type String Key 类型。
Count Integer 某段时间内热 Key 的访问次数

Inbound

安全组入站规则

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

名称 类型 描述
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。

名称 类型 描述
Name String 节点名称。
RunId String 实例运行时节点 ID。
Role Integer 集群角色。
- 0:master。
- 1:slave。
Status Integer 节点状态。
- 0:readwrite,。
- 1:read。
- 2:backup。
Connected Integer 服务状态。
0-down。
1-on
CreateTime String 节点创建时间。
DownTime String 节点下线时间。
Slots String 节点 Slot 分布区间。
Keys Integer 节点 Key分布。
Qps Integer 节点 QPS。分片节点每秒执行次数。单位:次/秒。
QpsSlope Float 节点 QPS 倾斜度。
Storage Integer 节点存储。
StorageSlope Float 节点存储倾斜度。

InstanceClusterShard

实例分片列表信息

被如下接口引用:DescribeInstanceShards。

名称 类型 描述
ShardName String 分片节点名称。
ShardId String 分片节点序号。
Role Integer 分片节点的角色。
- 0:主节点。
- 1:副本节点。
Keys Integer Key数量。
Slots String Slot信息。
Storage Integer 已使用容量。
StorageSlope Float 容量倾斜率。
Runid String 该字段因拼写不规范问题,建议使用RunId取代。含义:实例运行时节点 ID。
RunId String 实例运行时节点 ID。
Connected Integer 服务状态。
- 0:down。
- 1:on。

InstanceEnumParam

实例枚举类型参数描述

被如下接口引用:DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名称。
ValueType String 参数类型,例如:Enum。
NeedRestart String 参数值修改后是否需要重启。
- true:需要。
- false:不需要。
DefaultValue String 参数默认值。
CurrentValue String 参数当前运行值。
Tips String 参数说明。
EnumValue Array of String 参数可取的值。
Status Integer 参数修改状态。
- 1: 修改中。
- 2:修改完成。

InstanceIntegerParam

实例整型参数描述

被如下接口引用:DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名
ValueType String 参数类型:integer
NeedRestart String 修改后是否需要重启:true,false
DefaultValue String 参数默认值
CurrentValue String 当前运行参数值
Tips String 参数说明
Min String 参数最小值
Max String 参数最大值
Status Integer 参数状态, 1: 修改中, 2:修改完成
Unit String 参数单位
注意:此字段可能返回 null,表示取不到有效值。

InstanceMultiParam

实例多选项类型参数描述

被如下接口引用:DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名称。
ValueType String 参数类型。例如:multi。
NeedRestart String 参数修改后是否需要重启。
- true:需要。
- false:不需要。
DefaultValue String 参数默认值。
CurrentValue String 当前运行参数值。
Tips String 参数说明。
EnumValue Array of String 参数说明。
Status Integer 参数修改的状态。
- 1:修改中。
- 2:修改完成。

InstanceNode

实例节点

被如下接口引用:DescribeInstances。

名称 类型 描述
Id Integer 实例 ID。
InstanceClusterNode Array of InstanceClusterNode 节点详细信息。

InstanceParam

实例参数

被如下接口引用:CreateParamTemplate, ModifyInstanceParams, ModifyParamTemplate。

名称 类型 必选 描述
Key String 设置参数的名称。例如timeout。当前支持自定义的参数,请参见参数配置
示例值:timeout
Value String 设置参数名称对应的运行值。例如timeout对应运行值可设置为120, 单位为秒(s)。指当客户端连接闲置时间达到120 s时,将关闭连接。更多参数取值信息,请参见参数配置
示例值:120

InstanceParamHistory

实例参数修改历史

被如下接口引用:DescribeInstanceParamRecords。

名称 类型 描述
ParamName String 参数名称。
PreValue String 参数修改之前的值。
NewValue String 参数修改之后的值。
Status Integer 参数配置状态。
- 1:参数配置修改中。
- 2:参数配置修改成功。
- 3:参数配置修改失败。
ModifyTime String 修改时间。

InstanceProxySlowlogDetail

代理慢查询详情

被如下接口引用:DescribeProxySlowLog。

名称 类型 描述
Duration Integer 慢查询耗时时长。单位:毫秒。
Client String 客户端地址。
Command String 慢查询的命令。
CommandLine String 慢查询详细命令行信息。
ExecuteTime String 执行时间。

InstanceSecurityGroupDetail

实例安全组信息

被如下接口引用:DescribeInstanceSecurityGroup。

名称 类型 描述
InstanceId String 实例 ID。
SecurityGroupDetails Array of SecurityGroupDetail 安全组信息,包括:安全组 ID、安全组名称、安全组出入站规则。

InstanceSet

实例详细信息列表。

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceName String 实例名称。
示例值:test
InstanceId String 实例 ID。
示例值:crs-7asi981q
Appid Integer 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。

示例值:12345
ProjectId Integer 项目 ID。
示例值:12
RegionId Integer 地域 ID。
  • 1:广州。
  • 4:上海。
  • 5:中国香港。
  • 6:多伦多。
  • 7:上海金融。
  • 8:北京。
  • 9:新加坡。
  • 11:深圳金融。
  • 15:美西(硅谷)。
  • 16:成都。
  • 17:法兰克福。
  • 18:首尔。
  • 19:重庆。
  • 21:孟买。
  • 22:美东(弗吉尼亚)。
  • 23:曼谷。
  • 25:东京。

示例值:1
ZoneId Integer 区域 ID。
示例值:100001
VpcId Integer vpc网络 ID,例如75101。
示例值:1
SubnetId Integer vpc网络下子网ID,如:46315。
示例值:10
Status Integer 实例当前状态。
  • 0:待初始化。
  • 1:实例在流程中。
  • 2:实例运行中。
  • -2:实例已隔离。
  • -3:实例待删除。

示例值:2
WanIp String 实例 VIP。
示例值:10.20.3.1
Port Integer 实例端口号。
示例值:6379
Createtime String 实例创建时间。格式如:2020-01-15 10:20:00。
示例值:2020-01-15 10:20:00
Size Float 实例内存容量大小。单位:MB,1MB=1024KB。
示例值:1451
SizeUsed Float 该字段已废弃。请使用腾讯云可观测平台API 接口 GetMonitorData 获取实例已使用的内存容量。
示例值:0
Type Integer 实例类型。
- 2:Redis 2.8内存版(标准架构)。
- 3:CKV 3.2内存版(标准架构)。
- 4:CKV 3.2内存版(集群架构)。
- 5:Redis 2.8内存版(单机)。
- 6:Redis 4.0内存版(标准架构)。
- 7:Redis 4.0内存版(集群架构)。
- 8:Redis 5.0内存版(标准架构)。
- 9:Redis 5.0内存版(集群架构)。
- 15:Redis 6.2内存版(标准架构)。
- 16:Redis 6.2内存版(集群架构)。
示例值:7
AutoRenewFlag Integer 实例是否设置自动续费标识。
  • 1:设置自动续费。
  • 0:未设置自动续费。

示例值:1
DeadlineTime String 包年包月计费实例到期的时间。
示例值:2020-02-15 10:20:00
Engine String 引擎:社区版Redis、腾讯云CKV。
示例值:社区版Redis
ProductType String 产品类型。
  • standalone:标准版。
  • cluster :集群版。

示例值:cluster
UniqVpcId String vpc网络id,例如vpc-fk33jsf43kgv。
示例值:vpc-fk33jsf43kgv
UniqSubnetId String vpc网络下子网id,例如:subnet-fd3j6l35mm0。
示例值:subnet-fd3j6l35mm0
BillingMode Integer 计费模式。
  • 0:按量计费。
  • 1:包年包月。

示例值:1
InstanceTitle String 实例运行状态描述:如”实例运行中“。
示例值:实例运行中
OfflineTime String 已隔离实例默认下线时间。按量计费实例隔离后默认两小时后下线,包年包月默认7天后下线。格式如:2020-02-15 10:20:00。
示例值:2020-02-15 10:20:00
SubStatus Integer 流程中的实例,返回子状态。
示例值:0
Tags Array of String 反亲和性标签。
InstanceNode Array of InstanceNode 实例节点信息。
RedisShardSize Integer 分片大小。
示例值:4096
RedisShardNum Integer 分片数量。
示例值:3
RedisReplicasNum Integer 副本数量。
示例值:1
PriceId Integer 计费 ID。
示例值:114
CloseTime String 实例隔离开始的时间。
示例值:0000-00-00 00:00:00
SlaveReadWeight Integer 从节点读取权重。
示例值:1
InstanceTags Array of InstanceTagInfo 实例关联的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
ProjectName String 项目名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Default
NoAuth Boolean 是否为免密实例。
  • true:免密实例。
  • false:非免密实例。

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ClientLimit Integer 客户端连接数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:30000
DtsStatus Integer DTS状态(内部参数,用户可忽略)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NetLimit Integer 分片带宽上限,单位MB。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1800
PasswordFree Integer 免密实例标识(内部参数,用户可忽略)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Vip6 String 该参数存在命名不规范问题,建议用参数IPv6取代。内部参数,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
IPv6 String 内部参数,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
ReadOnly Integer 实例只读标识(内部参数,用户可忽略)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RemainBandwidthDuration String 内部参数,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
DiskSize Integer Redis实例请忽略该参数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:400
MonitorVersion String 监控版本。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5s
ClientLimitMin Integer 客户端最大连接数可设置的最小值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
ClientLimitMax Integer 客户端最大连接数可设置的最大值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10000
NodeSet Array of RedisNodeInfo 实例的节点详细信息。
注意:此字段可能返回 null,表示取不到有效值。
Region String 实例所在的地域信息,比如ap-guangzhou。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
WanAddress String 外网地址。
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz-crs-xxx.sql.tencentcdb.com
PolarisServer String 北极星服务地址,内部使用。
注意:此字段可能返回 null,表示取不到有效值。
示例值:txcloud-paas-crs-xxx
CurrentProxyVersion String 实例当前Proxy版本。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.5.0
CurrentRedisVersion String 实例当前Cache小版本。
注意:此字段可能返回 null,表示取不到有效值。
示例值:4.3.0
UpgradeProxyVersion String 实例可升级Proxy版本。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.6.0
UpgradeRedisVersion String 实例可升级Cache小版本。
注意:此字段可能返回 null,表示取不到有效值。
示例值:6.0.0

InstanceSlowlogDetail

慢查询详情

被如下接口引用:DescribeSlowLog。

名称 类型 描述
Duration Integer 慢查询耗时
Client String 客户端地址
Command String 命令
CommandLine String 详细命令行信息
ExecuteTime String 执行时间
Node String 节点ID

InstanceTagInfo

实例标签信息

被如下接口引用:DescribeInstances。

名称 类型 必选 描述
TagKey String 标签键。
TagValue String 标签值。

InstanceTextParam

实例字符型参数描述

被如下接口引用:DescribeInstanceParams。

名称 类型 描述
ParamName String 参数名称。
ValueType String 参数类型。例如:text。
NeedRestart String 参数修改后是否需要重启。
- true:需要。
- false:不需要。
DefaultValue String 参数默认值。
CurrentValue String 参数当前运行值。
Tips String 参数说明。
TextValue Array of String 参数可取值。
Status Integer 参数修改状态。
- 1: 修改中。
- 2:修改完成。

Instances

复制组实例

被如下接口引用:DescribeReplicationGroup。

名称 类型 描述
AppId Integer 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
示例值:100001
InstanceId String 实例 ID。
示例值:crs-deindi7de
InstanceName String 实例名称。
示例值:crs-deindi7de-name
RegionId Integer 地域ID。
  • 1:广州。
  • 4:上海。
  • 5:香港。
  • 6:多伦多。
  • 7:上海金融。
  • 8:北京。
  • 9:新加坡。
  • 11:深圳金融。
  • 15:美西(硅谷)。

示例值:1
ZoneId Integer 区域 ID。
示例值:100001
RedisReplicasNum Integer 副本数量。
示例值:1
RedisShardNum Integer 分片数量。
示例值:3
RedisShardSize Integer 分片内存大小。
示例值:16
DiskSize Integer 实例的磁盘大小。
注意:此字段可能返回 null,表示取不到有效值。
示例值:400
Engine String 引擎:社区版Redis、腾讯云CKV。
示例值:社区版Redis
Role String 实例读写权限。
  • rw:可读写。
  • r:只读。

示例值:rw
Vip String 实例 VIP 地址。
示例值:127.0.0.1
Vip6 String 该参数存在命名不规范问题,建议用参数IPv6取代。内部参数,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv6
IPv6 String 内部参数,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv6
VpcID Integer VPC 网络ID,如:75101。
示例值:1
VPort Integer 实例端口。
示例值:6379
Status Integer 实例状态。
  • 0:待初始化。
  • 1:流程中。
  • 2:运行中。
  • -2:已隔离。
  • -3:待删除。

示例值:0
GrocerySysId Integer 仓库ID。
示例值:15007
ProductType Integer 实例类型。
- 2:Redis 2.8内存版(标准架构)。
- 3:CKV 3.2内存版(标准架构)。
- 4:CKV 3.2内存版(集群架构)。
- 5:Redis 2.8内存版(单机)。
- 6:Redis 4.0内存版(标准架构)。
- 7:Redis 4.0内存版(集群架构)。
- 8:Redis 5.0内存版(标准架构)。
- 9:Redis 5.0内存版(集群架构)。
- 15:Redis 6.2内存版(标准架构)。
- 16:Redis 6.2内存版(集群架构)。
示例值:7
CreateTime String 实例加入复制组的时间。
示例值:0000-00-00 00:00:00
UpdateTime String 复制组中实例更新的时间。
示例值:0000-00-00 00:00:00

Outbound

安全组出站规则

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

名称 类型 描述
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代表的地址集合。

ParamTemplateInfo

参数模板信息

被如下接口引用:DescribeParamTemplates。

名称 类型 描述
TemplateId String 参数模板 ID。
示例值:crs-cfg-rhlppeye
Name String 参数模板名称。
示例值:CustomParamTemplate
Description String 参数模板描述。
示例值:MyCustomParamTemplate
ProductType Integer 实例类型。
- 2:Redis 2.8内存版(标准架构)。
- 3:CKV 3.2内存版(标准架构)。
- 4:CKV 3.2内存版(集群架构)。
- 5:Redis 2.8内存版(单机)。
- 6:Redis 4.0内存版(标准架构)。
- 7:Redis 4.0内存版(集群架构)。
- 8:Redis 5.0内存版(标准架构)。
- 9:Redis 5.0内存版(集群架构)。
- 15:Redis 6.2内存版(标准架构)。
- 16:Redis 6.2内存版(集群架构)。
示例值:6

ParameterDetail

Redis参数模板参数详情

被如下接口引用:DescribeParamTemplateInfo。

名称 类型 描述
Name String 参数名称。
示例值:slowlog-log-slower-than
ParamType String 参数类型。
示例值:integer
Default String 参数默认值。
示例值:10
Description String 参数描述。
示例值:Over this time the command is recorded in us.a negative number d
CurrentValue String 参数当前值。
示例值:5
NeedReboot Integer 修改参数后,是否需要重启数据库以使参数生效。
- 0:不需要重启。
- 1:需要重启。
示例值:0
Max String 参数允许的最大值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Min String 参数允许的最小值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
EnumValue Array of String 参数可选枚举值。如果为非枚举参数,则为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

ProductConf

产品信息

被如下接口引用:DescribeProductInfo。

名称 类型 描述
Type Integer 产品类型。
- 2:Redis 2.8内存版(标准架构)。
- 3:CKV 3.2内存版(标准架构)。
- 4:CKV 3.2内存版(集群架构)。
- 5:Redis 2.8内存版(单机)。
- 6:Redis 4.0内存版(标准架构)。
- 7:Redis 4.0内存版(集群架构)。
- 8:Redis 5.0内存版(标准架构)。
- 9:Redis 5.0内存版(集群架构)。
- 15:Redis 6.2内存版(标准架构)。
- 16:Redis 6.2内存版(集群架构)。
TypeName String 产品名称。包括:Redis 主从版、CKV 主从版、CKV 集群版、Redis 单机版、Redis 集群版。
MinBuyNum Integer 购买时的最小数量。
MaxBuyNum Integer 购买时的最大数量。
Saleout Boolean 产品是否售罄。
- true:售罄。
- false:未售罄。
Engine String 产品引擎。包括:腾讯云 CKV与社区版 Redis。
Version String 兼容版本。包括:Redis-2.8、Redis-3.2、Redis-4.0、Redis-5.0、Redis-6.2。
TotalSize Array of String 规格总大小,单位GB。
ShardSize Array of String 每个分片大小,单位GB。
ReplicaNum Array of String 副本数量。
ShardNum Array of String 分片数量。
PayMode String 支持的计费模式。
- 1:包年包月。
- 0:按量计费。
EnableRepicaReadOnly Boolean 该参数名因存在拼写不规范的问题,建议使用EnableReplicaReadOnly参数取代。其含义为是否支持副本只读。
- true:支持副本只读。
- false:不支持。
EnableReplicaReadOnly Boolean 是否支持副本只读。
- true:支持副本只读。
- false:不支持。
注意:此字段可能返回 null,表示取不到有效值。

ProxyNodes

Proxy节点信息。

被如下接口引用:DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String 节点 ID。
注意:此字段可能返回 null,表示取不到有效值。
ZoneId Integer 可用区 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100002

RedisBackupSet

实例的备份数组

被如下接口引用:DescribeInstanceBackups。

名称 类型 描述
StartTime String 备份开始时间。
示例值:"2022-03-24 11:52:20"
BackupId String 备份任务ID。
示例值:"999b6b89c60-f01a-11eb-9d37-7d65897b5c22"
BackupType String 备份类型。
- 1:凌晨系统发起的自动备份。
- 0:用户发起的手动备份。
示例值:"1"
Status Integer 备份状态。
- 1:备份被其它流程锁定。
- 2:备份正常,没有被任何流程锁定。
- -1:备份已过期。
- 3:备份正在被导出。
- 4:备份导出成功。
示例值:2
Remark String 备份的备注信息。
示例值:""
Locked Integer 备份是否被锁定。
- 0:未被锁定。
- 1:已被锁定。
示例值:0
BackupSize Integer 内部字段,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FullBackup Integer 内部字段,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceType Integer 内部字段,用户可忽略。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceId String 实例 ID。
示例值:crs-7iw94215
InstanceName String 实例名称。
示例值:测试实例
Region String 本地备份所在地域。
示例值:ap-guangzhou
EndTime String 备份结束时间。
示例值:"2022-03-24 11:59:20"
FileType String 备份文件类型。
示例值:"RDB-Redis 5.0"
ExpireTime String 备份文件过期时间。
示例值:"2022-03-31 11:52:20"

RedisCommonInstanceList

单个实例信息

被如下接口引用:DescribeCommonDBInstances。

名称 类型 描述
InstanceName String 实例名称。
示例值:InstanceName
InstanceId String 实例 ID。
示例值:crs-xxxxxxx
AppId Integer 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
示例值:000000000
ProjectId Integer 实例所属项目 ID。
示例值:000000000
Region String 实例接入区域。
示例值:1
Zone String 实例接入可用区。
示例值:100001
VpcId String 实例私有网络 ID。
示例值:vpc-xxxxxx
SubnetId String 私有网络所属子网 ID。
示例值:sub-vcp-xxx
Status String 实例状态信息。
- 1-流程中。
- 2-运行中。
- -2-实例已隔离。
- -3-实例待回收。
- -4-实例已删除。
示例值:1
Vips Array of String 实例私有网络 IP 地址。
示例值:127.0.0.1
Vport Integer 实例网络端口。
示例值:6379
Createtime String 实例创建时间。
示例值:yyyy-MM-dd
PayMode Integer 计费类型。
- 0:按量计费。
- 1:包年包月。
示例值:1
NetType Integer 网络类型。
- 0:基础网络。
- 1:VPC 网络。
示例值:1

RedisNode

Redis节点的运行信息

被如下接口引用:DescribeInstanceZoneInfo。

名称 类型 描述
Keys Integer Redis 节点上 Key 的个数。
示例值:1
Slot String Redis 节点 Slot 分布范围。例如:0-5460。
示例值:0-5460
NodeId String 节点的序列 ID。
示例值:b69eda124a34c1b713e81f7cb947161b06214328
Status String 节点的状态。
示例值:Normal
Role String 节点角色。
示例值:master

RedisNodeInfo

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

被如下接口引用:CloneInstances, CreateInstances, DescribeInstances, ModifyInstanceAvailabilityZones, UpgradeInstance。

名称 类型 必选 描述
NodeType Integer 节点类型。
  • 0:为主节点。
  • 1:为副本节点。

示例值:1
NodeId Integer 主节点或者副本节点的 ID。
  • 该参数用于创建 Redis 实例接口CreateInstances 并不需要设置,而用于变更实例配置的接口 UpgradeInstance 删除副本时才需要设置。
  • 该参数可使用接口 DescribeInstances 获取Integer类型的节点 ID。

示例值:1
ZoneId Integer 主节点或者副本节点的可用区 ID。
示例值:100001
ZoneName String 主节点或者副本节点的可用区名称。
示例值:ap-guangzhou-1

RedisNodes

Redis节点信息

被如下接口引用:DescribeInstanceNodeInfo。

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

RegionConf

地域信息

被如下接口引用:DescribeProductInfo。

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

ReplicaGroup

实例节点组信息

被如下接口引用:DescribeInstanceZoneInfo。

名称 类型 描述
GroupId Integer 节点组 ID。
GroupName String 节点组的名称,主节点为空。
ZoneId String 节点的可用区ID,比如ap-guangzhou-1
Role String 节点组类型,master为主节点,replica为副本节点
RedisNodes Array of RedisNode 节点组节点列表

ResourceTag

API购买实例绑定标签

被如下接口引用:CloneInstances, CreateInstances。

名称 类型 必选 描述
TagKey String 标签Key。
TagValue String 标签 Key 对应的 Value。

SecurityGroup

安全组规则

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

名称 类型 描述
CreateTime String 创建时间,时间格式:yyyy-mm-dd hh:mm:ss。
ProjectId Integer 项目ID。
SecurityGroupId String 安全组ID。
SecurityGroupName String 安全组名称。
SecurityGroupRemark String 安全组备注。
Outbound Array of Outbound 出站规则。
Inbound Array of Inbound 入站规则。

SecurityGroupDetail

安全组详情

被如下接口引用:DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup。

名称 类型 描述
ProjectId Integer 项目ID。
CreateTime String 创建安全组的时间。
SecurityGroupId String 安全组 ID。
SecurityGroupName String 安全组名称。
SecurityGroupRemark String 安全组标记。
InboundRule Array of SecurityGroupsInboundAndOutbound 安全组入站规则,即控制访问数据库的来源。
OutboundRule Array of SecurityGroupsInboundAndOutbound 安全组出站规则。

SecurityGroupsInboundAndOutbound

安全组出入规则

被如下接口引用:DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup。

名称 类型 描述
Action String 标识出入数据库的IP与端口是否被允许。
Ip String 出入数据库的IP地址
Port String 端口号。
Proto String 协议类型。

SourceCommand

访问命令

被如下接口引用:DescribeInstanceMonitorTopNCmd。

名称 类型 描述
Cmd String 命令
Count Integer 执行次数

SourceInfo

访问来源信息

被如下接口引用:DescribeInstanceMonitorSIP。

名称 类型 描述
Ip String 来源 IP 地址。
Conn Integer 客户端连接数量。
Cmd Integer 命令

TaskInfoDetail

任务信息详情

被如下接口引用:DescribeTaskList。

名称 类型 描述
TaskId Integer 任务 ID。
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 任务开始时间。
注意:此字段可能返回 null,表示取不到有效值。
TaskType String 任务类型。
- FLOW_CREATE:创建实例。
- FLOW_MODIFYCONNECTIONCONFIG:调整带宽连接数。
- FLOW_MODIFYINSTANCEPASSWORDFREE:免密变更流程。
- FLOW_CLEARNETWORK:VPC退还中。
- FLOW_SETPWD:设置访问密码。
- FLOW_EXPORSHR:扩缩容流程。
- FLOW_UpgradeArch:实例架构升级流程。
- FLOW_MODIFYINSTANCEPARAMS:修改实例参数。
- FLOW_MODIFYINSTACEREADONLY:只读变更流程。
- FLOW_CLOSE:关闭实例。
- FLOW_DELETE:删除实例。
- FLOW_OPEN_WAN:开启外网。
- FLOW_CLEAN:清空实例。
- FLOW_MODIFYINSTANCEACCOUNT:修改实例账号。
- FLOW_ENABLEINSTANCE_REPLICATE:开启副本只读。
- FLOW_DISABLEINSTANCE_REPLICATE: 关闭副本只读。
- FLOW_SWITCHINSTANCEVIP:交换实例 VIP。
- FLOW_CHANGE_REPLICA_TO_MSTER:副本节点升主节点。
- FLOW_BACKUPINSTANCE:备份实例。
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名称。
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例 ID。
注意:此字段可能返回 null,表示取不到有效值。
ProjectId Integer 项目 ID。
注意:此字段可能返回 null,表示取不到有效值。
Progress Float 任务进度。
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 任务执行结束时间。
注意:此字段可能返回 null,表示取不到有效值。
Result Integer 任务执行状态。

0:任务初始化。
1:执行中。
2:完成。
4:失败。
注意:此字段可能返回 null,表示取不到有效值。

TendisNodes

tendis节点信息

被如下接口引用:DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String 节点ID
NodeRole String 节点角色

TendisSlowLogDetail

Tendis慢查询详情

被如下接口引用:DescribeTendisSlowLog。

名称 类型 描述
ExecuteTime String 执行时间
Duration Integer 慢查询耗时(毫秒)
Command String 命令
CommandLine String 详细命令行信息
Node String 节点ID

TradeDealDetail

订单交易信息

被如下接口引用:DescribeInstanceDealDetail。

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

ZoneCapacityConf

可用区内产品信息

被如下接口引用:DescribeProductInfo。

名称 类型 描述
ZoneId String 可用区ID:如ap-guangzhou-3
ZoneName String 可用区名称
IsSaleout Boolean 可用区是否售罄
IsDefault Boolean 是否为默认可用区
NetWorkType Array of String 网络类型:basenet -- 基础网络;vpcnet -- VPC网络
ProductSet Array of ProductConf 可用区内产品规格等信息
OldZoneId Integer 可用区ID:如100003