/** * UpgradeProxyVersion请求参数结构体 */ export interface UpgradeProxyVersionRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 */ InstanceId: string; /** * 当前 Proxy 版本。请通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口获取实例当前 Proxy 版本。 */ CurrentProxyVersion: string; /** * 可升级的 Redis 版本。请通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口获取实例可升级的 Redis 版本。 */ UpgradeProxyVersion: string; /** * 指定是否立即升级。 - 1:立即升级。 - 0:维护时间窗口升级。 */ InstanceTypeUpgradeNow: number; } /** * ModifyInstanceChargeType请求参数结构体 */ export interface ModifyInstanceChargeTypeRequest { /** *
实例ID数组
入参限制:批量操作数组长度不超过20
*/ InstanceIds: Array修改计费模式的操作类型
枚举值:
购买时长,仅当InstanceChargeType=PREPAID时需要传
取值范围:[1, 36]
单位:月
*/ Period?: number; } /** * DescribeInstanceMonitorSIP返回参数结构体 */ export interface DescribeInstanceMonitorSIPResponse { /** * 访问来源信息 */ Data?: Array指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *日志检索的起始时间。
参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 00:00:00。返回结果中仅包含该时间点及之后的日志。
*/ StartTime: string; /** *日志检索的结束时间。
参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 23:59:59。返回结果中仅包含该时间点及之前的日志。
*/ EndTime: string; /** *日志类型。
枚举值:
过滤条件
*/ LogFilter?: Array每页返回的日志列表大小。
分页的起始偏移量。
日志排序方式,默认值为 DESC。取值如下:
排序字段,指定按哪个字段对日志进行排序。
*/ OrderBy?: string; } /** * ModifyInstanceParams返回参数结构体 */ export interface ModifyInstanceParamsResponse { /** * 说明修改参数配置是否成功。实例类型。
内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 DescribeProductInfo 接口查询全地域的售卖规格。
实例数量,单次购买实例数量。具体信息,请通过 DescribeProductInfo 接口查询全地域的售卖规格。
*/ GoodsNum: number; /** *购买实例的时长。
计费方式。
实例所属的可用区ID,可参考地域和可用区 。
*/ ZoneId?: number; /** *访问实例的密码。
私有网络ID。如果不配置该参数则默认选择基础网络。请登录 私有网络控制台查询具体的ID。
*/ VpcId?: string; /** *私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 私有网络控制台查询子网列表获取具体的 ID。
*/ SubnetId?: string; /** *项目 ID。请登录Redis控制台,在右上角的账户信息菜单中,选择项目管理查询项目 ID。
*/ ProjectId?: number; /** *自动续费标识。
安全组 ID 数组。
用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
*/ VPort?: number; /** *实例分片数量。
实例副本数量。
标识实例是否需支持副本只读。
实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
*/ InstanceName?: string; /** *配置实例是否支持免密码访问。
实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见RedisNodeInfo 。
目前支持传入节点的类型(主节点或者副本节点),节点的可用区。未指定该参数时,在支持多可用区部署的地域,系统将默认创建多可用区架构实例。
给实例设定标签。
*/ ResourceTags?: Array指定实例所属的可用区名称。具体信息,请参见地域和可用区 。
*/ ZoneName?: string; /** *指定实例相关的参数模板 ID。
内部参数,标识创建实例是否需要检查。
指实例部署模式。
独享集群 ID。
告警策略 ID 数组。
是否加密密码
*/ EncryptPassword?: boolean; } /** * CreateReplicationGroup请求参数结构体 */ export interface CreateReplicationGroupRequest { /** * 指定复制组中的主实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 配置复制组名称。仅支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。 */ GroupName?: string; /** * 备注信息。 */ Remark?: string; } /** * 导出文件 */ export interface ExportFile { /** *文件名。
注意:此字段可能返回 null,表示取不到有效值。 */ FileName?: string; /** *状态值。
枚举值:
文件大小,单位:byte。
注意:此字段可能返回 null,表示取不到有效值。 */ FileSize?: number; /** *文件创建时间。
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *文件下载地址。
注意:此字段可能返回 null,表示取不到有效值。 */ DownloadUrl?: string; /** *导出文件的错误信息。
注意:此字段可能返回 null,表示取不到有效值。 */ ErrMsg?: string; /** *导出文件的进度。
注意:此字段可能返回 null,表示取不到有效值。 */ Progress?: number; /** *导出文件的完成时间。
注意:此字段可能返回 null,表示取不到有效值。 */ FinishTime?: string; /** *异步请求 ID。
注意:此字段可能返回 null,表示取不到有效值。 */ AsyncRequestId?: number; } /** * DescribeInstanceSpecBandwidth返回参数结构体 */ export interface DescribeInstanceSpecBandwidthResponse { /** *基础带宽。
*/ Bandwidth?: number; /** *链接限制。
*/ ClientLimit?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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。 */ RequestId?: string; } /** * ModifyNetworkConfig返回参数结构体 */ export interface ModifyNetworkConfigResponse { /** * 执行状态,请忽略该参数。 */ Status?: boolean; /** * 指实例新私有网络所属子网 ID。 */ SubnetId?: string; /** * 指实例新的私有网络ID。 */ VpcId?: string; /** * 指实例新的内网 IPv4 地址。 */ Vip?: string; /** * 任务 ID。获取**taskId**,通过接口 [DescribeTaskInfo](https://cloud.tencent.com/document/product/239/30601) 查询任务执行状态。 */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 命令耗时 */ export interface CommandTake { /** * 命令名。 */ Cmd?: string; /** * 耗时时长。单位:ms。 */ Took?: number; } /** * DescribeInstanceMonitorBigKey返回参数结构体 */ export interface DescribeInstanceMonitorBigKeyResponse { /** * 大Key详细信息 */ Data?: Array指定删除的日志类型。
枚举值:
指定删除日志的文件名。
*/ FileName: string; /** *指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 实例总数量。 */ TotalCount?: number; /** * 实例详细信息列表。 */ InstanceSet?: Array实例 ID。
*/ InstanceId?: string; /** *账号名称。
*/ AccountName?: string; /** *账号描述信息。
*/ Remark?: string; /** *读写权限策略。- r:只读。- w:只写。- rw:读写。
*/ Privilege?: string; /** *只读路由策略。- master:主节点。- replication:从节点。
*/ ReadonlyPolicy?: Array子账号状态.- 1:账号变更中。- 2:账号有效。- 4:账号已删除。
*/ Status?: number; /** *账号创建时间。
若该参数为空字符串,说明该账号创建于早期版本,未支持创建时间记录功能。
*/ CreateTime?: string; /** *账号最后修改密码的时间。
若该参数为空字符串,说明该账号创建于早期版本,未支持密码修改时间记录功能。
*/ PasswordLastModifiedTime?: string; } /** * 代理慢查询详情 */ export interface InstanceProxySlowlogDetail { /** *慢查询耗时时长。单位:毫秒。
*/ Duration?: number; /** *客户端地址。
*/ Client?: string; /** *慢查询的命令。
*/ Command?: string; /** *慢查询详细命令行信息。
*/ CommandLine?: string; /** *执行时间。
*/ ExecuteTime?: string; /** *收客户端请求时长(ms)
*/ RecvClientEnd?: number; /** *发送客户端请求时长(ms)
*/ SendClientEnd?: number; /** *Proxy节点ID。
*/ Node?: string; } /** * 安全组出入规则 */ export interface SecurityGroupsInboundAndOutbound { /** * 标识出入数据库的IP与端口是否被允许。 - ACCEPT:允许。 - DROP:不允许。 */ Action?: string; /** * 出入数据库的IP地址 */ Ip?: string; /** * 端口号。 */ Port?: string; /** * 协议类型。 */ Proto?: string; } /** * ModifyLog请求参数结构体 */ export interface ModifyLogRequest { /** *指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *日志类型。
枚举值:
日志子类型。
枚举值:
日志过期时间,单位:天。
枚举值:
高频日志过期时间,单位:天。
枚举值:
默认值: 7
*/ HighLogExpireDay: number; /** *降级策略,单位:毫秒,实例P99达到降级策略后,审计数据自动丢弃,优先保障业务的可用性,默认值:500毫秒。
取值范围:[300, 1000]
*/ DegradeStrategy: number; } /** * ClearInstance请求参数结构体 */ export interface ClearInstanceRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 实例访问密码。 - 免密访问:无需配置。 - 密码认证:必须配置。字符个数为[8,64],至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。 */ Password?: string; /** * 是否加密密码 */ EncryptPassword?: boolean; } /** * 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标准带宽。指购买实例时,系统为每个节点分配的带宽。
单位: MB/s。 */ BaseBandwidth?: number; /** *指实例的附加带宽。标准带宽不满足需求的情况下,用户可自行增加的带宽。
附加带宽设置下限。
单位: MB/s。 */ MinAddBandwidth?: number; /** *附加带宽设置上限。
单位: MB/s。 */ MaxAddBandwidth?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeParamTemplates请求参数结构体 */ export interface DescribeParamTemplatesRequest { /** *指定查询的产品版本与架构。
指定查询的参数模板名称。
指定查询的参数模板 ID。
指定查询结果的分页大小,即每页返回的记录数量。
分页偏移量,用于指定查询结果的起始位置。
任务ID
*/ FlowId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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实例 ID,请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; } /** * DescribeInstanceParamRecords返回参数结构体 */ export interface DescribeInstanceParamRecordsResponse { /** * 总的修改历史记录数。 */ TotalCount?: number; /** * 修改历史记录信息。 */ InstanceParamHistory?: Array查询到的日志的数量。
*/ TotalCount?: number; /** *日志平台实例信息。
*/ Items?: Array折扣后价格
*/ Price?: number; /** *高精度折扣后价格
*/ HighPrecisionPrice?: number; /** *原价
*/ OriginalPrice?: number; /** *高精度原价
*/ HighPrecisionOriginalPrice?: number; /** *币种
*/ Currency?: string; /** *价格金额单位
实例ID
*/ InstanceId: string; /** *日志类型
*/ LogType: string; } /** * DescribeProductInfo请求参数结构体 */ export type DescribeProductInfoRequest = null; /** * InquiryPriceCreateInstance返回参数结构体 */ export interface InquiryPriceCreateInstanceResponse { /** *折扣后价格
*/ Price?: number; /** *高精度折扣后价格
*/ HighPrecisionPrice?: number; /** *原价
*/ OriginalPrice?: number; /** *高精度原价
*/ HighPrecisionOriginalPrice?: number; /** *币种
*/ Currency?: string; /** *价格金额单位
实例ID,请登录 Redis 控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *升级多可用区之后是否支持就近访问功能。- true:支持就近访问功能。升级过程,需同时升级 Proxy 版本和 Redis 内核小版本,涉及数据搬迁,可能会长达数小时。- false:无需支持就近访问功能。升级多可用区仅涉及管理元数据迁移,对服务没有影响,升级过程通常在3分钟内完成。默认为 false。
*/ UpgradeProxyAndRedisServer?: boolean; } /** * ModfiyInstancePassword返回参数结构体 */ export interface ModfiyInstancePasswordResponse { /** * 任务 ID。 */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AllocateWanAddress返回参数结构体 */ export interface AllocateWanAddressResponse { /** * 异步流程ID */ FlowId?: number; /** * 开通外网的状态 */ WanStatus?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorTookDist请求参数结构体 */ export interface DescribeInstanceMonitorTookDistRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 */ InstanceId: string; /** * 查询时间日期。 */ Date: string; /** * 时间范围。 - 1:实时。 - 2:近30分钟。 - 3:近6小时。 - 4:近24小时。 */ SpanType: number; } /** * DeleteReplicationInstance请求参数结构体 */ export interface DeleteReplicationInstanceRequest { /** * 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。 */ GroupId: string; /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 数据同步类型。 - true:需要数据强同步。 - false:不需要强同步,仅限删除主实例。 */ SyncType: boolean; } /** * SwitchAccessNewInstance请求参数结构体 */ export interface SwitchAccessNewInstanceRequest { /** * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 示例值:crs-asdasdas */ InstanceId: string; } /** * RemoveReplicationGroup返回参数结构体 */ export interface RemoveReplicationGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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。请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603) 的返回参数 **Redis** 中的 **ClusterId** 获取。 */ ShardIds?: Array指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *分页大小。默认值为20,最小值为1,最大值为100。
*/ Limit: number; /** *分页偏移量。
交易的ID。
* @deprecated */ DealId?: string; /** *实例ID。
*/ InstanceIds?: Array订单号。
*/ DealName?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskInfo请求参数结构体 */ export interface DescribeTaskInfoRequest { /** * 任务 ID, 请通过接口[DescribeTaskList](https://cloud.tencent.com/document/product/239/39374) 的返回参数 **Tasks** 的子参数 **TaskId** 获取。 */ 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; /** * 付费方式。过滤条件名称。
枚举值:
过滤条件匹配类型。
枚举值:
过滤条件匹配值。当Compare=RA时,例如:["1-100","200-300"]。
*/ Value?: Array指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *日志类型。
枚举值:
日志检索的起始时间。
参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 00:00:00。返回结果中仅包含该时间点及之后的日志。
*/ StartTime: string; /** *日志检索的结束时间。
参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 23:59:59。返回结果中仅包含该时间点及之前的日志。
*/ EndTime: string; /** *设置日志筛选字段,过滤并下载符合条件的日志。
*/ LogFilter?: Array自定义下载的日志字段,多个字段以逗号分隔,例如 "timestamp,operation,user"。指定后仅下载所选字段的数据。不传该参数时,默认下载所有字段。
*/ ColumnFilter?: Array实例ID
*/ InstanceId?: string; /** *日志状态,create:创建中;normal:开启;close:关闭中。
*/ Status?: string; /** *是否可以切换日志查询-取值:yes-可以,no-不可以。该参数主要为控制存量日志迁移到日志平台做查询使用,只有为yes状态才可以调用查询日志接口。
*/ EnableQuery?: string; /** *开启时间
*/ CreateAt?: string; /** *高频存储天数
*/ HighLogExpireDay?: number; /** *低频存储天数
*/ LowLogExpireDay?: number; /** *总存储时长
*/ LogExpireDay?: number; /** *高频存储量,单位:MB
*/ HighStorage?: number; /** *低频存储量,单位:MB
*/ LowStorage?: number; /** *总存储量
*/ LogStorage?: number; /** *是否开启投递:ON,OFF
*/ Deliver?: string; /** *日志投递信息
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverSummary?: Array业务侧实例相关信息,根据业务不同,返回相关信息不同。
*/ InstanceInfo?: InstanceInfo; /** *审计子类型
*/ LogSubType?: string; } /** * ModifyDBInstanceSecurityGroups请求参数结构体 */ export interface ModifyDBInstanceSecurityGroupsRequest { /** * 数据库引擎名称,本接口取值:redis。 */ Product: string; /** * 更换为新的安全组 ID 列表,即一个或者多个安全组 ID 组成的数组。 - 若实例第一次配置安全组,请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。 - 更换安全组,请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。 **注意:**该入参会全量替换存量已有集合,非增量更新。修改需传入预期的全量集合。 */ SecurityGroupIds: Array该用户的参数模板数量。
*/ TotalCount?: number; /** *参数模板详情。
*/ Items?: Array实例 ID,请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *分片大小,单位:MB。
*/ MemSize: number; /** *分片数量。- 实例为标准架构,RedisShardNum 默认为1。- Redis 2.8主从版、CKV主从版和 Redis 2.8单机版不需要填写。
*/ RedisShardNum?: number; /** *副本数量,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写。
*/ RedisReplicasNum?: number; } /** * ModifyParamTemplate返回参数结构体 */ export interface ModifyParamTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProjectSecurityGroups请求参数结构体 */ export interface DescribeProjectSecurityGroupsRequest { /** * 数据库引擎名称,本接口取值:redis。 */ Product: string; /** * 项目 ID,请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID。 */ ProjectId?: number; /** * 偏移量,取值为Limit的整数倍。 */ Offset?: number; /** * 拉取数量限制,默认 20。 */ Limit?: number; /** * 搜索条件,支持安全组 ID 或者安全组名称。 */ SearchKey?: string; } /** * DescribeInstanceMonitorBigKeySizeDist返回参数结构体 */ export interface DescribeInstanceMonitorBigKeySizeDistResponse { /** * 大Key大小分布详情 */ Data?: Array数据库ID
*/ DBId?: number; /** *命令延迟(毫秒)
*/ CommandLatency?: number; /** *创建时间(格式:2006-01-02 15:04:05.000)
*/ Timestamp?: string; /** *客户端地址
*/ ClientAddr?: string; /** *用户名
*/ UserName?: string; /** *命令类型
*/ CommandType?: string; /** *缓存代码,后端redis节点
*/ CacheCode?: string; /** *命令详情
*/ CommandDetail?: string; /** *错误信息
*/ ErrMsg?: string; } /** * CreateInstanceAccount请求参数结构体 */ export interface CreateInstanceAccountRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 自定义的访问数据库的账号名称。 - 仅由字母、数字、下划线、中划线组成。 - 长度不能大于32位。 */ AccountName: string; /** * 设置自定义账号的密码。密码复杂度要求如下: - 字符个数为[8,64]。 - 至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的两种。 - 不能以"/"开头。 */ AccountPassword: string; /** * 指定账号的读请求路由分发至主节点或副本节点。未开启副本只读,不支持选择副本节点。 - master:主节点 - replication:副本节点 */ ReadonlyPolicy: Array查询日志记录的总数目。
*/ TotalCount?: number; /** *日志文件属性信息,包含:文件名、文件大小、下载地址等。
*/ Items?: Array过滤字段。
枚举值:
过滤字段的值。
*/ Values: Array精确匹配开关。
实例名称
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceName?: string; /** *项目ID
注意:此字段可能返回 null,表示取不到有效值。 */ ProjectId?: number; /** *实例状态
注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; /** *流程中的实例返回的子状态。
枚举值:
地域
注意:此字段可能返回 null,表示取不到有效值。 */ Region?: string; /** *区
注意:此字段可能返回 null,表示取不到有效值。 */ Zone?: string; /** *降级策略,单位:毫秒,实例P99达到降级策略后,审计数据自动丢弃,优先保障业务的可用性,默认值:500毫秒,范围值:300-1000毫秒
注意:此字段可能返回 null,表示取不到有效值。 */ DegradeStrategy?: number; /** *标签信息
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceTags?: Array架构版本
注意:此字段可能返回 null,表示取不到有效值。 */ Type?: number; } /** * ReleaseWanAddress返回参数结构体 */ export interface ReleaseWanAddressResponse { /** * 异步流程ID */ FlowId?: number; /** * 关闭外网的状态 */ WanStatus?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAutoBackupConfig请求参数结构体 */ export interface DescribeAutoBackupConfigRequest { /** * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; } /** * DescribeBackupUrl请求参数结构体 */ export interface DescribeBackupUrlRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 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失败实例ID
*/ InstanceId?: string; /** *失败信息
*/ Message?: string; } /** * ReleaseWanAddress请求参数结构体 */ export interface ReleaseWanAddressRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 */ InstanceId: string; } /** * InquiryPriceRenewInstance请求参数结构体 */ export interface InquiryPriceRenewInstanceRequest { /** *包年包月实例的购买时长。- 单位:月。- 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
*/ Period: number; /** *指定实例 ID。例如:crs-xjhsdj****。请登录 Redis 控制台在实例列表复制包年包月实例 ID。
*/ InstanceId: string; } /** * CloseSSL返回参数结构体 */ export interface CloseSSLResponse { /** * 任务ID。 */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMaintenanceWindow返回参数结构体 */ export interface ModifyMaintenanceWindowResponse { /** * 修改状态:success 或者 failed */ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateReplicationGroup返回参数结构体 */ export interface CreateReplicationGroupResponse { /** * 异步流程ID。 */ TaskId?: number; /** * 复制组string型id */ GroupId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorBigKeyTypeDist请求参数结构体 */ export interface DescribeInstanceMonitorBigKeyTypeDistRequest { /** * 实例Id */ InstanceId: string; /** * 时间;例如:"20190219" */ Date: string; } /** * DescribeInstanceMonitorTopNCmdTook请求参数结构体 */ export interface DescribeInstanceMonitorTopNCmdTookRequest { /** * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 */ InstanceId: string; /** * 查询时间范围。 - 1:实时。 - 2:近30分钟。 - 3:近6小时。 - 4:近24小时。 */ SpanType: number; } /** * DestroyPrepaidInstance返回参数结构体 */ export interface DestroyPrepaidInstanceResponse { /** * 订单Id * @deprecated */ DealId?: string; /** * 订单号。 */ DealName?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 投递信息 */ export interface DeliverSummary { /** *投递类型,store(存储类),mq(消息通道)
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverType?: string; /** *投递子类型:cls,ckafka。
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverSubType?: string; /** *投递订阅者
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverConsumer?: string; /** *投递订阅者名称
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverConsumerName?: string; /** *投递
注意:此字段可能返回 null,表示取不到有效值。 */ DeliverError?: string; } /** * 实例节点组信息 */ export interface ReplicaGroup { /** * 节点组 ID。 */ GroupId?: number; /** * 节点组的名称,主节点为空。 */ GroupName?: string; /** * 节点的可用区ID,比如ap-guangzhou-1 */ ZoneId?: string; /** * 节点组类型,master为主节点,replica为副本节点。 */ Role?: string; /** * 节点组节点列表 */ RedisNodes?: Array指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
*/ InstanceId: string; /** *日志类型。
枚举值:
日志子类型。
枚举值:
日志有效期, 单位:天。
枚举值:
默认值:7
*/ LogExpireDay: number; /** *高频日志有效期, 单位:天。
枚举值:
默认值:7
*/ HighLogExpireDay: number; /** *日志降级策略阈值。当实例 P99 延迟达到该阈值后,系统将自动丢弃审计日志数据,以优先保障业务可用性。
实例类型。- 2: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 内存版(集群架构)。- 17:Redis 7.0 内存版(标准架构)。- 18:Redis 7.0 内存版(集群架构)。- 200:Memcached 1.6 内存版(集群架构)。
*/ TypeId: number; /** *内存容量,单位为MB, 数值需为1024的整数倍,具体规格以 查询产品售卖规格 返回的规格为准。TypeId为标准架构时,MemSize是实例总内存容量;TypeId为集群架构时,MemSize是单分片内存容量。
*/ MemSize: number; /** *实例数量,单次购买实例数量以 查询产品售卖规格 返回的规格为准。
*/ GoodsNum: number; /** *购买时长,在创建包年包月实例的时候需要填写,按量计费实例填1即可,单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
*/ Period: number; /** *付费方式。- 0:按量计费。- 1:包年包月。
*/ BillingMode: number; /** *实例所属的可用区 ID,可参考地域和可用区 。说明:请在 ZoneId 与 ZoneName 中至少指定一个参数。
*/ ZoneId?: number; /** *实例分片数量。- 标准架构需要配置分片数量为1。- 集群架构分片数量支持设置为1、3、5、8、12、16、24、32、40、48、64、80、96、128。
*/ RedisShardNum?: number; /** *实例副本数量。取值范围为:1、2、3、4、5。
*/ RedisReplicasNum?: number; /** *是否支持副本只读。Redis2.8标准架构、CKV标准架构无需填写。- true:无需支持副本只读。- false:需支持。
*/ ReplicasReadonly?: boolean; /** *实例所属的可用区名称,可参考地域和可用区 。说明:请在 ZoneId 与 ZoneName 中至少指定一个参数。
*/ ZoneName?: string; /** *部署方式。- local:本地盘版,默认为 local。- cloud:云盘版。- cdc:独享集群版。
*/ ProductVersion?: string; } /** * DescribeRedisClusters请求参数结构体 */ export interface DescribeRedisClustersRequest { /** * Redis独享集群 ID。请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 )切换至**云服务管理**页面,在下拉框选择**云数据库 Redis**,可获取独享集群ID。 */ RedisClusterIds?: Array查询的日志总数量。
*/ TotalCount?: number; /** *日志详情。
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array日志类型。
枚举值:
每页输出的任务列表大小。
分页偏移量。
指定查询的实例 ID。请登录Redis 控制台在实例列表复制实例 ID。
*/ InstanceId: string; } /** * DescribeProxySlowLog请求参数结构体 */ export interface DescribeProxySlowLogRequest { /** * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 */ InstanceId: string; /** * 慢查询的开始时间,查询时间最大跨度30天。 */ BeginTime: string; /** * 慢查询的结束时间,查询时间最大跨度30天。 */ EndTime: string; /** * 慢查询阈值。取值为大于0 的正整数。单位:毫秒。 */ MinQueryTime?: number; /** * 每页输出的任务列表大小。默认值为20,最小值为1,最大值为100。 */ Limit?: number; /** * 分页偏移量。默认为0。取值为 Limit 整数倍。计算公式:offset=limit*(页码-1)。 */ Offset?: number; } /** * DescribeRedisClusters返回参数结构体 */ export interface DescribeRedisClustersResponse { /** * 集群总数 */ Total?: number; /** * CDC集群资源列表 */ Resources?: Array日志类型。
枚举值:
每页输出的任务列表大小。
分页偏移量。默认为0。取值为 Limit 整数倍。计算公式:offset=limit*(页码-1)。
*/ Offset?: number; /** *设置日志筛选字段,过滤并返回符合条件的日志。
*/ Filters?: Array日志子类型。
枚举值:
日志开关。
枚举值:
默认值:off
*/ LogSwitch?: string; } /** * ModifyInstanceBackupMode请求参数结构体 */ export interface ModifyInstanceBackupModeRequest { /** * 实例的ID。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 */ InstanceId: string; /** * 备份模式: - SecondLevelBackup 秒级备份。 - NormalLevelBackup 普通备份。 */ BackupMode?: string; } /** * 实例详细信息列表。 */ export interface InstanceSet { /** * 实例名称。 */ InstanceName?: string; /** * 实例 ID。 */ InstanceId?: string; /** * 用户AppId。AppId是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 AppId。 */ Appid?: number; /** * 项目 ID。 */ ProjectId?: number; /** * 地域 ID。账号详细信息。
*/ Accounts?: Array账号个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceMonitorBigKey请求参数结构体 */ export interface DescribeInstanceMonitorBigKeyRequest { /** * 实例Id */ InstanceId: string; /** * 请求类型:1——string类型,2——所有类型 */ ReqType: number; /** * 时间;例如:"20190219" */ Date: string; } /** * DescribeBackupDownloadRestriction请求参数结构体 */ export type DescribeBackupDownloadRestrictionRequest = null; /** * tendis节点信息 */ export interface TendisNodes { /** * 节点ID */ NodeId?: string; /** * 节点角色 */ NodeRole?: string; /** * 可用区 ID。 */ ZoneId?: number; } /** * 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 内存版(集群架构)。 - 17:Redis 7.0 内存版(标准架构)。 - 18:Redis 7.0 内存版(集群架构)。 */ ProductType?: number; /** * 参数模板描述。 */ Description?: string; /** * 参数详情。包含:参数的名称,当前运行值,默认值,最大值、最小值、枚举值等信息。 */ Items?: Array指定实例 ID。请登录 Redis控制台 在实例列表复制实例 ID。同时,InstanceId 与规格参数不能同时为空,至少提供一种。
分片大小。单位:MB。
*/ ShardSize?: number; /** *分片数量。
*/ ShardNum?: number; /** *复制组数量。
*/ ReplicateNum?: number; /** *只读权重。- 100:开启从只读。- 0:关闭从只读。
*/ ReadOnlyWeight?: number; /** *实例类型,同 CreateInstances 的Type。
*/ Type?: number; } /** * SwitchInstanceVip返回参数结构体 */ export interface SwitchInstanceVipResponse { /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 已配置的备份文件下载地址对应的 VPC 信息。 */ export interface BackupLimitVpcItem { /** * 备份文件的下载地址对应VPC 所属的地域。 */ Region: string; /** * 备份文件下载地址的 VPC 列表。 */ VpcList: Array修改失败的实例信息汇总
*/ FailedInstanceIds?: Array折扣后价格
*/ Price?: number; /** *高精度折扣后价格
*/ HighPrecisionPrice?: number; /** *原价
*/ OriginalPrice?: number; /** *高精度原价
*/ HighPrecisionOriginalPrice?: number; /** *币种
*/ Currency?: string; /** *价格金额单位