tencentcloud-sdk-nodejs
Version:
2,176 lines (2,169 loc) • 230 kB
TypeScript
/**
* 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 {
/**
* <p>实例ID数组</p><p>入参限制:批量操作数组长度不超过20</p>
*/
InstanceIds: Array<string>;
/**
* <p>修改计费模式的操作类型</p><p>枚举值:</p><ul><li>PREPAID: 按量计费转包年包月</li><li>POSTPAID: 包年包月转按量计费</li></ul>
*/
InstanceChargeType: string;
/**
* <p>购买时长,仅当InstanceChargeType=PREPAID时需要传</p><p>取值范围:[1, 36]</p><p>单位:月</p>
*/
Period?: number;
}
/**
* DescribeInstanceMonitorSIP返回参数结构体
*/
export interface DescribeInstanceMonitorSIPResponse {
/**
* 访问来源信息
*/
Data?: Array<SourceInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveReplicationGroup请求参数结构体
*/
export interface RemoveReplicationGroupRequest {
/**
* 复制组ID。请登录 [Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication) 页面获取复制组 ID。
*/
GroupId: string;
}
/**
* UpgradeSmallVersion请求参数结构体
*/
export interface UpgradeSmallVersionRequest {
/**
* 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceId: string;
/**
* 当前 Redis 小版本。小版本信息,请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。
*/
CurrentRedisVersion: string;
/**
* 升级后的 Redis 小版本。小版本信息,请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。
*/
UpgradeRedisVersion: string;
/**
* 指定是否立即升级。
- 1:立即升级。
- 0:维护时间窗口升级。
*/
InstanceTypeUpgradeNow: number;
}
/**
* DescribeLogs请求参数结构体
*/
export interface DescribeLogsRequest {
/**
* <p>指定实例 ID。例如:crs-xjhsdj****。请登录<a href="https://console.cloud.tencent.com/redis">Redis控制台</a>在实例列表复制实例 ID。</p>
*/
InstanceId: string;
/**
* <p>日志检索的起始时间。</p><p>参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 00:00:00。返回结果中仅包含该时间点及之后的日志。</p>
*/
StartTime: string;
/**
* <p>日志检索的结束时间。</p><p>参数格式:YYYY-MM-DD HH:mm:ss,例如 2026-03-06 23:59:59。返回结果中仅包含该时间点及之前的日志。</p>
*/
EndTime: string;
/**
* <p>日志类型。</p><p>枚举值:</p><ul><li>auditLog: 审计日志。</li></ul>
*/
LogType: string;
/**
* <p>过滤条件</p>
*/
LogFilter?: Array<LogFilter>;
/**
* <p>每页返回的日志列表大小。</p><ul><li>默认值:20。</li><li>取值范围:[1,100]。</li></ul>
*/
Limit?: number;
/**
* <p>分页的起始偏移量。</p><ul><li>默认:0。</li><li>取值:Limit 整数倍。计算公式:offset=limit*(页码-1)。</li></ul>
*/
Offset?: number;
/**
* <p>日志排序方式,默认值为 DESC。取值如下:</p><ul><li>ASC:按时间升序排列,最早的日志在前。</li><li>DESC:按时间降序排列,最新的日志在前。</li></ul>
*/
Order?: string;
/**
* <p>排序字段,指定按哪个字段对日志进行排序。</p>
*/
OrderBy?: string;
}
/**
* ModifyInstanceParams返回参数结构体
*/
export interface ModifyInstanceParamsResponse {
/**
* 说明修改参数配置是否成功。<br><li>true:指修改成功;</li><li>false:指修改失败。</li>
*/
Changed?: boolean;
/**
* 任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnableReplicaReadonly请求参数结构体
*/
export interface EnableReplicaReadonlyRequest {
/**
* 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceId: string;
/**
* 只读路由策略。
- master:表示只读路由至主节点。
- replication:表示只读路由至从节点。默认值为:replication。
*/
ReadonlyPolicy?: Array<string>;
}
/**
* 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<RedisNodeInfo>;
}
/**
* 实例的备份数组
*/
export interface RedisBackupSet {
/**
* <p>备份开始时间。</p>
*/
StartTime?: string;
/**
* <p>备份任务ID。</p>
*/
BackupId?: string;
/**
* <p>备份类型。</p><ul><li>1:凌晨系统发起的自动备份。</li><li>0:用户发起的手动备份。</li></ul>
*/
BackupType?: string;
/**
* <p>备份状态。 </p><ul><li>1:备份被其它流程锁定。</li><li>2:备份正常,没有被任何流程锁定。</li><li>-1:备份已过期。</li><li>3:备份正在被导出。</li><li>4:备份导出成功。</li></ul>
*/
Status?: number;
/**
* <p>备份的备注信息。</p>
*/
Remark?: string;
/**
* <p>备份是否被锁定。</p><ul><li>0:未被锁定。</li><li>1:已被锁定。</li></ul>
*/
Locked?: number;
/**
* <p>内部字段,用户可忽略。</p>
*/
BackupSize?: number;
/**
* <p>内部字段,用户可忽略。</p>
*/
FullBackup?: number;
/**
* <p>内部字段,用户可忽略。</p>
*/
InstanceType?: number;
/**
* <p>实例 ID。</p>
*/
InstanceId?: string;
/**
* <p>实例名称。</p>
*/
InstanceName?: string;
/**
* <p>本地备份所在地域。</p>
*/
Region?: string;
/**
* <p>备份结束时间。</p>
*/
EndTime?: string;
/**
* <p>备份文件类型。</p>
*/
FileType?: string;
/**
* <p>备份文件过期时间。</p>
*/
ExpireTime?: string;
/**
* <p>备份文件是否加密</p>
*/
Encrypted?: boolean;
}
/**
* DescribeInstanceMonitorTopNCmd返回参数结构体
*/
export interface DescribeInstanceMonitorTopNCmdResponse {
/**
* 访问命令信息
*/
Data?: Array<SourceCommand>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExportTask返回参数结构体
*/
export interface DeleteExportTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstanceAvailabilityZones返回参数结构体
*/
export interface ModifyInstanceAvailabilityZonesResponse {
/**
* 任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoBackupConfig返回参数结构体
*/
export interface ModifyAutoBackupConfigResponse {
/**
* 自动备份类型。目前仅能配置为:1 ,指定时备份。
*/
AutoBackupType?: number;
/**
* 自动备份周期。取值为:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday。
*/
WeekDays?: Array<string>;
/**
* 自动定时备份时间段。格式如:00:00-01:00, 01:00-02:00...... 23:00-00:00。
*/
TimePeriod?: string;
/**
* 全量备份文件保存天数,单位:天。
*/
BackupStorageDays?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestoreInstance请求参数结构体
*/
export interface RestoreInstanceRequest {
/**
* 待操作的实例ID,可通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口返回值中的 InstanceId 获取。
*/
InstanceId: string;
/**
* 备份ID,可通过 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 接口返回的参数 RedisBackupSet 获取。
*/
BackupId: string;
/**
* 实例密码,恢复实例时,需要校验实例密码(免密实例不需要传密码)
*/
Password?: string;
}
/**
* AllocateWanAddress请求参数结构体
*/
export interface AllocateWanAddressRequest {
/**
* 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
*/
InstanceId: string;
}
/**
* ApplyParamsTemplate请求参数结构体
*/
export interface ApplyParamsTemplateRequest {
/**
* 实例 ID 列表,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceIds: Array<string>;
/**
* 应用的参数模板ID。
- 请通过接口 [DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748) 的返回参数 **TemplateId** 获取参数模板 ID。
- 仅当参数模板版本与目标实例的架构版本一致时,操作才能成功执行。版本不匹配将触发执行错误。
*/
TemplateId: string;
}
/**
* DescribeReplicationGroupInstance请求参数结构体
*/
export interface DescribeReplicationGroupInstanceRequest {
/**
* 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
*/
InstanceId: string;
}
/**
* UpgradeInstanceVersion返回参数结构体
*/
export interface UpgradeInstanceVersionResponse {
/**
* 订单ID
* @deprecated
*/
DealId?: string;
/**
* 订单号。
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInstances请求参数结构体
*/
export interface CreateInstancesRequest {
/**
* <p>实例类型。</p><ul><li>2:Redis 2.8 内存版(标准架构)。</li><li>3:CKV 3.2 内存版(标准架构)。</li><li>4:CKV 3.2 内存版(集群架构)。</li><li>6:Redis 4.0 内存版(标准架构)。</li><li>7:Redis 4.0 内存版(集群架构)。</li><li>8:Redis 5.0 内存版(标准架构)。</li><li>9:Redis 5.0 内存版(集群架构)。</li><li>15:Redis 6.2 内存版(标准架构)。</li><li>16:Redis 6.2 内存版(集群架构)。</li><li>17:Redis 7.0 内存版(标准架构)。</li><li>18:Redis 7.0 内存版(集群架构)。</li><li>19:Valkey 8.0 内存版(标准架构)。</li><li>20:Valkey 8.0 内存版(集群架构)。</li><li>200:Memcached 1.6 内存版(集群架构)。<br><strong>说明</strong>:CKV 版本当前有存量用户使用,暂时保留。</li></ul>
*/
TypeId: number;
/**
* <p>内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 <a href="https://cloud.tencent.com/document/api/239/30600">DescribeProductInfo</a> 接口查询全地域的售卖规格。</p><ul><li><strong>TypeId</strong>为标准架构时,<strong>MemSize</strong>是实例总内存容量;</li><li><strong>TypeId</strong>为集群架构时,<strong>MemSize</strong>是单分片内存容量。</li></ul>
*/
MemSize: number;
/**
* <p>实例数量,单次购买实例数量。具体信息,请通过 <a href="https://cloud.tencent.com/document/api/239/30600">DescribeProductInfo</a> 接口查询全地域的售卖规格。</p>
*/
GoodsNum: number;
/**
* <p>购买实例的时长。</p><ul><li>若 <strong>BillingMode</strong>为<strong>1</strong>,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。</li><li>若 <strong>BillingMode</strong>为<strong>0</strong>,即计费方式为按量计费时,该参数配置为1。</li></ul>
*/
Period: number;
/**
* <p>计费方式。</p><ul><li>0:按量计费。</li><li>1:包年包月。</li></ul>
*/
BillingMode: number;
/**
* <p>实例所属的可用区ID,可参考<a href="https://cloud.tencent.com/document/product/239/4106">地域和可用区</a> 。</p>
*/
ZoneId?: number;
/**
* <p>访问实例的密码。</p><ul><li>当输入参数<strong>NoAuth</strong>为<strong>true</strong>时,指设置实例为免密码访问,Password可不用配置,否则Password为必填参数。</li><li>当实例类型<strong>TypeId</strong>为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.2、7.0内存版标准架构或集群架构时,其密码复杂度要求为:8-64个字符,至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。</li><li>当实例类型<strong>TypeId</strong>为CKV 3.2 内存版标准架构或集群架构时,其密码复杂度为:8-30个字符,必须包含字母和数字,且不包含其他字符。</li></ul>
*/
Password?: string;
/**
* <p>私有网络ID。如果不配置该参数则默认选择基础网络。请登录 <a href="https://console.cloud.tencent.com/vpc">私有网络</a>控制台查询具体的ID。</p>
*/
VpcId?: string;
/**
* <p>私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 <a href="https://console.cloud.tencent.com/vpc">私有网络</a>控制台查询子网列表获取具体的 ID。</p>
*/
SubnetId?: string;
/**
* <p>项目 ID。请登录<a href="https://console.cloud.tencent.com/redis#/">Redis控制台</a>,在右上角的账户信息菜单中,选择<strong>项目管理</strong>查询项目 ID。</p>
*/
ProjectId?: number;
/**
* <p>自动续费标识。</p><ul><li>0:默认状态(手动续费)。</li><li>1:自动续费。</li><li>2:到期不续费。</li></ul>
*/
AutoRenew?: number;
/**
* <p>安全组 ID 数组。</p><ul><li>安全组是一种虚拟防火墙,对云数据库实例的网络访问进行控制。创建实例时,建议绑定相应的安全组。</li><li>请通过 <a href="https://cloud.tencent.com/document/product/239/34447">DescribeInstanceSecurityGroup</a> 接口获取实例的安全组 ID。</li></ul>
*/
SecurityGroupIdList?: Array<string>;
/**
* <p>用户自定义的网络端口。默认为6379,范围为 [1024,65535]。</p>
*/
VPort?: number;
/**
* <p>实例分片数量。</p><ul><li>标准版实例无需配置该参数。</li><li>集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。</li></ul>
*/
RedisShardNum?: number;
/**
* <p>实例副本数量。</p><ul><li>Redis 内存版 4.0、5.0、6.2、7.0 标准架构和集群架构支持副本数量范围为[1,5]。</li><li>Redis 2.8标准版、CKV标准版只支持1副本。</li></ul>
*/
RedisReplicasNum?: number;
/**
* <p>标识实例是否需支持副本只读。</p><ul><li>Redis 2.8 标准版、CKV标准版不支持副本只读。</li><li>开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。</li><li>如需开启副本只读,建议副本数量大于等于2。</li></ul>
*/
ReplicasReadonly?: boolean;
/**
* <p>实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。</p>
*/
InstanceName?: string;
/**
* <p>配置实例是否支持免密码访问。</p><ul><li>true:免密访问实例。</li><li>false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。</li></ul>
*/
NoAuth?: boolean;
/**
* <p>实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见<a href="https://cloud.tencent.com/document/product/239/20022">RedisNodeInfo </a>。<br>目前支持传入节点的类型(主节点或者副本节点),节点的可用区。未指定该参数时,在支持多可用区部署的地域,系统将默认创建多可用区架构实例。</p>
*/
NodeSet?: Array<RedisNodeInfo>;
/**
* <p>给实例设定标签。</p>
*/
ResourceTags?: Array<ResourceTag>;
/**
* <p>指定实例所属的可用区名称。具体信息,请参见<a href="https://cloud.tencent.com/document/product/239/4106">地域和可用区</a> 。</p>
*/
ZoneName?: string;
/**
* <p>指定实例相关的参数模板 ID。</p><ul><li>若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。</li><li>请通过<a href="https://cloud.tencent.com/document/product/239/58750">DescribeParamTemplates</a>接口,查询实例的参数模板列表,获取模板 ID 编号。</li></ul>
*/
TemplateId?: string;
/**
* <p>内部参数,标识创建实例是否需要检查。</p><ul><li>false :默认值。发送正常请求,通过检查后直接创建实例。</li><li>true:发送检查请求,不会创建实例。</li></ul>
*/
DryRun?: boolean;
/**
* <p>指实例部署模式。</p><ul><li>local:传统架构,默认为 local。</li><li>cdc:独享集群。</li><li>cloud:云原生,当前已暂停售卖。</li></ul>
*/
ProductVersion?: string;
/**
* <p>独享集群 ID。</p><ul><li>当 <strong>ProductVersion</strong> 设置为 <strong>cdc</strong> 时,该参数必须设置。</li><li>请通过接口<a href="https://cloud.tencent.com/document/product/239/109628"> DescribeRedisClusters</a> 获取集群 ID。</li></ul>
*/
RedisClusterId?: string;
/**
* <p>告警策略 ID 数组。</p><ul><li>请登录<a href="https://console.cloud.tencent.com/monitor/alarm/policy">腾讯云可观测平台-告警管理-策略管理</a>获取告警策略 ID。</li><li>若不配置该参数,则绑定默认告警策略。默认告警策略具体信息,请登录<a href="https://console.cloud.tencent.com/monitor/alarm/policy">腾讯云可观测平台-告警管理-策略管理</a>查看。</li></ul>
*/
AlarmPolicyList?: Array<string>;
/**
* <p>是否启用密码加密传输。</p><ul><li>true:加密。</li><li>false:不加密(默认值)。</li></ul>
*/
EncryptPassword?: boolean;
}
/**
* CreateReplicationGroup请求参数结构体
*/
export interface CreateReplicationGroupRequest {
/**
* 指定复制组中的主实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
*/
InstanceId: string;
/**
* 配置复制组名称。仅支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。
*/
GroupName?: string;
/**
* 备注信息。
*/
Remark?: string;
}
/**
* RemoveReplicationInstance返回参数结构体
*/
export interface RemoveReplicationInstanceResponse {
/**
* 异步任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 导出文件
*/
export interface ExportFile {
/**
* <p>文件名。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
FileName?: string;
/**
* <p>状态值。</p><p>枚举值:</p><ul><li>creating: 文件创建中。</li><li>success: 文件已生成。</li><li>failed: 文件生成失败。</li><li>deleted: 文件已删除。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* <p>文件大小,单位:byte。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
FileSize?: number;
/**
* <p>文件创建时间。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* <p>文件下载地址。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DownloadUrl?: string;
/**
* <p>导出文件的错误信息。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrMsg?: string;
/**
* <p>导出文件的进度。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Progress?: number;
/**
* <p>导出文件的完成时间。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
FinishTime?: string;
/**
* <p>异步请求 ID。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AsyncRequestId?: number;
}
/**
* DescribeInstanceSpecBandwidth返回参数结构体
*/
export interface DescribeInstanceSpecBandwidthResponse {
/**
* <p>基础带宽。</p>
*/
Bandwidth?: number;
/**
* <p>链接限制。</p>
*/
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<BigKeyInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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,请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。
*/
SecurityGroupId: string;
/**
* 被绑定的实例ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID,支持指定多个实例。
*/
InstanceIds: Array<string>;
}
/**
* DescribeTaskList返回参数结构体
*/
export interface DescribeTaskListResponse {
/**
* 任务总数。
*/
TotalCount?: number;
/**
* 任务详细信息。
*/
Tasks?: Array<TaskInfoDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstancePassword返回参数结构体
*/
export interface ModifyInstancePasswordResponse {
/**
* 任务 ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSecondLevelBackupInfo返回参数结构体
*/
export interface DescribeSecondLevelBackupInfoResponse {
/**
* 备份记录ID。
*/
BackupId?: string;
/**
* 备份时间戳。
*/
BackupTimestamp?: number;
/**
* 备份不存在的时间戳范围。
注意:此字段可能返回 null,表示取不到有效值。
*/
MissingTimestamps?: Array<SecondLevelBackupMissingTimestamps>;
/**
* 实例开启秒级备份的时间戳。
*/
StartTimestamp?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewInstance返回参数结构体
*/
export interface RenewInstanceResponse {
/**
* 交易ID。
* @deprecated
*/
DealId?: string;
/**
* 订单号。
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSlowLog返回参数结构体
*/
export interface DescribeSlowLogResponse {
/**
* 慢查询总数。
*/
TotalCount?: number;
/**
* 已废弃,该参数存在命名不规范问题,后续用参数InstanceSlowLogDetail取代。慢查询详情。
* @deprecated
*/
InstanceSlowlogDetail?: Array<InstanceSlowlogDetail>;
/**
* 慢查询详情,注意:TotalCount大于1W,即慢日志超过1万条,不支持返回日志详情,返回数据为空。 建议缩小BeginTime和EndTime的时间间隔,多次查询。
*/
InstanceSlowLogDetail?: Array<InstanceSlowlogDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCommonDBInstances请求参数结构体
*/
export interface DescribeCommonDBInstancesRequest {
/**
* vpc网络ID信息列表
*/
VpcIds?: Array<number | bigint>;
/**
* 子网ID信息列表
*/
SubnetIds?: Array<number | bigint>;
/**
* 计费类型过滤列表;0表示包年包月,1表示按量计费
*/
PayMode?: number;
/**
* 实例ID过滤信息列表,数组最大长度限制为100
*/
InstanceIds?: Array<string>;
/**
* 实例名称过滤信息列表
*/
InstanceNames?: Array<string>;
/**
* 实例状态信息过滤列表
*/
Status?: Array<string>;
/**
* 排序字段
*/
OrderBy?: string;
/**
* 排序方式
*/
OrderByType?: string;
/**
* 实例vip信息列表
*/
Vips?: Array<string>;
/**
* vpc网络ID信息列表
*/
UniqVpcIds?: Array<string>;
/**
* 子网统一ID列表
*/
UniqSubnetIds?: Array<string>;
/**
* 数量限制,默认推荐100
*/
Limit?: number;
/**
* 偏移量,默认0
*/
Offset?: number;
}
/**
* DescribeDBSecurityGroups返回参数结构体
*/
export interface DescribeDBSecurityGroupsResponse {
/**
* 安全组规则。
*/
Groups?: Array<SecurityGroup>;
/**
* 实例内网IPv4地址。
*/
VIP?: string;
/**
* 内网端口。
*/
VPort?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestoreInstance返回参数结构体
*/
export interface RestoreInstanceResponse {
/**
* 任务ID,可通过 DescribeTaskInfo 接口查询任务执行状态
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述 Redis 实例的主节点或者副本节点信息。
*/
export interface RedisNodeInfo {
/**
* 节点类型。<ul><li>0:为主节点。</li><li>1:为副本节点。</li></ul>
*/
NodeType: number;
/**
* 主节点或者副本节点的 ID。<ul><li>该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置,而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。</li><li>该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。</li></ul>
*/
NodeId?: number;
/**
* 主节点或者副本节点的可用区 ID。
*/
ZoneId?: number;
/**
* 主节点或者副本节点的可用区名称。
*/
ZoneName?: string;
}
/**
* ModifyBackupDownloadRestriction返回参数结构体
*/
export interface ModifyBackupDownloadRestrictionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteParamTemplate请求参数结构体
*/
export interface DeleteParamTemplateRequest {
/**
* 参数模板 ID。请登录 [Redis 控制台的参数模板](https://console.cloud.tencent.com/redis/templates)页面获取模板 ID。
*/
TemplateId: string;
}
/**
* DeleteExportTask请求参数结构体
*/
export interface DeleteExportTaskRequest {
/**
* <p>指定删除的日志类型。</p><p>枚举值:</p><ul><li>auditLog: 审计日志。</li></ul>
*/
LogType: string;
/**
* <p>指定删除日志的文件名。</p>
*/
FileName: string;
/**
* <p>指定实例 ID。例如:crs-xjhsdj****。请登录<a href="https://console.cloud.tencent.com/redis">Redis控制台</a>在实例列表复制实例 ID。</p>
*/
InstanceId: string;
}
/**
* DescribeInstances返回参数结构体
*/
export interface DescribeInstancesResponse {
/**
* 实例总数量。
*/
TotalCount?: number;
/**
* 实例详细信息列表。
*/
InstanceSet?: Array<InstanceSet>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务信息详情
*/
export interface TaskInfoDetail {
/**
* 任务 ID。
*/
TaskId?: number;
/**
* 任务开始时间。
*/
StartTime?: string;
/**
* 任务类型。
- FLOW_CREATE: "001",新建实例
- FLOW_RESIZE : "002",配置变更
- FLOW_CLOSE:"003",关闭实例
- FLOW_CLEAN: "004",清空实例
- FLOW_STARTUP:"005",实例启用。
- FLOW_DELETE:"006",删除实例。
- FLOW_SETPWD:"007",重置密码。
- FLOW_EXPORTBACKUP:"009",导出备份文件。
- FLOW_RESTOREBACKUP:"010",恢复备份。
- FLOW_BACKUPINSTANCE:"012",备份实例。
- FLOW_MIGRATEINSTANCE:"013",迁移实例。
- FLOW_DELBACKUP:"014",删除备份。
- FLOW_EXCHANGEINSTANCE: "016",切换实例流程。
- FLOW_AUTOBACKUP:"017",自动备份实例。
- FLOW_MIGRATECHECK: "022",迁移参数校验。
- FLOW_MIGRATETASK:"023",数据迁移中。
- FLOW_CLEANDB:"025",清空数据库。
- FLOW_CLONEBACKUP:"026",克隆备份。
- FLOW_CHANGEVIP: "027",改变vip地址。
- FLOW_EXPORSHR :"028",扩缩容。
- FLOW_ADDNODES:"029",加(减)节点。
- FLOW_CHANGENET:"031",改变网络类型。
- FLOW_MODIFYINSTACEREADONLY:"033",只读策略变更。
- FLOW_MODIFYINSTANCEPARAMS:"034",修改实例参数。
- FLOW_MODIFYINSTANCEPASSWORDFREE:"035",设置免密。
- FLOW_SWITCHINSTANCEVIP:"036",实例VIP切换。
- FLOW_MODIFYINSTANCEACCOUNT:"037",实例账号变更。
- FLOW_MODIFYINSTANCEBANDWIDTH:"038",实例带宽变更。
- FLOW_ENABLEINSTANCE_REPLICATE:"039",开启副本只读。
- FLOW_DISABLEINSTANCE_REPLICATE:"040",关闭副本只读。
- FLOW_UpgradeArch:"041",实例架构升级,主从升集群。
- FLOW_DowngradeArch: "042",实例架构降级,集群降主从。
- FLOW_UpgradeVersion: "043",版本升级。
- FLOW_MODIFYCONNECTIONCONFIG:"044",带宽连接数调整。
- FLOW_CLEARNETWORK:"045",更换网络,
- FLOW_REMOVE_BACKUP_FILE:"046",删除备份。
- FLOW_UPGRADE_SUPPORT_MULTI_AZ:"047",升级实例支持多可用区。
- FLOW_SHUTDOWN_MASTER:"048",模拟故障。
- FLOW_CHANGE_REPLICA_TO_MASTER:"049",手动提主。
- FLOW_CODE_ADD_REPLICATION_INSTANCE:"050",新增复制组。
- FLOW_OPEN_WAN:"052",开通外网。
- FLOW_CLOSE_WAN:"053",关闭外网
- FLOW_CODE_DELETE_REPLICATION_INSTANCE:"055",解绑复制组。
- FLOW_CODE_CHANGE_MASTER_INSTANCE:"056",复制组实例切主。
- FLOW_CODE_CHANGE_INSTANCE_ROLE: "057",更改复制组实例角色。
- FLOW_MIGRATE_NODE:"058",迁移节点。
- FLOW_SWITCH_NODE:"059",切换节点。
- FLOW_UPGRADE_SMALL_VERSION:"060",升级 Redis版本。
- FLOW_UPGRADE_PROXY_VERSION:"061",升级 Proxy 版本。
- FLOW_MODIFY_INSTANCE_NETWORK: "062",实例修改网络。
- FLOW_MIGRATE_PROXY_NODE:"063",迁移 proxy节点。
- FLOW_MIGRATION_INSTANCE_ZONE:"066",实例可用区迁移中。
- FLOW_UPGRADE_INSTANCE_CACHE_AND_PROXY: "067",实例版本升级中。
- FLOW_MODIFY_PROXY_NUM:"069",加(减)Proxy 节点。
- FLOW_MODIFYBACKUPMOD:"070",变更实例备份模式。
*/
TaskType?: string;
/**
* 实例名称。
*/
InstanceName?: string;
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 项目 ID。
*/
ProjectId?: number;
/**
* 任务进度。
*/
Progress?: number;
/**
* 任务执行结束时间。
*/
EndTime?: string;
/**
* 任务执行状态。
0:任务初始化。
1:执行中。
2:完成。
4:失败。
*/
Result?: number;
}
/**
* DescribeInstanceZoneInfo返回参数结构体
*/
export interface DescribeInstanceZoneInfoResponse {
/**
* 实例节点组的个数。
*/
TotalCount?: number;
/**
* 实例节点组列表。
*/
ReplicaGroups?: Array<ReplicaGroup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 子账号信息
*/
export interface Account {
/**
* <p>实例 ID。</p>
*/
InstanceId?: string;
/**
* <p>账号名称。</p>
*/
AccountName?: string;
/**
* <p>账号描述信息。</p>
*/
Remark?: string;
/**
* <p>读写权限策略。- r:只读。- w:只写。- rw:读写。</p>
*/
Privilege?: string;
/**
* <p>只读路由策略。- master:主节点。- replication:从节点。</p>
*/
ReadonlyPolicy?: Array<string>;
/**
* <p>子账号状态.- 1:账号变更中。- 2:账号有效。- 4:账号已删除。</p>
*/
Status?: number;
/**
* <p>账号创建时间。</p><p>若该参数为空字符串,说明该账号创建于早期版本,未支持创建时间记录功能。</p>
*/
CreateTime?: string;
/**
* <p>账号最后修改密码的时间。</p><p>若该参数为空字符串,说明该账号创建于早期版本,未支持密码修改时间记录功能。</p>
*/
PasswordLastModifiedTime?: string;
}
/**
* 代理慢查询详情
*/
export interface InstanceProxySlowlogDetail {
/**
* <p>慢查询耗时时长。单位:毫秒。</p>
*/
Duration?: number;
/**
* <p>客户端地址。</p>
*/
Client?: string;
/**
* <p>慢查询的命令。</p>
*/
Command?: string;
/**
* <p>慢查询详细命令行信息。</p>
*/
CommandLine?: string;
/**
* <p>执行时间。</p>
*/
ExecuteTime?: string;
/**
* <p>收客户端请求时长(ms)</p>
*/
RecvClientEnd?: number;
/**
* <p>发送客户端请求时长(ms)</p>
*/
SendClientEnd?: number;
/**
* <p>Proxy节点ID。</p>
*/
Node?: string;
}
/**
* 安全组出入规则
*/
export interface SecurityGroupsInboundAndOutbound {
/**
* 标识出入数据库的IP与端口是否被允许。
- ACCEPT:允许。
- DROP:不允许。
*/
Action?: string;
/**
* 出入数据库的IP地址
*/
Ip?: string;
/**
* 端口号。
*/
Port?: string;
/**
* 协议类型。
*/
Proto?: string;
}
/**
* ModifyLog请求参数结构体
*/
export interface ModifyLogRequest {
/**
* <p>指定实例 ID。例如:crs-xjhsdj****。请登录<a href="https://console.cloud.tencent.com/redis">Redis控制台</a>在实例列表复制实例 ID。</p>
*/
InstanceId: string;
/**
* <p>日志类型。</p><p>枚举值:</p><ul><li>auditLog: 审计日志</li></ul>
*/
LogType: string;
/**
* <p>日志子类型。</p><p>枚举值:</p><ul><li>write: 写命令</li><li>read: 读命令</li><li>all: 全部命令</li></ul>
*/
LogSubType: string;
/**
* <p>日志过期时间,单位:天。</p><p>枚举值:</p><ul><li>7: 7 天</li><li>30: 30 天</li></ul>
*/
LogExpireDay: number;
/**
* <p>高频日志过期时间,单位:天。</p><p>枚举值:</p><ul><li>7: 7 天</li></ul><p>默认值: 7</p>
*/
HighLogExpireDay: number;
/**
* <p>降级策略,单位:毫秒,实例P99达到降级策略后,审计数据自动丢弃,优先保障业务的可用性,默认值:500毫秒。</p><p>取值范围:[300, 1000]</p>
*/
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<ZoneCapacityConf>;
}
/**
* 大Key详情
*/
export interface BigKeyInfo {
/**
* 所属的database
*/
DB?: number;
/**
* 大Key
*/
Key?: string;
/**
* 类型
*/
Type?: string;
/**
* 大小
*/
Size?: number;
/**
* 数据时间戳
*/
Updatetime?: number;
}
/**
* DescribeBandwidthRange返回参数结构体
*/
export interface DescribeBandwidthRangeResponse {
/**
* <p>标准带宽。指购买实例时,系统为每个节点分配的带宽。</p>单位: MB/s。
*/
BaseBandwidth?: number;
/**
* <p>指实例的附加带宽。标准带宽不满足需求的情况下,用户可自行增加的带宽。</p><ul><li>开启副本只读时,实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数 * Max ([只读副本数量, 1]),标准架构的分片数 = 1。</li><li>没有开启副本只读时,实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数,标准架构的分片数 = 1。</li></ul>单位: MB/s。
*/
AddBandwidth?: number;
/**
* <p>附加带宽设置下限。</p>单位: MB/s。
*/
MinAddBandwidth?: number;
/**
* <p>附加带宽设置上限。</p>单位: MB/s。
*/
MaxAddBandwidth?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeParamTemplates请求参数结构体
*/
export interface DescribeParamTemplatesRequest {
/**
* <p>指定查询的产品版本与架构。</p><ul><li>6:Redis 4.0 标准架构。</li><li>7:Redis 4.0 集群架构。</li><li>8:Redis 5.0 标准架构。</li><li>9:Redis 5.0 集群架构。</li><li>15:Redis 6.2 标准架构。</li><li>16:Redis 6.2 集群架构。</li><li>17:Redis 7.0 标准架构。</li><li>18:Redis 7.0 集群架构。</li><li>19:ValKey 8.0 标准架构。</li><li>20:ValKey 8.0 集群架构。</li></ul>
*/
ProductTypes?: Array<number | bigint>;
/**
* <p>指定查询的参数模板名称。</p><ul><li>数据类型:字符串数组,最大长度限制为50。</li><li>获取方式:请通过 <a href="https://console.cloud.tencent.com/redis/templates">Redis 控制台的参数模版</a> 页面复制自定义模板或系统默认模板的模板名称。</li></ul>
*/
TemplateNames?: Array<string>;
/**
* <p>指定查询的参数模板 ID。</p><ul><li>数据类型:字符串数组,最大长度限制为50。</li><li>获取方式:请通过 <a href="https://console.cloud.tencent.com/redis/templates">Redis 控制台的参数模版</a> 页面复制自定义模板或系统默认模板的模板 ID。</li></ul>
*/
TemplateIds?: Array<string>;
/**
* <p>指定查询结果的分页大小,即每页返回的记录数量。</p><ul><li>取值范围:0~200。</li><li>默认值:200。</li></ul>
*/
Limit?: number;
/**
* <p>分页偏移量,用于指定查询结果的起始位置。</p><ul><li>取值:必须为 Limit 的整数倍,默认值为 0。</li><li>计算公式:offset=limit*(页码-1)。</li></ul>
*/
Offset?: number;
}
/**
* RenewInstance请求参数结构体
*/
export interface RenewInstanceRequest {
/**
* 购买时长。
- 单位:月。
- 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
*/
Period: number;
/**
* 实例 ID,请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceId: string;
/**
* 标识是否修改计费模式。
- 当前实例计费模式为按量计费方式,预转换为包年包月而续费,请指定该参数为 <b>prepaid</b>。
- 当前实例计费模式为包年包月方式,可不设置该参数。
*/
ModifyPayMode?: string;
}
/**
* 实例事件信息
*/
export interface RedisInstanceEvent {
/**
* 事件 ID。
*/
ID?: number;
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 实例名称。
*/
InstanceName?: string;
/**
* 事件类型,当前仅支持配置实例迁移、资源腾挪、机房裁撤相关的运维操作。该参数仅支持配置为 **InstanceMigration**。
*/
Type?: string;
/**
* 事件等级根据其影响严重程度和紧急程度进行分级,由重至轻依次为关键、重要、中等、一般。
- Critical:关键
- High:重要
- Middle:中等
- Low:一般
*/
Grade?: string;
/**
* 事件计划执行日期。
*/
ExecutionDate?: string;
/**
* 事件计划执行开始时间。
*/
StartTime?: string;
/**
* 事件计划执行结束时间。
*/
EndTime?: string;
/**
* 运维事件最迟执行的日期,即该事件必须在该日期之前完成,否则可能会对业务产生影响。
*/
LatestExecutionDate?: string;
/**
* 事件当前状态。
- Waiting:未到达执行日期或不在维护时间窗内的事件。
- Running:在维护时间窗内,正在执行维护的事件。
- Finished:已全部完成维护的事件。
- Canceled:已取消执行的事件。
*/
Status?: string;
/**
* 事件执行任务完成时间。
*/
TaskEndTime?: string;
/**
* 事件影响信息。
*/
EffectInfo?: string;
/**
* 事件最初计划执行日期。
*/
InitialExecutionDate?: string;
}
/**
* UpgradeVersionToMultiAvailabilityZones返回参数结构体
*/
export interface UpgradeVersionToMultiAvailabilityZonesResponse {
/**
* <p>任务ID</p>
*/
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<Outbound>;
/**
* 入站规则。
*/
Inbound?: Array<Inbound>;
}
/**
* DescribeBandwidthRange请求参数结构体
*/
export interface DescribeBandwidthRangeRequest {
/**
* <p>实例 ID,请登录<a href="https://console.cloud.tencent.com/redis">Redis控制台</a>在实例列表复制实例 ID。</p>
*/
InstanceId: string;
}
/**
* DescribeInstanceParamRecords返回参数结构体
*/
export interface DescribeInstanceParamRecordsResponse {
/**
* 总的修改历史记录数。
*/
TotalCount?: number;
/**
* 修改历史记录信息。
*/
InstanceParamHistory?: Array<InstanceParamHistory>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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<string>;
/**
* 备份时间段。可设置为每个整点。格式如:00:00-01:00, 01:00-02:00...... 23:00-00:00。
*/
TimePeriod?: string;
/**
* 自动备份类型。目前仅能配置为:1 ,指定时备份。
*/
AutoBackupType?: number;
/**
* 全量备份文件保存天数。 仅支持设置为 7,单位:天。如需更长天数,请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。
*/
BackupStorageDays?: number;
}
/**
* 实例多选项类型参数描述
*/
export interface InstanceMultiParam {
/**
* 参数名称。
*/
ParamName?: string;
/**
* 参数类型。例如:multi。
*/
ValueType?: string;
/**
* 参数修改后是否需要重启。
- true:需要。
- false:不需要。
*/
NeedRestart?: string;
/**
* 参数默认值。
*/
DefaultValue?: string;
/**
* 当前运行参数值。
*/
CurrentValue?: string;
/**
* 参数说明。
*/
Tips?: string;
/**
* 参数枚举值。
*/
EnumValue?: Array<string>;
/**
* 参数修改的状态。
- 1:修改中。
- 2:修改完成。
*/
Status?: number;
}
/**
* DescribeInstanceDealDetail请求参数结构体
*/
export interface DescribeInstanceDealDetailRequest {
/**
* 订单号,即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealId。数组最大长度限制为10
* @deprecated
*/
DealIds?: Array<string>;
/**
* 订单号,即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealName。数组最大长度限制为10
*/
DealName?: string;
}
/**
* KillMasterGroup返回参数结构体
*/
export interface KillMasterGroupResponse {
/**
* 异步任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenLog返回参数结构体
*/
export interface OpenLogResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLog返回参数结构体
*/
export interface ModifyLogResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProjectSecurityGroup请求参数结构体
*/
export interface DescribeProjectSecurityGroupRequest {
/**
* 指定查询的项目 ID。
- 0:默认项目。
- -1:所有项目。
- 大于0:特定项目。请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID。
*/
ProjectId?: number;
/**
* 安全组 ID,通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数 **InstanceSecurityGroupsDetail** 的子参数 **SecurityGroupId** 获取。
*/
SecurityGroupId?: string;
}
/**
* Redis参数模板参数详情
*/
export interface ParameterDetail {
/**
* 参数名称。
*/
Name?: string;
/**
* 参数类型。
*/
ParamType?: string;
/**
* 参数默认值。
*/
Default?: string;
/**
* 参数描述。
*/
Description?: string;
/**
* 参数当前值。
*/
CurrentValue?: string;
/**
* 修改参数后,是否需要重启数据库以使参数生效。
- 0:不需要重启。
- 1:需要重启。
*/
NeedReboot?: number;
/**
* 参数允许的最大值。
*/
Max?: string;
/**
* 参数允许的最小值。
*/
Min?: string;
/**
* 参数可选枚举值。如果为非枚举参数,则为空。
*/
EnumValue?: Array<string>;
}
/**
* DescribeInstanceShards返回参数结构体
*/
export interface DescribeInstanceShardsResponse {
/**
* 实例分片列表信息,包括:节点信息、节点ID、Key数量、使用容量、容量倾斜率等信息。
*/
InstanceShards?: Array<InstanceClusterShard>;
/**
* 实例分片节点数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRedisClusterOverview返回参数结构体
*/
export interface DescribeRedisClusterOverviewResponse {
/**
* 资源包总数
*/
TotalBundle?: number;
/**
* 资源包总内存大小,单位:GB
*/
TotalMemory?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisableReplicaReadonly请求参数结构体
*/
export interface DisableReplicaReadonlyRequest {
/**
* 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceId: string;
}
/**
* redis独享集群详细信息
*/
export interface CDCResource {
/**
* 用户的Appid
*/
AppId?: number;
/**
* 地域id
*/
RegionId?: number;
/**
* 可用区id
*/
ZoneId?: number;
/**
* redis独享集群id
*/
RedisClusterId?: string;
/**
* 计费模式,1-包年包月,0-按量计费
*/
PayMode?: number;
/**
* 项目id
*/
ProjectId?: number;
/**
* 自动续费标识,0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
*/
AutoRenewFlag?: number;
/**
* 独享集群名称
*/
ClusterName?: string;
/**
* 实例创建时间
*/
StartTime?: string;
/**
* 实例到期时间
*/
EndTime?: string;
/**
* 集群状态:1-流程中,2-运行中,3-已隔离
*/
Status?: number;
/**
* 基础管控资源包
*/
BaseBundles?: Array<ResourceBundle>;
/**
* 资源包列表
*/
ResourceBundles?: Array<ResourceBundle>;
/**
* 所属本地专有集群id
*/
DedicatedClusterId?: string;
}
/**
* ModifyInstanceLogDelivery返回参数结构体
*/
export interface ModifyInstanceLogDeliveryResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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<BackupLimitVpcItem>;
/**
* 自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时,需配置该参数。
*/
LimitIp?: Array<string>;
}
/**
* DisableReplicaReadonly返回参数结构体
*/
export interface DisableReplicaReadonlyResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyPrepaidInstance请求参数结构体
*/
export interface DestroyPrepaidInstanceRequest {
/**
* 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
InstanceId: string;
}
/**
* CreateParamTemplate返回参数结构体
*/
export interface CreateParamTemplateResponse {
/**
* 参数模板 ID。
*/
TemplateId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例标签信息
*/
export interface InstanceTagInfo {
/**
* 标签键。
*/
TagKey: string;
/**
* 标签值。
*/
TagValue: string;
}
/**
* Redis节点的运行信息
*/
export interface RedisNode {
/**
* Redis 节点上 Key 的个数。
*/
Keys: number;
/**
* Redis 节点 Slot 分布范围。例如:0-5460。
*/
Slot: string;
/**
* 节点的序列 ID。
*/
NodeId: string;
/**
* 节点的状态。
*/
Status: string;
/**
* 节点角色。
*/
Role: string;
}
/**
* DescribeInstanceDTSInfo返回参数结构体
*/
export interface DescribeInstanceDTSInfoResponse {
/**
* DTS任务ID
*/
JobId?: string;
/**
* DTS任务名称
*/
JobName?: string;
/**
* 任务状态,取值为:1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过(CheckNotPass),7-任务运行(Running),8-准备完成(ReadyComplete),9-任务成功(Success),10-任务失败(Failed),11-撤销中(Stopping),12-完成中(Completing)
*/
Status?: number;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 同步时延,单位:字节
*/
Offset?: number;
/**
* 断开时间
*/
CutDownTime?: string;
/**
* 源实例信息
*/
SrcInfo?: DescribeInstanceDTSInstanceInfo;
/**
* 目标实例信息
*/
DstInfo?: DescribeInstanceDTSInstanceInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceEvents请求参数结构体
*/
export interface DescribeInstanceEventsRequest {
/**
* 配置查询事件执行计划的起始日期,查询日期最大跨度30天。
*/
ExecutionStartDate: string;
/**
* 配置查询事件执行计划的结束日期,查询日期最大跨度30天。
*/
ExecutionEndDate: string;
/**
* 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
*/
InstanceId?: string;
/**
* 输出每页显示事件的数量。
- 默认值:10。
- 取值范围:[1,100]。
*/
PageSize?: number;
/**
* 配置查询事件的输出页码,即支持根据PageNo(页码)与 PageSize (每页输出数量)查询某一页的事件。
- 默认值:1。
- 取值范围:大于0 的正整数。
*/
PageNo?: number;
/**
* 事件当前状态。
- Waiting:未到达执行日期或不在维护时间窗内的事件。
- Running:在维护时间窗内,正在执行维护的事件。
- Finished:已全部完成维护的事件。
- Canceled:已取消执行的事件。
*/
Status?: Array<string>;
/**
* 事件类型,当前仅支持配置实例迁移、资源腾挪、机房裁撤相关的运维操作。该参数仅支持配置为 **InstanceMigration**。
*/
EventTypes?: Array<string>;
/**
* 配置查询事件等级。事件等级根据其影响严重程度和紧急程度进行分级,由重至轻依次为关键、重要、中等、一般。
- Critical:关键
- High:重要
- Middle:中等
- Low:一般
*/
Grades?: Array<string>;
}
/**
* DescribeGlobalReplicationArea请求参数结构体
*/
export type DescribeGlobalReplicationAreaRequest = null;
/**
* AddReplicationInstance返回参数结构体
*/
export interface AddReplicationInstanceResponse {
/**
* 异步流程ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyPostpaidInstance返回参数结构体
*/
export interface DestroyPostpaidInstanceResponse {
/**
* 任务Id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchInstanceVip请求参数结构体
*/
export interface SwitchInstanceVipRequest {
/**
* 源实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
SrcInstanceId: string;
/**
* 目标实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
*/
DstInstanceId: string;
/**
* 单位为秒。源实例与目标实例间DTS已断开时间。如果 DTS 断开时间大于TimeDelay,则不切换VIP,建议尽量根据业务设置一个可接受的值。
*/
TimeDelay?: number;
/**
* 在 DTS 断开的情况下是否强制切换。
- 1:强制切换。
- 0:不强制切换。
*/
ForceSwitch?: number;
/**
* now: 立即切换,syncComplete:等待同步完成后切换
*/
SwitchTime?: string;
}
/**
* ChangeReplicaToMaster请求参数结构体
*/
export interface ChangeReplicaToMasterRequest {
/**
* <p>指定实例 ID。例如:crs-xjhsdj****。请登录<a href="https://console.cloud.tencent.com/redis">Redis控制台</a>在实例列表复制实例 ID。</p>
*/
InstanceId: string;
/**
* <p>副本节点组 ID,请通过接口<a href="https://cloud.tencent.com/document/product/239/50312">DescribeInstanceZoneInfo</a>获取多 AZ备节点组的 ID 信息。单 AZ,则无需配置该参数。</p>
*/
GroupId?: number;
/**
* <p>紧急模式。</p><p>枚举值:</p><ul><li>false: 标准模式(安全推荐)</li><li>true: 极速模式:(高危加速)跳过校验、极速提主。高位操作,极易在异常情况下产生单主节点。</li></ul><p>默认值:false</p>
*/
Emergency?: boolean;
}
/**
* Proxy节点信息。
*/
export interface ProxyNodes {
/**
* 节点 ID。
*/
NodeId?: string;
/**
* 可用区 ID。
*/
ZoneId?: number;
}
/**
* ModifyInstance返回参数结构体
*/
export interface ModifyInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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<string>;
/**
* 实例网络端口。
*/
Vport: number;
/**
* 实例创建时间。
*/
Createtime: string;
/**
* 计费类型。
- 0:按量计费。
- 1:包年包月。
*/
PayMode: number;
/**
* 网络类型。
- 0:基础网络。
- 1:VPC 网络。
*/
NetType: number;
}
/**
* 访问来源信息
*/
export interface SourceInfo {
/**
* 来源 IP 地址。
*/
Ip?: string;