/** * UpgradeSmallVersion请求参数结构体 */ export interface UpgradeSmallVersionRequest { /** * 实例ID */ InstanceId: string; /** * 当前redis版本 */ CurrentRedisVersion: string; /** * 可升级的redis版本 */ UpgradeRedisVersion: string; /** * 1-立即升级 0-维护时间窗口升级 */ InstanceTypeUpgradeNow: number; } /** * ModifyInstanceParams返回参数结构体 */ export interface ModifyInstanceParamsResponse { /** * 说明修改参数配置是否成功。
  • true：指修改成功；
  • false：指修改失败。
    */ Changed: boolean; /** * 任务ID。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * EnableReplicaReadonly请求参数结构体 */ export interface EnableReplicaReadonlyRequest { /** * 实例序号ID */ InstanceId: string; /** * 账号路由策略：填写master或者replication，表示路由主节点，从节点；不填路由策略默认为写主节点，读从节点 */ ReadonlyPolicy?: Array; } /** * ModifyInstanceAvailabilityZones请求参数结构体 */ export interface ModifyInstanceAvailabilityZonesRequest { /** * 指定实例 ID。例如：crs-xjhsdj****，请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 */ InstanceId: string; /** * 切换时间。 - 1：维护时间窗切换。 - 2：立即切换。 */ SwitchOption: number; /** * 实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 单可用区实例无需传NodeId，多可用区实例NodeId必传 */ NodeSet: Array; } /** * 实例的备份数组 */ export interface RedisBackupSet { /** * 备份开始时间。 */ StartTime: string; /** * 备份任务ID。 */ BackupId: string; /** * 备份类型。 - 1：凌晨系统发起的自动备份。 - 0：用户发起的手动备份。 */ BackupType: string; /** * 备份状态。 - 1：备份被其它流程锁定。 - 2：备份正常，没有被任何流程锁定。 - -1：备份已过期。 - 3：备份正在被导出。 - 4：备份导出成功。 */ Status: number; /** * 备份的备注信息。 */ Remark: string; /** * 备份是否被锁定。 - 0：未被锁定。 - 1：已被锁定。 */ Locked: number; /** * 内部字段，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ BackupSize: number; /** * 内部字段，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ FullBackup: number; /** * 内部字段，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceType: number; /** * 实例 ID。 */ InstanceId: string; /** * 实例名称。 */ InstanceName: string; /** * 本地备份所在地域。 */ Region: string; /** * 备份结束时间。 */ EndTime: string; /** * 备份文件类型。 */ FileType: string; /** * 备份文件过期时间。 */ ExpireTime: string; } /** * DescribeInstanceMonitorTopNCmd返回参数结构体 */ export interface DescribeInstanceMonitorTopNCmdResponse { /** * 访问命令信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAutoBackupConfig返回参数结构体 */ export interface ModifyAutoBackupConfigResponse { /** * 自动备份类型。目前仅能配置为：1 ，指定时备份。 */ AutoBackupType?: number; /** * 自动备份周期。取值为：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。 */ WeekDays?: Array; /** * 自动定时备份时间段。格式如：00:00-01:00, 01:00-02:00...... 23:00-00:00。 */ TimePeriod?: string; /** * 全量备份文件保存天数,单位：天。 */ BackupStorageDays?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RestoreInstance请求参数结构体 */ export interface RestoreInstanceRequest { /** * 待操作的实例ID，可通过 DescribeInstances 接口返回值中的 InstanceId 获取。 */ InstanceId: string; /** * 备份ID，可通过 GetRedisBackupList 接口返回值中的 backupId 获取 */ BackupId: string; /** * 实例密码，恢复实例时，需要校验实例密码（免密实例不需要传密码） */ Password?: string; } /** * AllocateWanAddress请求参数结构体 */ export interface AllocateWanAddressRequest { /** * 实例ID */ InstanceId: string; } /** * ApplyParamsTemplate请求参数结构体 */ export interface ApplyParamsTemplateRequest { /** * 实例ID列表 */ InstanceIds: Array; /** * 应用的参数模板ID */ TemplateId: string; } /** * UpgradeInstanceVersion返回参数结构体 */ export interface UpgradeInstanceVersionResponse { /** * 订单ID */ DealId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInstances请求参数结构体 */ export interface CreateInstancesRequest { /** * 实例类型。
    • 2：Redis 2.8 内存版（标准架构）。
    • 3：CKV 3.2 内存版（标准架构）。
    • 4：CKV 3.2 内存版（集群架构）。
    • 6：Redis 4.0 内存版（标准架构）。
    • 7：Redis 4.0 内存版（集群架构）。
    • 8：Redis 5.0 内存版（标准架构）。
    • 9：Redis 5.0 内存版（集群架构）。
    • 15：Redis 6.2 内存版（标准架构）。
    • 16：Redis 6.2 内存版（集群架构）。
    */ TypeId: number; /** * 内存容量，单位为MB， 数值需为1024的整数倍。具体规格，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时，**MemSize**是实例总内存容量； - **TypeId**为集群架构时，**MemSize**是单分片内存容量。 */ MemSize: number; /** * 实例数量，单次购买实例数量。具体信息，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 */ GoodsNum: number; /** * 购买实例的时长。 - 若 **BillingMode**为**1**，即计费方式为包年包月时，需设置该参数，指定所购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**，即计费方式为按量计费时，该参数配置为1。 */ Period: number; /** * 计费方式。 - 0：按量计费。 - 1：包年包月。 */ BillingMode: number; /** * 实例所属的可用区ID，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 */ ZoneId?: number; /** * 访问实例的密码。 - 当输入参数**NoAuth**为**true**时，指设置实例为免密码访问，Password可不用配置，否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时，其密码复杂度要求为：8-30个字符，至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头。 - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时，其密码复杂度为：8-30个字符，必须包含字母和数字，且 不包含其他字符。 */ Password?: string; /** * 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。 */ VpcId?: string; /** * 私有网络VPC的子网。基础网络下， 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。 */ SubnetId?: string; /** * 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)，在右上角的账户信息菜单中，选择**项目管理**查询项目 ID。 */ ProjectId?: number; /** * 自动续费标识。 - 0：默认状态（手动续费）。 - 1：自动续费。 - 2：到期不续费。 */ AutoRenew?: number; /** * 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。 */ SecurityGroupIdList?: Array; /** * 用户自定义的网络端口。默认为6379，范围为 [1024,65535]。 */ VPort?: number; /** * 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例，分片数量范围为：[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。 */ RedisShardNum?: number; /** * 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。 */ RedisReplicasNum?: number; /** * 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读，实例将自动读写分离，写请求路由到主节点，读请求路由到副本节点。 - 如需开启副本只读，建议副本数量大于等于2。 */ ReplicasReadonly?: boolean; /** * 实例名称。命名要求：仅支持长度小于60的中文、英文或者数字，短划线"-"、下划线"_"。 */ InstanceName?: string; /** * 配置实例是否支持免密码访问。 - true：免密访问实例。 - false：非免密访问实例。默认为非免密方式，仅VPC网络的实例支持免密码访问。 */ NoAuth?: boolean; /** * 实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型（主节点或者副本节点），节点的可用区。单可用区部署不需要传递此参数。 */ NodeSet?: Array; /** * 给实例设定标签。 */ ResourceTags?: Array; /** * 指定实例所属的可用区名称。具体信息，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 */ ZoneName?: string; /** * 指定实例相关的参数模板 ID。 - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。 */ TemplateId?: string; /** * 内部参数，标识创建实例是否需要检查。 - false ：默认值。发送正常请求，通过检查后直接创建实例。 - true：发送检查请求，不会创建实例。 */ DryRun?: boolean; /** * 指定实例的产品版本。 - local：本地盘版。 - cloud：云盘版， - cdc：独享集群版。如果不传默认发货为本地盘版本。 */ ProductVersion?: string; /** * 独享集群 ID。当**ProductVersion**设置为**cdc**时，该参数必须设置。 */ RedisClusterId?: string; } /** * CreateReplicationGroup请求参数结构体 */ export interface CreateReplicationGroupRequest { /** * 指定复制组中的主实例ID。 */ InstanceId: string; /** * 复制组名称。名称只支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。 */ GroupName?: string; /** * 备注信息。 */ Remark?: string; } /** * ModifyInstanceReadOnly返回参数结构体 */ export interface ModifyInstanceReadOnlyResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceZoneInfo请求参数结构体 */ export interface DescribeInstanceZoneInfoRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId?: string; } /** * ModifyConnectionConfig返回参数结构体 */ export interface ModifyConnectionConfigResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyNetworkConfig返回参数结构体 */ export interface ModifyNetworkConfigResponse { /** * 执行状态，请忽略该参数。 */ Status?: boolean; /** * 指实例新私有网络所属子网 ID。 */ SubnetId?: string; /** * 指实例新的私有网络ID。 */ VpcId?: string; /** * 指实例新的内网 IPv4 地址。 */ Vip?: string; /** * 任务 ID。可获取**taskId**，通过接口 **DescribeTaskInfo **查询任务执行状态。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 命令耗时 */ export interface CommandTake { /** * 命令 */ Cmd: string; /** * 耗时 */ Took: number; } /** * DescribeInstanceMonitorBigKey返回参数结构体 */ export interface DescribeInstanceMonitorBigKeyResponse { /** * 大Key详细信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全组入站规则 */ export interface Inbound { /** * 策略，ACCEPT或者DROP。 */ Action: string; /** * 地址组id代表的地址集合。 */ AddressModule: string; /** * 来源Ip或Ip段，例如192.168.0.0/16。 */ CidrIp: string; /** * 描述。 */ Desc: string; /** * 网络协议，支持udp、tcp等。 */ IpProtocol: string; /** * 端口。 */ PortRange: string; /** * 服务组id代表的协议和端口集合。 */ ServiceModule: string; /** * 安全组id代表的地址集合。 */ Id: string; } /** * AssociateSecurityGroups请求参数结构体 */ export interface AssociateSecurityGroupsRequest { /** * 数据库引擎名称，本接口取值：redis。 */ Product: string; /** * 要绑定的安全组ID，类似sg-efil73jd。 */ SecurityGroupId: string; /** * 被绑定的实例ID，类似ins-lesecurk，支持指定多个实例。 */ InstanceIds: Array; } /** * DescribeTaskList返回参数结构体 */ export interface DescribeTaskListResponse { /** * 任务总数。 */ TotalCount?: number; /** * 任务详细信息。 */ Tasks?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstance请求参数结构体 */ export interface ModifyInstanceRequest { /** * 修改实例操作，如填写：rename-表示实例重命名；modifyProject-修改实例所属项目；modifyAutoRenew-修改实例续费标记 */ Operation: string; /** * 实例Id */ InstanceIds?: Array; /** * 实例的新名称 */ InstanceNames?: Array; /** * 项目Id */ ProjectId?: number; /** * 自动续费标识。0 - 默认状态（手动续费）；1 - 自动续费；2 - 明确不自动续费 */ AutoRenews?: Array; /** * 已经废弃 */ InstanceId?: string; /** * 已经废弃 */ InstanceName?: string; /** * 已经废弃 */ AutoRenew?: number; } /** * KillMasterGroup返回参数结构体 */ export interface KillMasterGroupResponse { /** * 异步任务ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RenewInstance返回参数结构体 */ export interface RenewInstanceResponse { /** * 交易ID。 */ DealId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSlowLog返回参数结构体 */ export interface DescribeSlowLogResponse { /** * 慢查询总数。 */ TotalCount?: number; /** * 慢查询详情。 */ InstanceSlowlogDetail?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCommonDBInstances请求参数结构体 */ export interface DescribeCommonDBInstancesRequest { /** * vpc网络ID信息列表 */ VpcIds?: Array; /** * 子网ID信息列表 */ SubnetIds?: Array; /** * 计费类型过滤列表；0表示包年包月，1表示按量计费 */ PayMode?: number; /** * 实例ID过滤信息列表 */ InstanceIds?: Array; /** * 实例名称过滤信息列表 */ InstanceNames?: Array; /** * 实例状态信息过滤列表 */ Status?: Array; /** * 排序字段 */ OrderBy?: string; /** * 排序方式 */ OrderByType?: string; /** * 实例vip信息列表 */ Vips?: Array; /** * vpc网络ID信息列表 */ UniqVpcIds?: Array; /** * 子网统一ID列表 */ UniqSubnetIds?: Array; /** * 数量限制，默认推荐100 */ Limit?: number; /** * 偏移量，默认0 */ Offset?: number; } /** * DescribeDBSecurityGroups返回参数结构体 */ export interface DescribeDBSecurityGroupsResponse { /** * 安全组规则。 */ Groups?: Array; /** * 实例内网IPv4地址。 */ VIP?: string; /** * 内网端口。 */ VPort?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RestoreInstance返回参数结构体 */ export interface RestoreInstanceResponse { /** * 任务ID，可通过 DescribeTaskInfo 接口查询任务执行状态 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述 Redis 实例的主节点或者副本节点信息。 */ export interface RedisNodeInfo { /** * 节点类型。
    • 0：为主节点。
    • 1：为副本节点。
    */ NodeType: number; /** * 主节点或者副本节点的 ID。
    • 该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置，而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。
    • 该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。
    */ NodeId?: number; /** * 主节点或者副本节点的可用区 ID。 */ ZoneId?: number; /** * 主节点或者副本节点的可用区名称。 */ ZoneName?: string; } /** * ModifyBackupDownloadRestriction返回参数结构体 */ export interface ModifyBackupDownloadRestrictionResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupUrl请求参数结构体 */ export interface DescribeBackupUrlRequest { /** * 实例 ID。 */ InstanceId: string; /** * 备份 ID，可通过 [DescribeInstanceBackups ](https://cloud.tencent.com/document/product/239/20011)接口返回的参数 RedisBackupSet 获取。 */ BackupId: string; /** * 下载备份文件的网络限制类型，如果不配置该参数，则使用用户自定义的配置。 - NoLimit：不限制，腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet：仅腾讯云自动分配的内网地址可下载备份文件。 - Customize：指用户自定义的私有网络可下载备份文件。 */ LimitType?: string; /** * 该参数仅支持输入 In，表示自定义的**LimitVpc**可以下载备份文件。 */ VpcComparisonSymbol?: string; /** * 标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。默认为 In。 - NotIn: 自定义的 IP 不可以下载。 */ IpComparisonSymbol?: string; /** * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，需配置该参数。 */ LimitVpc?: Array; /** * 自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时，需配置该参数。 */ LimitIp?: Array; } /** * DeleteParamTemplate返回参数结构体 */ export interface DeleteParamTemplateResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 实例总数量。 */ TotalCount?: number; /** * 实例详细信息列表。 */ InstanceSet?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceZoneInfo返回参数结构体 */ export interface DescribeInstanceZoneInfoResponse { /** * 实例节点组的个数。 */ TotalCount?: number; /** * 实例节点组列表。 */ ReplicaGroups?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 子账号信息 */ export interface Account { /** * 实例 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 账号名称。 注意：此字段可能返回 null，表示取不到有效值。 */ AccountName: string; /** * 账号描述信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Remark: string; /** * 读写权限策略。 - r：只读。 - w：只写。 - rw：读写。 注意：此字段可能返回 null，表示取不到有效值。 */ Privilege: string; /** * 只读路由策略。 - master：主节点。 - replication：从节点。 注意：此字段可能返回 null，表示取不到有效值。 */ ReadonlyPolicy: Array; /** * 子账号状态. - 1：账号变更中。 - 2：账号有效。 - 4：账号已删除。 注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; } /** * 代理慢查询详情 */ export interface InstanceProxySlowlogDetail { /** * 慢查询耗时时长。单位：毫秒。 */ Duration: number; /** * 客户端地址。 */ Client: string; /** * 慢查询的命令。 */ Command: string; /** * 慢查询详细命令行信息。 */ CommandLine: string; /** * 执行时间。 */ ExecuteTime: string; } /** * 安全组出入规则 */ export interface SecurityGroupsInboundAndOutbound { /** * 标识出入数据库的IP与端口是否被允许。 */ Action: string; /** * 出入数据库的IP地址 */ Ip: string; /** * 端口号。 */ Port: string; /** * 协议类型。 */ Proto: string; } /** * ResetPassword返回参数结构体 */ export interface ResetPasswordResponse { /** * 任务ID（修改密码时的任务ID，如果时切换免密码或者非免密码实例，则无需关注此返回值） */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ClearInstance请求参数结构体 */ export interface ClearInstanceRequest { /** * 实例ID */ InstanceId: string; /** * redis的实例密码（免密实例不需要传密码，非免密实例必传） */ Password?: string; } /** * UpgradeInstanceVersion请求参数结构体 */ export interface UpgradeInstanceVersionRequest { /** * 目标实例类型，同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的**TypeId**，即实例要变更的目标类型。 - Redis 4.0 及以上的版本，支持相同版本的实例从标准架构升级至集群架构，例如，支持 Redis 4.0 标准架构升级至 Redis 4.0 集群架构。 - 不支持跨版本架构升级，例如，Redis 4.0 标准架构升级至 Redis 5.0 集群架构。 - 不支持 Redis 2.8 版本升级架构。 - 不支持从集群架构降级至标准架构。 */ TargetInstanceType: string; /** * 切换时间。 - 1：维护时间窗切换。 - 2：立即切换。 */ SwitchOption: number; /** * 指定实例 ID。例如：crs-xjhsdj****，请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 */ InstanceId: string; } /** * 地域信息 */ export interface RegionConf { /** * 地域ID */ RegionId: string; /** * 地域名称 */ RegionName: string; /** * 地域简称 */ RegionShortName: string; /** * 地域所在大区名称 */ Area: string; /** * 可用区信息 */ ZoneSet: Array; } /** * 大Key详情 */ export interface BigKeyInfo { /** * 所属的database */ DB: number; /** * 大Key */ Key: string; /** * 类型 */ Type: string; /** * 大小 */ Size: number; /** * 数据时间戳 */ Updatetime: number; } /** * DescribeBandwidthRange返回参数结构体 */ export interface DescribeBandwidthRangeResponse { /** * 标准带宽。指购买实例时，系统为每个节点分配的带宽。 */ BaseBandwidth: number; /** * 指实例的附加带宽。标准带宽不满足需求的情况下，用户可自行增加的带宽。
    • 开启副本只读时，实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数 * Max ([只读副本数量, 1])，标准架构的分片数 = 1。
    • 没有开启副本只读时，实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数，标准架构的分片数 = 1。
    */ AddBandwidth: number; /** * 附加带宽设置下限。 */ MinAddBandwidth: number; /** * 附加带宽设置上限。 */ MaxAddBandwidth: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeParamTemplates请求参数结构体 */ export interface DescribeParamTemplatesRequest { /** * 产品类型数组。产品类型：1 – Redis2.8内存版（集群架构），2 – Redis2.8内存版（标准架构），3 – CKV 3.2内存版(标准架构)，4 – CKV 3.2内存版(集群架构)，5 – Redis2.8内存版（单机），6 – Redis4.0内存版（标准架构），7 – Redis4.0内存版（集群架构），8 – Redis5.0内存版（标准架构），9 – Redis5.0内存版（集群架构） */ ProductTypes?: Array; /** * 模板名称数组。 */ TemplateNames?: Array; /** * 模板ID数组。 */ TemplateIds?: Array; } /** * RenewInstance请求参数结构体 */ export interface RenewInstanceRequest { /** * 购买时长，单位：月。 */ Period: number; /** * 实例 ID。 */ InstanceId: string; /** * 标识是否修改计费模式。
    • 当前实例计费模式为按量计费方式，预转换为包年包月而续费，请指定该参数为 prepaid。
    • 当前实例计费模式为包年包月方式，可不设置该参数。
    */ ModifyPayMode?: string; } /** * UpgradeVersionToMultiAvailabilityZones返回参数结构体 */ export interface UpgradeVersionToMultiAvailabilityZonesResponse { /** * 任务ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceBackups返回参数结构体 */ export interface DescribeInstanceBackupsResponse { /** * 备份总数。 */ TotalCount?: number; /** * 实例的备份数组。 */ BackupSet?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceParamRecords返回参数结构体 */ export interface DescribeInstanceParamRecordsResponse { /** * 总的修改历史记录数。 */ TotalCount: number; /** * 修改历史记录信息。 */ InstanceParamHistory: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAutoBackupConfig请求参数结构体 */ export interface ModifyAutoBackupConfigRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 设置自动备份周期。可设置为Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。该参数暂不支持修改。 */ WeekDays: Array; /** * 备份时间段。可设置为每个整点。格式如：00:00-01:00, 01:00-02:00...... 23:00-00:00。 */ TimePeriod: string; /** * 自动备份类型。目前仅能配置为：1 ，指定时备份。 */ AutoBackupType?: number; } /** * 实例多选项类型参数描述 */ export interface InstanceMultiParam { /** * 参数名称。 */ ParamName: string; /** * 参数类型。例如：multi。 */ ValueType: string; /** * 参数修改后是否需要重启。 - true：需要。 - false：不需要。 */ NeedRestart: string; /** * 参数默认值。 */ DefaultValue: string; /** * 当前运行参数值。 */ CurrentValue: string; /** * 参数说明。 */ Tips: string; /** * 参数说明。 */ EnumValue: Array; /** * 参数修改的状态。 - 1：修改中。 - 2：修改完成。 */ Status: number; } /** * DescribeInstanceDealDetail请求参数结构体 */ export interface DescribeInstanceDealDetailRequest { /** * 订单交易ID数组，即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealId。 */ DealIds: Array; } /** * Redis节点的运行信息 */ export interface RedisNode { /** * Redis 节点上 Key 的个数。 */ Keys: number; /** * Redis 节点 Slot 分布范围。例如：0-5460。 */ Slot: string; /** * 节点的序列 ID。 */ NodeId: string; /** * 节点的状态。 */ Status: string; /** * 节点角色。 */ Role: string; } /** * DescribeProjectSecurityGroup请求参数结构体 */ export interface DescribeProjectSecurityGroupRequest { /** * 0:默认项目；-1 所有项目; >0: 特定项目 */ ProjectId?: number; /** * 安全组Id */ SecurityGroupId?: string; } /** * Redis参数模板参数详情 */ export interface ParameterDetail { /** * 参数名称。 */ Name: string; /** * 参数类型。 */ ParamType: string; /** * 参数默认值。 */ Default: string; /** * 参数描述。 */ Description: string; /** * 参数当前值。 */ CurrentValue: string; /** * 修改参数后，是否需要重启数据库以使参数生效。 - 0：不需要重启。 - 1：需要重启。 */ NeedReboot: number; /** * 参数允许的最大值。 注意：此字段可能返回 null，表示取不到有效值。 */ Max: string; /** * 参数允许的最小值。 注意：此字段可能返回 null，表示取不到有效值。 */ Min: string; /** * 参数可选枚举值。如果为非枚举参数，则为空。 注意：此字段可能返回 null，表示取不到有效值。 */ EnumValue: Array; } /** * DescribeInstanceShards返回参数结构体 */ export interface DescribeInstanceShardsResponse { /** * 实例分片列表信息，包括：节点信息、节点ID、Key数量、使用容量、容量倾斜率等信息。 */ InstanceShards?: Array; /** * 实例分片节点数量。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyPrepaidInstance请求参数结构体 */ export interface DestroyPrepaidInstanceRequest { /** * 实例ID */ InstanceId: string; } /** * DisableReplicaReadonly请求参数结构体 */ export interface DisableReplicaReadonlyRequest { /** * 实例序号ID */ InstanceId: string; } /** * 任务信息详情 */ export interface TaskInfoDetail { /** * 任务 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId: number; /** * 任务开始时间。 注意：此字段可能返回 null，表示取不到有效值。 */ StartTime: 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，表示取不到有效值。 */ TaskType: string; /** * 实例名称。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName: string; /** * 实例 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 项目 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ ProjectId: number; /** * 任务进度。 注意：此字段可能返回 null，表示取不到有效值。 */ Progress: number; /** * 任务执行结束时间。 注意：此字段可能返回 null，表示取不到有效值。 */ EndTime: string; /** * 任务执行状态。 0：任务初始化。 1：执行中。 2：完成。 4：失败。 注意：此字段可能返回 null，表示取不到有效值。 */ Result: number; } /** * ModifyBackupDownloadRestriction请求参数结构体 */ export interface ModifyBackupDownloadRestrictionRequest { /** * 下载备份文件的网络限制类型： - NoLimit：不限制，腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet：仅腾讯云自动分配的内网地址可下载备份文件。 - Customize：指用户自定义的私有网络可下载备份文件。 */ LimitType: string; /** * 该参数仅支持输入 In，表示自定义的**LimitVpc**可以下载备份文件。 */ VpcComparisonSymbol?: string; /** * 标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。 - NotIn: 自定义的 IP 不可以下载。 */ IpComparisonSymbol?: string; /** * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，需配置该参数。 */ LimitVpc?: Array; /** * 自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时，需配置该参数。 */ LimitIp?: Array; } /** * DisableReplicaReadonly返回参数结构体 */ export interface DisableReplicaReadonlyResponse { /** * 任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateParamTemplate返回参数结构体 */ export interface CreateParamTemplateResponse { /** * 参数模板 ID。 */ TemplateId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例标签信息 */ export interface InstanceTagInfo { /** * 标签键。 */ TagKey: string; /** * 标签值。 */ TagValue: string; } /** * DescribeInstanceDTSInfo返回参数结构体 */ export interface DescribeInstanceDTSInfoResponse { /** * DTS任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ JobId: string; /** * DTS任务名称 注意：此字段可能返回 null，表示取不到有效值。 */ JobName: string; /** * 任务状态,取值为：1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过（CheckNotPass）,7-任务运行(Running),8-准备完成（ReadyComplete）,9-任务成功（Success）,10-任务失败（Failed）,11-撤销中（Stopping）,12-完成中（Completing） 注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * 状态描述 注意：此字段可能返回 null，表示取不到有效值。 */ StatusDesc: string; /** * 同步时延，单位：字节 注意：此字段可能返回 null，表示取不到有效值。 */ Offset: number; /** * 断开时间 注意：此字段可能返回 null，表示取不到有效值。 */ CutDownTime: string; /** * 源实例信息 注意：此字段可能返回 null，表示取不到有效值。 */ SrcInfo: DescribeInstanceDTSInstanceInfo; /** * 目标实例信息 注意：此字段可能返回 null，表示取不到有效值。 */ DstInfo: DescribeInstanceDTSInstanceInfo; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChangeMasterInstance返回参数结构体 */ export interface ChangeMasterInstanceResponse { /** * 异步流程ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddReplicationInstance返回参数结构体 */ export interface AddReplicationInstanceResponse { /** * 异步流程ID。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyPostpaidInstance返回参数结构体 */ export interface DestroyPostpaidInstanceResponse { /** * 任务Id */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchInstanceVip请求参数结构体 */ export interface SwitchInstanceVipRequest { /** * 源实例ID */ SrcInstanceId: string; /** * 目标实例ID */ DstInstanceId: string; /** * 单位为秒。源实例与目标实例间DTS已断开时间，如果DTS断开时间大于TimeDelay，则不切换VIP，建议尽量根据业务设置一个可接受的值。 */ TimeDelay?: number; /** * 在DTS断开的情况下是否强制切换。1：强制切换，0：不强制切换 */ ForceSwitch?: number; /** * now: 立即切换，syncComplete：等待同步完成后切换 */ SwitchTime?: string; } /** * ChangeReplicaToMaster请求参数结构体 */ export interface ChangeReplicaToMasterRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 副本节点组 ID，请通过接口[DescribeInstanceZoneInfo](https://cloud.tencent.com/document/product/239/50312)获取多 AZ备节点组的 ID 信息。单 AZ，则无需配置该参数。 */ GroupId?: number; } /** * Proxy节点信息。 */ export interface ProxyNodes { /** * 节点 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ NodeId: string; /** * 可用区 ID。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId: number; } /** * ModifyInstance返回参数结构体 */ export interface ModifyInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 单个实例信息 */ export interface RedisCommonInstanceList { /** * 实例名称。 */ InstanceName: string; /** * 实例 ID。 */ InstanceId: string; /** * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。 */ AppId: number; /** * 实例所属项目 ID。 */ ProjectId: number; /** * 实例接入区域。 */ Region: string; /** * 实例接入可用区。 */ Zone: string; /** * 实例私有网络 ID。 */ VpcId: string; /** * 私有网络所属子网 ID。 */ SubnetId: string; /** * 实例状态信息。 - 1-流程中。 - 2-运行中。 - -2-实例已隔离。 - -3-实例待回收。 - -4-实例已删除。 */ Status: string; /** * 实例私有网络 IP 地址。 */ Vips: Array; /** * 实例网络端口。 */ Vport: number; /** * 实例创建时间。 */ Createtime: string; /** * 计费类型。 - 0：按量计费。 - 1：包年包月。 */ PayMode: number; /** * 网络类型。 - 0：基础网络。 - 1：VPC 网络。 */ NetType: number; } /** * 访问来源信息 */ export interface SourceInfo { /** * 来源 IP 地址。 */ Ip: string; /** * 客户端连接数量。 */ Conn: number; /** * 命令 */ Cmd: number; } /** * ModifyDBInstanceSecurityGroups返回参数结构体 */ export interface ModifyDBInstanceSecurityGroupsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChangeMasterInstance请求参数结构体 */ export interface ChangeMasterInstanceRequest { /** * 复制组ID。创建复制组时，系统自动分配的 ID，是复制组的唯一标识。例如：crs-rpl-m3zt****，请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。 */ GroupId: string; /** * 指定待提升为主实例的只读实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 标识是否强制提主。 - true：强制提主。 - false：不强制提主。 */ ForceSwitch?: boolean; } /** * DescribeInstanceDTSInfo请求参数结构体 */ export interface DescribeInstanceDTSInfoRequest { /** * 实例ID */ InstanceId: string; } /** * CreateParamTemplate请求参数结构体 */ export interface CreateParamTemplateRequest { /** * 参数模板名称。 */ Name: string; /** * 参数模板描述。 */ Description?: string; /** * 产品类型：1 – Redis2.8内存版（集群架构），2 – Redis2.8内存版（标准架构），3 – CKV 3.2内存版(标准架构)，4 – CKV 3.2内存版(集群架构)，5 – Redis2.8内存版（单机），6 – Redis4.0内存版（标准架构），7 – Redis4.0内存版（集群架构），8 – Redis5.0内存版（标准架构），9 – Redis5.0内存版（集群架构）。创建模板时必填，从源模板复制则不需要传入该参数。 */ ProductType?: number; /** * 源参数模板 ID。 */ TemplateId?: string; /** * 参数列表。 */ ParamList?: Array; } /** * DescribeTendisSlowLog返回参数结构体 */ export interface DescribeTendisSlowLogResponse { /** * 慢查询总数 */ TotalCount: number; /** * 慢查询详情 */ TendisSlowLogDetail: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProductInfo返回参数结构体 */ export interface DescribeProductInfoResponse { /** * 地域售卖信息。 */ RegionSet: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceAccount请求参数结构体 */ export interface ModifyInstanceAccountRequest { /** * 实例ID */ InstanceId: string; /** * 子账号名称，如果要修改主账号，填root */ AccountName: string; /** * 子账号密码 */ AccountPassword?: string; /** * 子账号描述信息 */ Remark?: string; /** * 路由策略：填写master或者replication，表示主节点或者从节点 */ ReadonlyPolicy?: Array; /** * 子账号读写策略：填写r、w、rw，表示只读，只写，读写策略 */ Privilege?: string; /** * true表示将主账号切换为免密账号，这里只适用于主账号，子账号不可免密 */ NoAuth?: boolean; } /** * ModifyMaintenanceWindow请求参数结构体 */ export interface ModifyMaintenanceWindowRequest { /** * 实例ID */ InstanceId: string; /** * 维护时间窗起始时间，如：17:00 */ StartTime: string; /** * 维护时间窗结束时间，如：19:00 */ EndTime: string; } /** * DescribeParamTemplateInfo请求参数结构体 */ export interface DescribeParamTemplateInfoRequest { /** * 指定查询的参数模板 ID。请通过接口[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)获取参数模板列表信息。 */ TemplateId: string; } /** * DescribeBackupUrl返回参数结构体 */ export interface DescribeBackupUrlResponse { /** * 外网下载地址（6小时内链接有效），该字段正在逐步废弃中。 */ DownloadUrl?: Array; /** * 内网下载地址（6小时内链接有效），该字段正在逐步废弃中。 */ InnerDownloadUrl?: Array; /** * 文件名称，该字段正在逐步废弃中。 注意：此字段可能返回 null，表示取不到有效值。 */ Filenames?: Array; /** * 备份文件信息列表。 注意：此字段可能返回 null，表示取不到有效值。 */ BackupInfos?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceRenewInstance返回参数结构体 */ export interface InquiryPriceRenewInstanceResponse { /** * 价格，单位：分 注意：此字段可能返回 null，表示取不到有效值。 */ Price?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSecurityGroups请求参数结构体 */ export interface DescribeDBSecurityGroupsRequest { /** * 数据库引擎名称，本接口取值：redis。 */ Product: string; /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; } /** * InquiryPriceCreateInstance返回参数结构体 */ export interface InquiryPriceCreateInstanceResponse { /** * 价格，单位：分 注意：此字段可能返回 null，表示取不到有效值。 */ Price: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例安全组信息 */ export interface InstanceSecurityGroupDetail { /** * 实例 ID。 */ InstanceId: string; /** * 安全组信息，包括：安全组 ID、安全组名称、安全组出入站规则。 */ SecurityGroupDetails: Array; } /** * DescribeInstanceParams返回参数结构体 */ export interface DescribeInstanceParamsResponse { /** * 参数列表总数量。 */ TotalCount?: number; /** * 实例枚举类型参数。 */ InstanceEnumParam?: Array; /** * 实例整型参数。 */ InstanceIntegerParam?: Array; /** * 实例字符型参数。 */ InstanceTextParam?: Array; /** * 实例多选项型参数。 */ InstanceMultiParam?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeProxyVersion返回参数结构体 */ export interface UpgradeProxyVersionResponse { /** * 异步流程ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetPassword请求参数结构体 */ export interface ResetPasswordRequest { /** * Redis实例ID */ InstanceId: string; /** * 重置的密码（切换为免密实例时，可不传；其他情况必传） */ Password?: string; /** * 是否切换免密实例，false-切换为非免密码实例，true-切换为免密码实例；默认false */ NoAuth?: boolean; } /** * ModifyInstanceAccount返回参数结构体 */ export interface ModifyInstanceAccountResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 延时分布详情 */ export interface DelayDistribution { /** * 指延时分布阶梯，其与延时区间的对应关系如下所示。 - 1：[0ms,1ms]。 - 5： [1ms,5ms]。 - 10： [5ms,10ms]。 - 50： [10ms,50ms]。 - 200：[50ms,200ms]。 - -1： [200ms,∞]。 */ Ladder: number; /** * 延时处于当前分布阶梯的命令数量，单位：个。 */ Size: number; /** * 修改时间。 */ Updatetime: number; } /** * DescribeProjectSecurityGroups返回参数结构体 */ export interface DescribeProjectSecurityGroupsResponse { /** * 安全组规则。 */ Groups: Array; /** * 符合条件的安全组总数量。 */ Total: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorTookDist返回参数结构体 */ export interface DescribeInstanceMonitorTookDistResponse { /** * 时延分布信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBandwidthRange请求参数结构体 */ export interface DescribeBandwidthRangeRequest { /** * 实例 ID。 */ InstanceId: string; } /** * 实例整型参数描述 */ export interface InstanceIntegerParam { /** * 参数名 */ ParamName: string; /** * 参数类型：integer */ ValueType: string; /** * 修改后是否需要重启：true，false */ NeedRestart: string; /** * 参数默认值 */ DefaultValue: string; /** * 当前运行参数值 */ CurrentValue: string; /** * 参数说明 */ Tips: string; /** * 参数最小值 */ Min: string; /** * 参数最大值 */ Max: string; /** * 参数状态, 1: 修改中， 2：修改完成 */ Status: number; /** * 参数单位 注意：此字段可能返回 null，表示取不到有效值。 */ Unit: string; } /** * UpgradeVersionToMultiAvailabilityZones请求参数结构体 */ export interface UpgradeVersionToMultiAvailabilityZonesRequest { /** * 实例ID。 */ InstanceId: string; /** * 升级多可用区之后是否支持就近访问功能。
    • true：支持就近访问功能。升级过程，需同时升级 Proxy 版本和 Redis 内核小版本，涉及数据搬迁，可能会长达数小时。
    • false：无需支持就近访问功能。升级多可用区仅涉及管理元数据迁移，对服务没有影响，升级过程通常在3分钟内完成。
    */ UpgradeProxyAndRedisServer?: boolean; } /** * AllocateWanAddress返回参数结构体 */ export interface AllocateWanAddressResponse { /** * 异步流程ID */ FlowId: number; /** * 开通外网的状态 */ WanStatus: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorTookDist请求参数结构体 */ export interface DescribeInstanceMonitorTookDistRequest { /** * 实例Id */ InstanceId: string; /** * 时间；例如："20190219" */ Date: string; /** * 时间范围：1——实时，2——近30分钟，3——近6小时，4——近24小时 */ SpanType: number; } /** * DeleteReplicationInstance请求参数结构体 */ export interface DeleteReplicationInstanceRequest { /** * 复制组ID */ GroupId: string; /** * 实例ID */ InstanceId: string; /** * 数据同步类型，true:需要数据强同步,false:不需要强同步，仅限删除主实例 */ SyncType: boolean; } /** * KillMasterGroup请求参数结构体 */ export interface KillMasterGroupRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 该参数用于配置指定实例的访问密码。若为免密认证，该参数则无需配置。密码复杂度要求如下所示。 - 长度8-30位,推荐使用12位以上的密码 - 不能以"/"开头 - 至少包含小写字母a-z、大写字母A-Z、数字0-9及其 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。 */ Password?: string; /** * 分片集群的分片 ID。 */ ShardIds?: Array; } /** * SwitchAccessNewInstance返回参数结构体 */ export interface SwitchAccessNewInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CloneInstances返回参数结构体 */ export interface CloneInstancesResponse { /** * 请求任务 ID。 */ DealId?: string; /** * 克隆实例的 ID。 */ InstanceIds?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 参数模板信息 */ export interface ParamTemplateInfo { /** * 参数模板 ID。 */ TemplateId: string; /** * 参数模板名称。 */ Name: string; /** * 参数模板描述。 */ Description: string; /** * 实例类型。 - 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内存版（集群架构）。 */ ProductType: number; } /** * DescribeInstanceMonitorTopNCmdTook返回参数结构体 */ export interface DescribeInstanceMonitorTopNCmdTookResponse { /** * 耗时详细信息 */ Data: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CloseSSL请求参数结构体 */ export interface CloseSSLRequest { /** * 实例ID。 */ InstanceId: string; } /** * DescribeInstanceMonitorBigKeySizeDist请求参数结构体 */ export interface DescribeInstanceMonitorBigKeySizeDistRequest { /** * 实例Id */ InstanceId: string; /** * 时间；例如："20190219" */ Date: string; } /** * DescribeInstanceAccount请求参数结构体 */ export interface DescribeInstanceAccountRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 分页大小。 */ Limit: number; /** * 分页偏移量。取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset: number; } /** * 实例字符型参数描述 */ export interface InstanceTextParam { /** * 参数名称。 */ ParamName: string; /** * 参数类型。例如：text。 */ ValueType: string; /** * 参数修改后是否需要重启。 - true：需要。 - false：不需要。 */ NeedRestart: string; /** * 参数默认值。 */ DefaultValue: string; /** * 参数当前运行值。 */ CurrentValue: string; /** * 参数说明。 */ Tips: string; /** * 参数可取值。 */ TextValue: Array; /** * 参数修改状态。 - 1: 修改中。 - 2：修改完成。 */ Status: number; } /** * DescribeInstanceParamRecords请求参数结构体 */ export interface DescribeInstanceParamRecordsRequest { /** * 实例Id */ InstanceId: string; /** * 分页大小 */ Limit?: number; /** * 偏移量，取Limit整数倍 */ Offset?: number; } /** * DescribeTaskList请求参数结构体 */ export interface DescribeTaskListRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId?: string; /** * 实例名称。 */ InstanceName?: string; /** * 每页输出的任务列表大小。默认为 20，最多输出100条。 */ Limit?: number; /** * 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset?: number; /** * 项目 ID。登录 [Redis 控制台](https://console.cloud.tencent.com/redis)，在右上角的账号信息下拉菜单中，选择**项目管理**，即可获取对应的项目 ID。 */ ProjectIds?: Array; /** * 任务类型。 - 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：备份实例。 */ TaskTypes?: Array; /** * 任务执行的起始时间。格式如：2021-12-30 00:00:00。 */ BeginTime?: string; /** * 任务运行的终止时间。格式如：2021-12-30 20:59:35 */ EndTime?: string; /** * 该参数为内部使用，请忽略。 */ TaskStatus?: Array; /** * 任务执行状态。 - 0：任务初始化。 - 1：执行中。 - 2：完成。 - 4：失败。 */ Result?: Array; /** * 该字段已废弃，使用OperateUin代替，请忽略。 */ OperatorUin?: Array; /** * 操作者账号 ID，UIN。 */ OperateUin?: Array; } /** * ChangeReplicaToMaster返回参数结构体 */ export interface ChangeReplicaToMasterResponse { /** * 异步任务ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInstances返回参数结构体 */ export interface CreateInstancesResponse { /** * 交易的ID。 */ DealId?: string; /** * 实例ID。 */ InstanceIds?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskInfo请求参数结构体 */ export interface DescribeTaskInfoRequest { /** * 任务 ID。 */ TaskId: number; } /** * CloneInstances请求参数结构体 */ export interface CloneInstancesRequest { /** * 指定待克隆的源实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 单次克隆实例的数量。 - 包年包月每次购买最大数量为100。 - 按量计费每次购买最大数量为30。 */ GoodsNum: number; /** * 克隆实例所属的可用区ID。当前所支持的可用区 ID，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 */ ZoneId: number; /** * 付费方式。
    • 0：按量计费。
    • 1：包年包月。
    */ BillingMode: number; /** * 购买实例时长。
    • 单位：月。
    • 付费方式选择包年包月计费时，取值范围为[1,2,3,4,5,6,7,8,9,10,11,12,24,36,48,60]。
    • 付费方式选择按量计费时，设置为1。
    */ Period: number; /** * 安全组ID。请登录控制台，在安全组页面获取安全组 ID 信息。 */ SecurityGroupIdList: Array; /** * 克隆实例使用的备份ID。请通过接口[DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011)获取备份ID。 */ BackupId: string; /** * 配置克隆实例是否支持免密访问。开启 SSL 与外网均不支持免密访问。
    • true：免密实例，
    • false：非免密实例。默认为非免密实例。
    */ NoAuth?: boolean; /** * 配置克隆实例的私有网络ID。如果未配置该参数，默认选择基础网络。 */ VpcId?: string; /** * 配置克隆实例所属私有网络的子网。基础网络时该参数无需配置。 */ SubnetId?: string; /** * 克隆实例的名称。
    仅支持长度小于60的中文、英文或者数字，短划线"-"、下划线"_"。
    */ InstanceName?: string; /** * 克隆实例的访问密码。
    • 当输入参数NoAuth为true时，可不设置该参数。
    • 当实例为Redis2.8、4.0和5.0时，其密码格式为：8-30个字符，至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头；
    • 当实例为CKV 3.2时，其密码格式为：8-30个字符，必须包含字母和数字，且不包含其他字符。
    */ Password?: string; /** * 自动续费标识。
    • 0：默认状态，手动续费。
    • 1：自动续费。
    • 2：不自动续费，到期自动隔离。
    */ AutoRenew?: number; /** * 用户自定义的端口，默认为6379，取值范围[1024,65535]。 */ VPort?: number; /** * 实例的节点信息。
    • 目前支持配置节点的类型（主节点或者副本节点），及其节点的可用区信息。具体信息，请参见[RedisNodeInfo](https://cloud.tencent.com/document/product/239/20022#RedisNodeInfo)。
    • 单可用区部署可不配置该参数。
    */ NodeSet?: Array; /** * 项目 ID。登录[Redis 控制台](https://console.cloud.tencent.com/redis#/)，可在右上角的账号中心 > 项目管理中查找项目ID。 */ ProjectId?: number; /** * 克隆实例需绑定的标签。 */ ResourceTags?: Array; /** * 指定克隆实例相关的参数模板 ID。 - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。 */ TemplateId?: string; /** * 指定克隆实例的告警策略 ID。请登录[腾讯云可观测平台控制台](https://console.cloud.tencent.com/monitor/alarm2/policy)，在 告警管理 > 策略管理页面获取策略 ID 信息。 */ AlarmPolicyList?: Array; } /** * ApplyParamsTemplate返回参数结构体 */ export interface ApplyParamsTemplateResponse { /** * 任务ID */ TaskIds: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeReplicationGroup请求参数结构体 */ export interface DescribeReplicationGroupRequest { /** * 每页输出实例列表的大小，参数默认值20。 */ Limit: number; /** * 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset: number; /** * 指定复制组 ID。例如：crs-rpl-m3zt****。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。 */ GroupId?: string; /** * 模糊查询的关键字，可以设置为复制组ID或复制组名称进行模糊查询。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID及名称。 */ SearchKey?: string; } /** * Redis节点信息 */ export interface RedisNodes { /** * 节点 ID。 */ NodeId: string; /** * 节点角色。 */ NodeRole: string; /** * 分片 ID。 */ ClusterId: number; /** * 可用区 ID。 */ ZoneId: number; } /** * DescribeInstanceMonitorTopNCmd请求参数结构体 */ export interface DescribeInstanceMonitorTopNCmdRequest { /** * 实例Id */ InstanceId: string; /** * 时间范围：1——实时，2——近30分钟，3——近6小时，4——近24小时 */ SpanType: number; } /** * ModifyNetworkConfig请求参数结构体 */ export interface ModifyNetworkConfigRequest { /** * 实例 ID。 */ InstanceId: string; /** * 指预修改网络的类别，包括： - changeVip：指切换私有网络，包含其内网IPv4地址及端口。 - changeVpc：指切换私有网络所属子网。 - changeBaseToVpc：指基础网络切换为私有网络。 - changeVPort：指仅修改实例网络端口。 */ Operation: string; /** * 指实例私有网络内网 IPv4 地址。当**Operation**为**changeVip**时，需配置该参数。 */ Vip?: string; /** * 指修改后的私有网络 ID，当**Operation**为**changeVpc**或**changeBaseToVpc**时，需配置该参数。 */ VpcId?: string; /** * 指修改后的私有网络所属子网 ID，当**Operation**为**changeVpc**或**changeBaseToVpc**时，需配置该参数。 */ SubnetId?: string; /** * 原内网 IPv4 地址保留时长。 - 单位：天。 - 取值范围：0、1、2、3、7、15。 **说明**：设置原地址保留时长需最新版SDK，否则原地址将立即释放，查看SDK版本，请参见 [SDK中心](https://cloud.tencent.com/document/sdk)。 */ Recycle?: number; /** * 指修改后的网络端口。当**Operation**为**changeVPort**或**changeVip**时，需配置该参数。取值范围为[1024,65535]。 */ VPort?: number; } /** * DescribeInstanceSecurityGroup请求参数结构体 */ export interface DescribeInstanceSecurityGroupRequest { /** * 实例 ID 列表。例如;["crs-f2ho5rsz\n"] */ InstanceIds: Array; } /** * 实例参数修改历史 */ export interface InstanceParamHistory { /** * 参数名称。 */ ParamName: string; /** * 参数修改之前的值。 */ PreValue: string; /** * 参数修改之后的值。 */ NewValue: string; /** * 参数配置状态。 - 1：参数配置修改中。 - 2：参数配置修改成功。 - 3：参数配置修改失败。 */ Status: number; /** * 修改时间。 */ ModifyTime: string; } /** * DescribeInstanceParams请求参数结构体 */ export interface DescribeInstanceParamsRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; } /** * CleanUpInstance返回参数结构体 */ export interface CleanUpInstanceResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceSecurityGroups请求参数结构体 */ export interface ModifyDBInstanceSecurityGroupsRequest { /** * 数据库引擎名称，本接口取值：redis。 */ Product: string; /** * 要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。 */ SecurityGroupIds: Array; /** * 实例 ID，格式如：cdb-c1nl9rpv或者cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。 */ InstanceId: string; } /** * DescribeParamTemplates返回参数结构体 */ export interface DescribeParamTemplatesResponse { /** * 该用户的参数模板数量。 */ TotalCount: number; /** * 参数模板详情。 */ Items: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceShards请求参数结构体 */ export interface DescribeInstanceShardsRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 是否过滤掉从节信息。 - true；过滤从节点。 - false：不过滤。 */ FilterSlave?: boolean; } /** * 安全组出站规则 */ export interface Outbound { /** * 策略，ACCEPT或者DROP。 */ Action: string; /** * 地址组id代表的地址集合。 */ AddressModule: string; /** * 来源Ip或Ip段，例如192.168.0.0/16。 */ CidrIp: string; /** * 描述。 */ Desc: string; /** * 网络协议，支持udp、tcp等。 */ IpProtocol: string; /** * 端口。 */ PortRange: string; /** * 服务组id代表的协议和端口集合。 */ ServiceModule: string; /** * 安全组id代表的地址集合。 */ Id: string; } /** * DescribeAutoBackupConfig返回参数结构体 */ export interface DescribeAutoBackupConfigResponse { /** * 该参数因兼容性问题暂时保留，请忽略。 */ AutoBackupType?: number; /** * 备份周期，默认为每天自动备份，Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。 */ WeekDays?: Array; /** * 备份任务发起时间段。 */ TimePeriod?: string; /** * 全量备份文件保存天数。默认为7天。如需保存更多天数，请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。 */ BackupStorageDays?: number; /** * 该参数不再使用，请忽略。 */ BinlogStorageDays?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceUpgradeInstance请求参数结构体 */ export interface InquiryPriceUpgradeInstanceRequest { /** * 实例Id */ InstanceId: string; /** * 分片大小 单位 MB */ MemSize: number; /** * 分片数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写 */ RedisShardNum?: number; /** * 副本数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写 */ RedisReplicasNum?: number; } /** * ModifyParamTemplate返回参数结构体 */ export interface ModifyParamTemplateResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProjectSecurityGroups请求参数结构体 */ export interface DescribeProjectSecurityGroupsRequest { /** * 数据库引擎名称，本接口取值：redis。 */ Product: string; /** * 项目 ID。 */ ProjectId: number; /** * 偏移量，取值为Limit的整数倍。 */ Offset?: number; /** * 拉取数量限制，默认 20。 */ Limit?: number; /** * 搜索条件，支持安全组 ID 或者安全组名称。 */ SearchKey?: string; } /** * DescribeInstanceMonitorBigKeySizeDist返回参数结构体 */ export interface DescribeInstanceMonitorBigKeySizeDistResponse { /** * 大Key大小分布详情 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全组规则 */ export interface SecurityGroup { /** * 创建时间，时间格式：yyyy-mm-dd hh:mm:ss。 */ CreateTime: string; /** * 项目ID。 */ ProjectId: number; /** * 安全组ID。 */ SecurityGroupId: string; /** * 安全组名称。 */ SecurityGroupName: string; /** * 安全组备注。 */ SecurityGroupRemark: string; /** * 出站规则。 */ Outbound: Array; /** * 入站规则。 */ Inbound: Array; } /** * CreateInstanceAccount请求参数结构体 */ export interface CreateInstanceAccountRequest { /** * 实例ID */ InstanceId: string; /** * 子账号名称 */ AccountName: string; /** * 1.长度8-30位,推荐使用12位以上的密码 2.不能以"/"开头 3.至少包含两项 a.小写字母a-z b.大写字母A-Z c.数字0-9 d.()`~!@#$%^&*-+=_|{}[]:;<>,.?/ */ AccountPassword: string; /** * 路由策略：填写master或者replication，表示主节点或者从节点 */ ReadonlyPolicy: Array; /** * 读写策略：填写r、rw，表示只读、读写 */ Privilege: string; /** * 子账号描述信息 */ Remark?: string; } /** * RemoveReplicationInstance请求参数结构体 */ export interface RemoveReplicationInstanceRequest { /** * 复制组ID */ GroupId: string; /** * 实例ID */ InstanceId: string; /** * 数据同步类型，true:需要数据强同步,false:不需要强同步，仅限删除主实例 */ SyncType: boolean; } /** * EnableReplicaReadonly返回参数结构体 */ export interface EnableReplicaReadonlyResponse { /** * 错误：ERROR，正确OK（已废弃） 注意：此字段可能返回 null，表示取不到有效值。 */ Status: string; /** * 任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMaintenanceWindow返回参数结构体 */ export interface DescribeMaintenanceWindowResponse { /** * 维护时间窗起始时间，如：17:00 */ StartTime?: string; /** * 维护时间窗结束时间，如：19:00 */ EndTime?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceSecurityGroup返回参数结构体 */ export interface DescribeInstanceSecurityGroupResponse { /** * 实例安全组信息。 */ InstanceSecurityGroupsDetail?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReleaseWanAddress返回参数结构体 */ export interface ReleaseWanAddressResponse { /** * 异步流程ID */ FlowId: number; /** * 关闭外网的状态 */ WanStatus: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 产品信息 */ export interface ProductConf { /** * 产品类型。 - 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内存版（集群架构）。 */ Type: number; /** * 产品名称。包括：Redis 主从版、CKV 主从版、CKV 集群版、Redis 单机版、Redis 集群版。 */ TypeName: string; /** * 购买时的最小数量。 */ MinBuyNum: number; /** * 购买时的最大数量。 */ MaxBuyNum: number; /** * 产品是否售罄。 - true：售罄。 - false：未售罄。 */ Saleout: boolean; /** * 产品引擎。包括：腾讯云 CKV与社区版 Redis。 */ Engine: string; /** * 兼容版本。包括：Redis-2.8、Redis-3.2、Redis-4.0、Redis-5.0、Redis-6.2。 */ Version: string; /** * 规格总大小，单位GB。 */ TotalSize: Array; /** * 每个分片大小，单位GB。 */ ShardSize: Array; /** * 副本数量。 */ ReplicaNum: Array; /** * 分片数量。 */ ShardNum: Array; /** * 支持的计费模式。 - 1：包年包月。 - 0：按量计费。 */ PayMode: string; /** * 是否支持副本只读。 - true：支持副本只读。 - false：不支持。 */ EnableRepicaReadOnly: boolean; } /** * ModifyConnectionConfig请求参数结构体 */ export interface ModifyConnectionConfigRequest { /** * 实例的ID，长度在12-36之间。 */ InstanceId: string; /** * 附加带宽，大于0，单位MB。 */ Bandwidth?: number; /** * 单分片的总连接数。 未开启副本只读时，下限为10000，上限为40000； 开启副本只读时，下限为10000，上限为10000×(只读副本数+3)。 */ ClientLimit?: number; } /** * ManualBackupInstance返回参数结构体 */ export interface ManualBackupInstanceResponse { /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例节点 */ export interface InstanceNode { /** * 实例 ID。 */ Id: number; /** * 节点详细信息。 */ InstanceClusterNode: Array; } /** * tendis节点信息 */ export interface TendisNodes { /** * 节点ID */ NodeId: string; /** * 节点角色 */ NodeRole: string; } /** * SwitchProxy返回参数结构体 */ export interface SwitchProxyResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartupInstance返回参数结构体 */ export interface StartupInstanceResponse { /** * 任务id */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 详细DTS实例信息 */ export interface DescribeInstanceDTSInstanceInfo { /** * 地域ID 注意：此字段可能返回 null，表示取不到有效值。 */ RegionId: number; /** * 实例ID 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 仓库ID 注意：此字段可能返回 null，表示取不到有效值。 */ SetId: number; /** * 可用区ID 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId: number; /** * 实例类型 注意：此字段可能返回 null，表示取不到有效值。 */ Type: number; /** * 实例名称 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName: string; /** * 实例访问地址 注意：此字段可能返回 null，表示取不到有效值。 */ Vip: string; /** * 状态 注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; } /** * 订单交易信息 */ export interface TradeDealDetail { /** * 订单号ID，调用云API时使用此ID */ DealId: string; /** * 长订单ID，反馈订单问题给官方客服使用此ID */ DealName: string; /** * 可用区id */ ZoneId: number; /** * 订单关联的实例数 */ GoodsNum: number; /** * 创建用户uin */ Creater: string; /** * 订单创建时间 */ CreatTime: string; /** * 订单超时时间 */ OverdueTime: string; /** * 订单完成时间 */ EndTime: string; /** * 订单状态 1：未支付 2:已支付，未发货 3:发货中 4:发货成功 5:发货失败 6:已退款 7:已关闭订单 8:订单过期 9:订单已失效 10:产品已失效 11:代付拒绝 12:支付中 */ Status: number; /** * 订单状态描述 */ Description: string; /** * 订单实际总价，单位：分 */ Price: number; /** * 实例ID */ InstanceIds: Array; } /** * API购买实例绑定标签 */ export interface ResourceTag { /** * 标签Key。 */ TagKey: string; /** * 标签 Key 对应的 Value。 */ TagValue: string; } /** * AssociateSecurityGroups返回参数结构体 */ export interface AssociateSecurityGroupsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例节点组信息 */ export interface ReplicaGroup { /** * 节点组 ID。 */ GroupId: number; /** * 节点组的名称，主节点为空。 */ GroupName: string; /** * 节点的可用区ID，比如ap-guangzhou-1 */ ZoneId: string; /** * 节点组类型，master为主节点，replica为副本节点 */ Role: string; /** * 节点组节点列表 */ RedisNodes: Array; } /** * DescribeTaskInfo返回参数结构体 */ export interface DescribeTaskInfoResponse { /** * 任务状态。 - preparing：待执行。 - running：执行中。 - succeed：成功。 - failed：失败。 - error：执行出错。 */ Status?: string; /** * 任务开始时间。 */ StartTime?: string; /** * 任务类型。常见的类型包含：新建类型、配置变更、关闭实例、清空实例、重置密码、版本升级、备份实例、改变网络类型、实例可用区迁移、手动提主等。 */ TaskType?: string; /** * 实例的 ID。 */ InstanceId?: string; /** * 任务执行返回的信息，执行错误时显示错误信息。执行中或执行成功则为空。 */ TaskMessage?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorBigKeyTypeDist返回参数结构体 */ export interface DescribeInstanceMonitorBigKeyTypeDistResponse { /** * 大Key类型分布详细信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteReplicationInstance返回参数结构体 */ export interface DeleteReplicationInstanceResponse { /** * 异步任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CleanUpInstance请求参数结构体 */ export interface CleanUpInstanceRequest { /** * 实例ID */ InstanceId: string; } /** * DescribeInstanceDealDetail返回参数结构体 */ export interface DescribeInstanceDealDetailResponse { /** * 订单详细信息。 */ DealDetails?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 复制组信息 */ export interface Groups { /** * 用户 APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。 */ AppId?: number; /** * 地域ID 。 - 1：广州 - 4：上海 - 5：中国香港 - 6：多伦多 - 7：上海金融 - 8：北京 - 9：新加坡 - 11：深圳金融 - 15：美西（硅谷） - 16：成都 - 17：德国 - 18：韩国 - 19：重庆 - 21：印度 - 22：美东（弗吉尼亚） - 23：泰国 - 25：日本 */ RegionId?: number; /** * 复制组 ID。格式如：crs-rpl-deind****。 */ GroupId?: string; /** * 复制组名称。 注意：此字段可能返回 null，表示取不到有效值。 */ GroupName?: string; /** * 复制组状态。 - 37：绑定复制组中。 - 38：复制组重连中。 - 51：解绑复制组中。 - 52：复制组实例切主中。 - 53：角色变更中。 */ Status?: number; /** * 复制组数量。 */ InstanceCount?: number; /** * 复制组中的实例信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Instances?: Array; /** * 备注信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; } /** * DescribeInstances请求参数结构体 */ export interface DescribeInstancesRequest { /** * 每页输出实例的数量，参数默认值20，最大值为1000。 */ Limit?: number; /** * 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset?: number; /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId?: string; /** * 实例列表排序依据，枚举值如下所示： - projectId：依据项目ID排序。 - createtime：依据实例创建时间排序。 - instancename：依据实例名称排序。 - type：依据实例类型排序。 - curDeadline：依据实例到期时间排序。 */ OrderBy?: string; /** * 实例排序方式，默认为倒序排序。 - 1：倒序。 - 0：顺序。 */ OrderType?: number; /** * 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留，可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。 */ VpcIds?: Array; /** * 私有网络所属子网 ID 数组，例如：56854。该参数暂时保留，可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。 */ SubnetIds?: Array; /** * 设置模糊查询关键字段，仅实例名称支持模糊查询。 */ SearchKey?: string; /** * 项目 ID 组成的数组。 */ ProjectIds?: Array; /** * 实例名称。 */ InstanceName?: string; /** * 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络，如：vpc-sad23jfdfk。 */ UniqVpcIds?: Array; /** * 私有网络所属子网 ID 数组，如：subnet-fdj24n34j2。 */ UniqSubnetIds?: Array; /** * 地域 ID 数组，该参数已经弃用，可通过公共参数Region查询对应地域。 */ RegionIds?: Array; /** * 实例状态。 - 0：待初始化。 - 1：流程中。 - 2：运行中。 - -2：已隔离。 - -3：待删除。 */ Status?: Array; /** * 实例架构版本。 - 1：单机版。 - 2：主从版。 - 3：集群版。 */ TypeVersion?: number; /** * 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。 */ EngineName?: string; /** * 续费模式。 - 0：手动续费。 - 1：自动续费。 - 2：到期不再续费。 */ AutoRenew?: Array; /** * 计费模式。 - postpaid：按量计费。 - prepaid：包年包月。 */ BillingMode?: string; /** * 实例类型。 - 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内存版（集群架构）。 */ Type?: number; /** * 该参数为数组类型，支持配置实例名称、实例 ID、IP地址，其中实例名称为模糊匹配，实例 ID 和 IP 地址精确匹配。 - 数组中每一个元素取并集进行匹配查询。 - **InstanceId** 与 **SearchKeys** 同时配置，则取二者交集进行匹配查询。 */ SearchKeys?: Array; /** * 内部参数，用户可忽略。 */ TypeList?: Array; /** * 内部参数，用户可忽略。 */ MonitorVersion?: string; /** * 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。 */ InstanceTags?: Array; /** * 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。 */ TagKeys?: Array; /** * 实例的产品版本。如果该参数不配置或者数组设置为空值，则默认不依据此参数过滤实例。 - local：本地盘版。 - cdc：独享集群版。 */ ProductVersions?: Array; /** * 批量查询指定的实例 ID，返回结果已 Limit 限制为主。 */ InstanceIds?: Array; /** * 可用区模式。 - singleaz：单可用区。 - multiaz：多可用区。 */ AzMode?: string; } /** * 访问命令 */ export interface SourceCommand { /** * 命令 */ Cmd: string; /** * 执行次数 */ Count: number; } /** * ModfiyInstancePassword请求参数结构体 */ export interface ModfiyInstancePasswordRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 实例旧密码。 */ OldPassword: string; /** * 实例新密码。密码复杂度要求如下： - 长度8 - 30位, 推荐使用12位以上的密码。 - 不能以"/"开头。 - 至少包含小写字母a - z、大写字母A - Z、数字0 - 9、特殊字符 ()~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。 */ Password: string; } /** * DescribeSlowLog请求参数结构体 */ export interface DescribeSlowLogRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 预查询慢日志的起始时间。 */ BeginTime: string; /** * 预查询慢日志的结束时间。 */ EndTime: string; /** * 慢查询平均执行时间阈值，单位：毫秒。 */ MinQueryTime?: number; /** * 每个页面展示的慢查询条数，默认值为20。取值范围：[20,1000]。 */ Limit?: number; /** * 慢查询条数的偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset?: number; /** * 节点所属角色。
    • master：主节点。
    • slave：从节点。
    */ Role?: string; } /** * DeleteParamTemplate请求参数结构体 */ export interface DeleteParamTemplateRequest { /** * 参数模板 ID。 */ TemplateId: string; } /** * DescribeAutoBackupConfig请求参数结构体 */ export interface DescribeAutoBackupConfigRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; } /** * DescribeInstanceMonitorSIP返回参数结构体 */ export interface DescribeInstanceMonitorSIPResponse { /** * 访问来源信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyPostpaidInstance请求参数结构体 */ export interface DestroyPostpaidInstanceRequest { /** * 实例ID */ InstanceId: string; } /** * ChangeInstanceRole请求参数结构体 */ export interface ChangeInstanceRoleRequest { /** * 复制组ID */ GroupId: string; /** * 实例ID */ InstanceId: string; /** * 实例角色，rw可读写，r只读 */ InstanceRole: string; } /** * DescribeInstanceSupportFeature请求参数结构体 */ export interface DescribeInstanceSupportFeatureRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 示例值：crs-asdasdas */ InstanceId: string; /** * 功能特性名称 - read-local-node-only 就近接入功能 - multi-account 多账号功能 */ FeatureName: string; } /** * DeleteInstanceAccount请求参数结构体 */ export interface DeleteInstanceAccountRequest { /** * 实例ID */ InstanceId: string; /** * 子账号名称 */ AccountName: string; } /** * DescribeInstanceMonitorHotKey请求参数结构体 */ export interface DescribeInstanceMonitorHotKeyRequest { /** * 实例Id */ InstanceId: string; /** * 时间范围：1——实时，2——近30分钟，3——近6小时，4——近24小时 */ SpanType: number; } /** * DescribeBackupDownloadRestriction返回参数结构体 */ export interface DescribeBackupDownloadRestrictionResponse { /** * 下载备份文件的网络限制类型： - NoLimit：不限制，腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet：仅腾讯云自动分配的内网地址可下载备份文件。 - Customize：指用户自定义的私有网络可下载备份文件。 */ LimitType?: string; /** * 该参数仅支持输入 In，表示自定义的**LimitVpc**可以下载备份文件。 */ VpcComparisonSymbol?: string; /** * 标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。 - NotIn: 自定义的 IP 不可以下载。 */ IpComparisonSymbol?: string; /** * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，显示该参数。 */ LimitVpc?: Array; /** * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，显示该参数。 */ LimitIp?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeInstance返回参数结构体 */ export interface UpgradeInstanceResponse { /** * 订单ID。 */ DealId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchAccessNewInstance请求参数结构体 */ export interface SwitchAccessNewInstanceRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 示例值：crs-asdasdas */ InstanceId: string; } /** * ManualBackupInstance请求参数结构体 */ export interface ManualBackupInstanceRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 手动备份任务的备注信息。 */ Remark?: string; /** * 备份数据的保存天数。 - 单位：天；默认值为7天；取值范围：[0.1825]。如果超过 7天，请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。 - 如果不配置该参数，默认与自动备份的保留时间一致。 - 如果未设置自动备份，默认为7天。 */ StorageDays?: number; } /** * DescribeReplicationGroup返回参数结构体 */ export interface DescribeReplicationGroupResponse { /** * 复制组数量。 */ TotalCount?: number; /** * 复制组信息。 */ Groups?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyParamTemplate请求参数结构体 */ export interface ModifyParamTemplateRequest { /** * 源参数模板 ID。 */ TemplateId: string; /** * 参数模板修改后的新名称。 */ Name?: string; /** * 参数模板修改后的新描述。 */ Description?: string; /** * 修改后的新参数列表。 */ ParamList?: Array; } /** * ModfiyInstancePassword返回参数结构体 */ export interface ModfiyInstancePasswordResponse { /** * 任务 ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例详细信息列表。 */ export interface InstanceSet { /** * 实例名称。 */ InstanceName?: string; /** * 实例 ID。 */ InstanceId?: string; /** * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。 */ Appid?: number; /** * 项目 ID。 */ ProjectId?: number; /** * 地域 ID。
    • 1：广州。
    • 4：上海。
    • 5：中国香港。
    • 6：多伦多。
    • 7：上海金融。
    • 8：北京。
    • 9：新加坡。
    • 11：深圳金融。
    • 15：美西（硅谷）。
    • 16：成都。
    • 17：法兰克福。
    • 18：首尔。
    • 19：重庆。
    • 21：孟买。
    • 22：美东（弗吉尼亚）。
    • 23：曼谷。
    • 25：东京。
    */ RegionId?: number; /** * 区域 ID。 */ ZoneId?: number; /** * vpc网络 ID，例如75101。 */ VpcId?: number; /** * vpc网络下子网ID，如：46315。 */ SubnetId?: number; /** * 实例当前状态。
    • 0：待初始化。
    • 1：实例在流程中。
    • 2：实例运行中。
    • -2：实例已隔离。
    • -3：实例待删除。
    */ Status?: number; /** * 实例 VIP。 */ WanIp?: string; /** * 实例端口号。 */ Port?: number; /** * 实例创建时间。格式如：2020-01-15 10:20:00。 */ Createtime?: string; /** * 实例内存容量大小。单位：MB，1MB=1024KB。 */ Size?: number; /** * 该字段已废弃。请使用腾讯云可观测平台API 接口 [GetMonitorData](https://cloud.tencent.com/document/product/248/31014) 获取实例已使用的内存容量。 */ SizeUsed?: number; /** * 实例类型。 - 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内存版（集群架构）。 */ Type?: number; /** * 实例是否设置自动续费标识。
    • 1：设置自动续费。
    • 0：未设置自动续费。
    */ AutoRenewFlag?: number; /** * 包年包月计费实例到期的时间。 */ DeadlineTime?: string; /** * 引擎：社区版Redis、腾讯云CKV。 */ Engine?: string; /** * 产品类型。
    • standalone：标准版。
    • cluster ：集群版。
    */ ProductType?: string; /** * vpc网络id，例如vpc-fk33jsf43kgv。 */ UniqVpcId?: string; /** * vpc网络下子网id，例如：subnet-fd3j6l35mm0。 */ UniqSubnetId?: string; /** * 计费模式。
    • 0：按量计费。
    • 1：包年包月。
    */ BillingMode?: number; /** * 实例运行状态描述：如”实例运行中“。 */ InstanceTitle?: string; /** * 已隔离实例默认下线时间。按量计费实例隔离后默认两小时后下线，包年包月默认7天后下线。格式如：2020-02-15 10:20:00。 */ OfflineTime?: string; /** * 流程中的实例，返回子状态。 */ SubStatus?: number; /** * 反亲和性标签。 */ Tags?: Array; /** * 实例节点信息。 */ InstanceNode?: Array; /** * 分片大小。 */ RedisShardSize?: number; /** * 分片数量。 */ RedisShardNum?: number; /** * 副本数量。 */ RedisReplicasNum?: number; /** * 计费 ID。 */ PriceId?: number; /** * 实例隔离开始的时间。 */ CloseTime?: string; /** * 从节点读取权重。 */ SlaveReadWeight?: number; /** * 实例关联的标签信息。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceTags?: Array; /** * 项目名称。 注意：此字段可能返回 null，表示取不到有效值。 */ ProjectName?: string; /** * 是否为免密实例。
    • true：免密实例。
    • false：非免密实例。
    注意：此字段可能返回 null，表示取不到有效值。 */ NoAuth?: boolean; /** * 客户端连接数。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientLimit?: number; /** * DTS状态（内部参数，用户可忽略）。 注意：此字段可能返回 null，表示取不到有效值。 */ DtsStatus?: number; /** * 分片带宽上限，单位MB。 注意：此字段可能返回 null，表示取不到有效值。 */ NetLimit?: number; /** * 免密实例标识（内部参数，用户可忽略）。 注意：此字段可能返回 null，表示取不到有效值。 */ PasswordFree?: number; /** * 内部参数，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ Vip6?: string; /** * 实例只读标识（内部参数，用户可忽略）。 注意：此字段可能返回 null，表示取不到有效值。 */ ReadOnly?: number; /** * 内部参数，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ RemainBandwidthDuration?: string; /** * Redis实例请忽略该参数。 注意：此字段可能返回 null，表示取不到有效值。 */ DiskSize?: number; /** * 监控版本。
    • 1m：1分钟粒度监控。目前该监控粒度已下线，具体信息，请参见[云数据库 Redis 1分钟粒度下线公告](https://cloud.tencent.com/document/product/239/80653)。
    • 5s：5秒粒度监控。
    注意：此字段可能返回 null，表示取不到有效值。 */ MonitorVersion?: string; /** * 客户端最大连接数可设置的最小值。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientLimitMin?: number; /** * 客户端最大连接数可设置的最大值。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientLimitMax?: number; /** * 实例的节点详细信息。 注意：此字段可能返回 null，表示取不到有效值。 */ NodeSet?: Array; /** * 实例所在的地域信息，比如ap-guangzhou。 注意：此字段可能返回 null，表示取不到有效值。 */ Region?: string; /** * 外网地址。 注意：此字段可能返回 null，表示取不到有效值。 */ WanAddress?: string; /** * 北极星服务地址，内部使用。 注意：此字段可能返回 null，表示取不到有效值。 */ PolarisServer?: string; /** * 实例当前Proxy版本。 注意：此字段可能返回 null，表示取不到有效值。 */ CurrentProxyVersion?: string; /** * 实例当前Cache小版本。 注意：此字段可能返回 null，表示取不到有效值。 */ CurrentRedisVersion?: string; /** * 实例可升级Proxy版本。 注意：此字段可能返回 null，表示取不到有效值。 */ UpgradeProxyVersion?: string; /** * 实例可升级Cache小版本。 注意：此字段可能返回 null，表示取不到有效值。 */ UpgradeRedisVersion?: string; } /** * ReleaseWanAddress请求参数结构体 */ export interface ReleaseWanAddressRequest { /** * 实例ID */ InstanceId: string; } /** * InquiryPriceRenewInstance请求参数结构体 */ export interface InquiryPriceRenewInstanceRequest { /** * 购买时长，单位：月 */ Period: number; /** * 实例ID */ InstanceId: string; } /** * CloseSSL返回参数结构体 */ export interface CloseSSLResponse { /** * 任务ID。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMaintenanceWindow返回参数结构体 */ export interface ModifyMaintenanceWindowResponse { /** * 修改状态：success 或者 failed */ Status: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateReplicationGroup返回参数结构体 */ export interface CreateReplicationGroupResponse { /** * 异步流程ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorBigKeyTypeDist请求参数结构体 */ export interface DescribeInstanceMonitorBigKeyTypeDistRequest { /** * 实例Id */ InstanceId: string; /** * 时间；例如："20190219" */ Date: string; } /** * DescribeInstanceMonitorTopNCmdTook请求参数结构体 */ export interface DescribeInstanceMonitorTopNCmdTookRequest { /** * 实例ID */ InstanceId: string; /** * 时间范围：1——实时，2——近30分钟，3——近6小时，4——近24小时 */ SpanType: number; } /** * DestroyPrepaidInstance返回参数结构体 */ export interface DestroyPrepaidInstanceResponse { /** * 订单Id */ DealId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCommonDBInstances返回参数结构体 */ export interface DescribeCommonDBInstancesResponse { /** * 实例数 */ TotalCount?: number; /** * 实例信息 */ InstanceDetails?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceCreateInstance请求参数结构体 */ export interface InquiryPriceCreateInstanceRequest { /** * 实例类型：2 – Redis2.8内存版(标准架构)，3 – CKV 3.2内存版(标准架构)，4 – CKV 3.2内存版(集群架构)，6 – Redis4.0内存版(标准架构)，7 – Redis4.0内存版(集群架构)，8 – Redis5.0内存版(标准架构)，9 – Redis5.0内存版(集群架构)。 */ TypeId: number; /** * 内存容量，单位为MB， 数值需为1024的整数倍，具体规格以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。 TypeId为标准架构时，MemSize是实例总内存容量；TypeId为集群架构时，MemSize是单分片内存容量。 */ MemSize: number; /** * 实例数量，单次购买实例数量以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。 */ GoodsNum: number; /** * 购买时长，在创建包年包月实例的时候需要填写，按量计费实例填1即可，单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 */ Period: number; /** * 付费方式:0-按量计费，1-包年包月。 */ BillingMode: number; /** * 实例所属的可用区ID，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 */ ZoneId?: number; /** * 实例分片数量，Redis2.8标准架构、CKV标准架构和Redis2.8单机版、Redis4.0标准架构不需要填写。 */ RedisShardNum?: number; /** * 实例副本数量，Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。 */ RedisReplicasNum?: number; /** * 是否支持副本只读，Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。 */ ReplicasReadonly?: boolean; /** * 实例所属的可用区名称，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 */ ZoneName?: string; /** * "local"本地盘版，"cloud"云盘版，"cdc"独享集群版，如果不传默认询价为本地盘版本 */ ProductVersion?: string; } /** * UpgradeSmallVersion返回参数结构体 */ export interface UpgradeSmallVersionResponse { /** * 异步流程ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceParams请求参数结构体 */ export interface ModifyInstanceParamsRequest { /** * 实例ID。 */ InstanceId: string; /** * 实例修改的参数列表。 */ InstanceParams: Array; } /** * DescribeSSLStatus请求参数结构体 */ export interface DescribeSSLStatusRequest { /** * 实例 ID。 */ InstanceId: string; } /** * OpenSSL请求参数结构体 */ export interface OpenSSLRequest { /** * 实例ID。 */ InstanceId: string; } /** * 备份文件下载信息 */ export interface BackupDownloadInfo { /** * 备份文件名称。 */ FileName?: string; /** * 备份文件大小，单位B，如果为0，表示无效。 */ FileSize?: number; /** * 备份文件外网下载地址。下载地址的有效时长为6小时，过期后请重新获取。 */ DownloadUrl?: string; /** * 备份文件内网下载地址。下载地址的有效时长为6小时，过期后请重新获取。 */ InnerDownloadUrl?: string; } /** * 大Key类型分布详情 */ export interface BigKeyTypeInfo { /** * 类型 */ Type: string; /** * 数量 */ Count: number; /** * 大小 */ Size: number; /** * 时间戳 */ Updatetime: number; } /** * DescribeInstanceNodeInfo请求参数结构体 */ export interface DescribeInstanceNodeInfoRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 列表大小。每页输出的节点信息大小。默认为 20，最多输出1000条。该字段已不再使用，请忽略。 */ Limit?: number; /** * 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。该字段已不再使用，请忽略。 */ Offset?: number; } /** * DescribeMaintenanceWindow请求参数结构体 */ export interface DescribeMaintenanceWindowRequest { /** * 实例ID */ InstanceId: string; } /** * DescribeInstanceSupportFeature返回参数结构体 */ export interface DescribeInstanceSupportFeatureResponse { /** * 是否支持 */ Support?: boolean; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddReplicationInstance请求参数结构体 */ export interface AddReplicationInstanceRequest { /** * 复制组ID。 */ GroupId: string; /** * 实例ID。 */ InstanceId: string; /** * 给复制组添加的实例分配角色。
    • rw：可读写。
    • r：只读。
    */ InstanceRole: string; } /** * 实例节点类型 */ export interface InstanceClusterNode { /** * 节点名称。 */ Name: string; /** * 实例运行时节点 ID。 */ RunId: string; /** * 集群角色。 - 0：master。 - 1：slave。 */ Role: number; /** * 节点状态。 - 0：readwrite,。 - 1：read。 - 2：backup。 */ Status: number; /** * 服务状态。 0-down。 1-on */ Connected: number; /** * 节点创建时间。 */ CreateTime: string; /** * 节点下线时间。 */ DownTime: string; /** * 节点 Slot 分布区间。 */ Slots: string; /** * 节点 Key分布。 */ Keys: number; /** * 节点 QPS。分片节点每秒执行次数。单位：次/秒。 */ Qps: number; /** * 节点 QPS 倾斜度。 */ QpsSlope: number; /** * 节点存储。 */ Storage: number; /** * 节点存储倾斜度。 */ StorageSlope: number; } /** * DescribeSSLStatus返回参数结构体 */ export interface DescribeSSLStatusResponse { /** * SSL 证书下载地址。 */ CertDownloadUrl?: string; /** * 证书下载链接到期时间。 */ UrlExpiredTime?: string; /** * 标识实例开启 SSL 功能。 - true：开启 。 - false：关闭。 */ SSLConfig?: boolean; /** * 标识实例是否支持 SSL特性。 - true：支持。 - false：不支持。 */ FeatureSupport?: boolean; /** * 说明配置 SSL 的状态。 - 1: 配置中。 - 2：配置成功。 */ Status?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTendisSlowLog请求参数结构体 */ export interface DescribeTendisSlowLogRequest { /** * 实例Id：crs-ngvou0i1 */ InstanceId: string; /** * 开始时间：2019-09-08 12:12:41 */ BeginTime: string; /** * 结束时间：2019-09-09 12:12:41 */ EndTime: string; /** * 慢查询阈值（毫秒） */ MinQueryTime?: number; /** * 页面大小：默认20 */ Limit?: number; /** * 偏移量，取Limit整数倍 */ Offset?: number; } /** * DescribeProxySlowLog请求参数结构体 */ export interface DescribeProxySlowLogRequest { /** * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 慢查询的开始时间。 */ BeginTime: string; /** * 慢查询的结束时间。 */ EndTime: string; /** * 慢查询阈值，单位：毫秒。 */ MinQueryTime?: number; /** * 分页大小。默认为 20，取值范围[20,1000]。 */ Limit?: number; /** * 偏移量，取Limit整数倍。 */ Offset?: number; } /** * ModifyInstanceAvailabilityZones返回参数结构体 */ export interface ModifyInstanceAvailabilityZonesResponse { /** * 任务ID。 */ TaskId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProxySlowLog返回参数结构体 */ export interface DescribeProxySlowLogResponse { /** * 慢查询总数。 */ TotalCount?: number; /** * 慢查询详情。 */ InstanceProxySlowLogDetail?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceReadOnly请求参数结构体 */ export interface ModifyInstanceReadOnlyRequest { /** * 实例ID */ InstanceId: string; /** * 实例输入模式，0：读写 1：只读 */ InputMode: string; } /** * DescribeInstanceAccount返回参数结构体 */ export interface DescribeInstanceAccountResponse { /** * 账号详细信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Accounts?: Array; /** * 账号个数。 注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorBigKey请求参数结构体 */ export interface DescribeInstanceMonitorBigKeyRequest { /** * 实例Id */ InstanceId: string; /** * 请求类型：1——string类型，2——所有类型 */ ReqType: number; /** * 时间；例如："20190219" */ Date: string; } /** * DescribeBackupDownloadRestriction请求参数结构体 */ export declare type DescribeBackupDownloadRestrictionRequest = null; /** * DescribeParamTemplateInfo返回参数结构体 */ export interface DescribeParamTemplateInfoResponse { /** * 参数模板的参数数量。 */ TotalCount?: number; /** * 参数模板 ID。 */ TemplateId?: string; /** * 参数模板名称。 */ Name?: string; /** * 产品类型。 - 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内存版（集群架构）。 */ ProductType?: number; /** * 参数模板描述。 */ Description?: string; /** * 参数详情。包含：参数的名称，当前运行值，默认值，最大值、最小值、枚举值等信息。 */ Items?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchProxy请求参数结构体 */ export interface SwitchProxyRequest { /** * 实例ID */ InstanceId: string; /** * 实例ProxyID */ ProxyID?: string; } /** * DescribeProductInfo请求参数结构体 */ export declare type DescribeProductInfoRequest = null; /** * SwitchInstanceVip返回参数结构体 */ export interface SwitchInstanceVipResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 已配置的备份文件下载地址对应的 VPC 信息。 */ export interface BackupLimitVpcItem { /** * 备份文件的下载地址对应VPC 所属的地域。 */ Region: string; /** * 备份文件下载地址的 VPC 列表。 */ VpcList: Array; } /** * DisassociateSecurityGroups请求参数结构体 */ export interface DisassociateSecurityGroupsRequest { /** * 数据库引擎名称，本接口取值：redis。 */ Product: string; /** * 安全组 ID。 */ SecurityGroupId: string; /** * 实例ID列表，一个或者多个实例 ID 组成的数组。 */ InstanceIds: Array; } /** * StartupInstance请求参数结构体 */ export interface StartupInstanceRequest { /** * 实例id */ InstanceId: string; } /** * 热Key详细信息 */ export interface HotKeyInfo { /** * 热 Key 的名称。 */ Key?: string; /** * Key 类型。 */ Type?: string; /** * 某段时间内热 Key 的访问次数 */ Count?: number; } /** * 实例枚举类型参数描述 */ export interface InstanceEnumParam { /** * 参数名称。 */ ParamName: string; /** * 参数类型，例如：Enum。 */ ValueType: string; /** * 参数值修改后是否需要重启。 - true：需要。 - false：不需要。 */ NeedRestart: string; /** * 参数默认值。 */ DefaultValue: string; /** * 参数当前运行值。 */ CurrentValue: string; /** * 参数说明。 */ Tips: string; /** * 参数可取的值。 */ EnumValue: Array; /** * 参数修改状态。 - 1: 修改中。 - 2：修改完成。 */ Status: number; } /** * CreateInstanceAccount返回参数结构体 */ export interface CreateInstanceAccountResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceBackups请求参数结构体 */ export interface DescribeInstanceBackupsRequest { /** * 每页输出的备份列表大小。默认大小为20，最大值为 100。 */ Limit?: number; /** * 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 */ Offset?: number; /** * 待操作的实例ID，可通过 DescribeInstance 接口返回值中的 InstanceId 获取。 */ InstanceId?: string; /** * 开始时间，格式如：2017-02-08 16:46:34。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。 */ BeginTime?: string; /** * 结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。 */ EndTime?: string; /** * 备份任务的状态： 1：备份在流程中。 2：备份正常。 3：备份转RDB文件处理中。 4：已完成RDB转换。 -1：备份已过期。 -2：备份已删除。 */ Status?: Array; /** * 实例名称，支持根据实例名称模糊搜索。 */ InstanceName?: string; } /** * RemoveReplicationInstance返回参数结构体 */ export interface RemoveReplicationInstanceResponse { /** * 异步任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全组详情 */ export interface SecurityGroupDetail { /** * 项目ID。 */ ProjectId: number; /** * 创建安全组的时间。 */ CreateTime: string; /** * 安全组 ID。 */ SecurityGroupId: string; /** * 安全组名称。 */ SecurityGroupName: string; /** * 安全组标记。 */ SecurityGroupRemark: string; /** * 安全组入站规则，即控制访问数据库的来源。 */ InboundRule: Array; /** * 安全组出站规则。 */ OutboundRule: Array; } /** * InquiryPriceUpgradeInstance返回参数结构体 */ export interface InquiryPriceUpgradeInstanceResponse { /** * 价格，单位：分 注意：此字段可能返回 null，表示取不到有效值。 */ Price?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteInstanceAccount返回参数结构体 */ export interface DeleteInstanceAccountResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorSIP请求参数结构体 */ export interface DescribeInstanceMonitorSIPRequest { /** * 实例Id */ InstanceId: string; } /** * 实例分片列表信息 */ export interface InstanceClusterShard { /** * 分片节点名称。 */ ShardName: string; /** * 分片节点序号。 */ ShardId: string; /** * 分片节点的角色。 - 0：主节点。 - 1：副本节点。 */ Role: number; /** * Key数量。 */ Keys: number; /** * Slot信息。 */ Slots: string; /** * 已使用容量。 */ Storage: number; /** * 容量倾斜率。 */ StorageSlope: number; /** * 实例运行时节点 ID。 */ Runid: string; /** * 服务状态。 - 0：down。 - 1：on。 */ Connected: number; } /** * OpenSSL返回参数结构体 */ export interface OpenSSLResponse { /** * 任务ID。 */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Tendis慢查询详情 */ export interface TendisSlowLogDetail { /** * 执行时间 */ ExecuteTime: string; /** * 慢查询耗时（毫秒） */ Duration: number; /** * 命令 */ Command: string; /** * 详细命令行信息 */ CommandLine: string; /** * 节点ID */ Node: string; } /** * ChangeInstanceRole返回参数结构体 */ export interface ChangeInstanceRoleResponse { /** * 异步流程ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeProxyVersion请求参数结构体 */ export interface UpgradeProxyVersionRequest { /** * 实例ID */ InstanceId: string; /** * 当前proxy版本 */ CurrentProxyVersion: string; /** * 可升级的redis版本 */ UpgradeProxyVersion: string; /** * 1-立即升级 0-维护时间窗口升级 */ InstanceTypeUpgradeNow: number; } /** * 可用区内产品信息 */ export interface ZoneCapacityConf { /** * 可用区ID：如ap-guangzhou-3 */ ZoneId: string; /** * 可用区名称 */ ZoneName: string; /** * 可用区是否售罄 */ IsSaleout: boolean; /** * 是否为默认可用区 */ IsDefault: boolean; /** * 网络类型：basenet -- 基础网络；vpcnet -- VPC网络 */ NetWorkType: Array; /** * 可用区内产品规格等信息 */ ProductSet: Array; /** * 可用区ID：如100003 */ OldZoneId: number; } /** * UpgradeInstance请求参数结构体 */ export interface UpgradeInstanceRequest { /** * 待变更实例 ID。 */ InstanceId: string; /** * 指实例每个分片内存变更后的大小。
    • 单位 MB。
    • 每次只能修改参数MemSize、RedisShardNum和RedisReplicasNum其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。
    • 缩容时，缩容后的规格务必要大于等于使用容量的1.3倍，否则将执行失败。
    */ MemSize: number; /** * 指实例变更后的分片数量。
    • 标准架构不需要配置该参数，集群架构为必填参数。
    • 集群架构，每次只能修改参数RedisShardNum、MemSize和RedisReplicasNum其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。
    */ RedisShardNum?: number; /** * 指实例变更后的副本数量。
    • 每次只能修改参数RedisReplicasNum、MemSize和RedisShardNum其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。
    • 多AZ实例修改副本时必须要传入NodeSet。
    */ RedisReplicasNum?: number; /** * 多AZ实例，增加副本时的附带信息，包括副本的可用区和副本的类型（NodeType为1）。非多AZ实例不需要配置该参数。 */ NodeSet?: Array; } /** * DescribeInstanceNodeInfo返回参数结构体 */ export interface DescribeInstanceNodeInfoResponse { /** * Proxy节点数量。 */ ProxyCount?: number; /** * Proxy节点信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Proxy?: Array; /** * Redis节点数量。 */ RedisCount?: number; /** * Redis节点信息。 注意：此字段可能返回 null，表示取不到有效值。 */ Redis?: Array; /** * 该参数不再使用，请忽略。 */ TendisCount?: number; /** * 该参数不再使用，请忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ Tendis?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProjectSecurityGroup返回参数结构体 */ export interface DescribeProjectSecurityGroupResponse { /** * 项目安全组 */ SecurityGroupDetails: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 复制组实例 */ export interface Instances { /** * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。 */ AppId?: number; /** * 实例 ID。 */ InstanceId?: string; /** * 实例名称。 */ InstanceName?: string; /** * 地域ID。
    • 1：广州。
    • 4：上海。
    • 5：香港。
    • 6：多伦多。
    • 7：上海金融。
    • 8：北京。
    • 9：新加坡。
    • 11：深圳金融。
    • 15：美西（硅谷）。
    */ RegionId?: number; /** * 区域 ID。 */ ZoneId?: number; /** * 副本数量。 */ RedisReplicasNum?: number; /** * 分片数量。 */ RedisShardNum?: number; /** * 分片内存大小。 */ RedisShardSize?: number; /** * 实例的磁盘大小。 注意：此字段可能返回 null，表示取不到有效值。 */ DiskSize?: number; /** * 引擎：社区版Redis、腾讯云CKV。 */ Engine?: string; /** * 实例读写权限。
    • rw：可读写。
    • r：只读。
    */ Role?: string; /** * 实例 VIP 地址。 */ Vip?: string; /** * 内部参数，用户可忽略。 注意：此字段可能返回 null，表示取不到有效值。 */ Vip6?: string; /** * VPC 网络ID，如：75101。 */ VpcID?: number; /** * 实例端口。 */ VPort?: number; /** * 实例状态。
    • 0：待初始化。
    • 1：流程中。
    • 2：运行中。
    • -2：已隔离。
    • -3：待删除。
    */ Status?: number; /** * 仓库ID。 */ GrocerySysId?: number; /** * 实例类型。 - 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内存版（集群架构）。 */ ProductType?: number; /** * 实例加入复制组的时间。 */ CreateTime?: string; /** * 复制组中实例更新的时间。 */ UpdateTime?: string; } /** * DescribeInstanceMonitorHotKey返回参数结构体 */ export interface DescribeInstanceMonitorHotKeyResponse { /** * 热Key详细信息 */ Data?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例参数 */ export interface InstanceParam { /** * 设置参数的名称。例如timeout。当前支持自定义的参数，请参见参数配置。 */ Key: string; /** * 设置参数名称对应的运行值。例如timeout对应运行值可设置为120， 单位为秒（s）。指当客户端连接闲置时间达到120 s时，将关闭连接。更多参数取值信息，请参见参数配置。 */ Value: string; } /** * DisassociateSecurityGroups返回参数结构体 */ export interface DisassociateSecurityGroupsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ClearInstance返回参数结构体 */ export interface ClearInstanceResponse { /** * 任务ID */ TaskId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 慢查询详情 */ export interface InstanceSlowlogDetail { /** * 慢查询耗时 */ Duration: number; /** * 客户端地址 */ Client: string; /** * 命令 */ Command: string; /** * 详细命令行信息 */ CommandLine: string; /** * 执行时间 */ ExecuteTime: string; /** * 节点ID */ Node: string; }