tencentcloud-sdk-nodejs-redis 4.0.577 → 4.0.579

package/tencentcloud/services/redis/v20180412/redis_models.d.ts

@@ -829,7 +829,7 @@ export interface Account {
  */
 export interface InstanceProxySlowlogDetail {
     /**
-     * 慢查询耗时（单位：毫秒）。
+     * 慢查询耗时时长。单位：毫秒。
      */
     Duration: number;
     /**
@@ -837,11 +837,11 @@ export interface InstanceProxySlowlogDetail {
      */
     Client: string;
     /**
-     * 命令。
+     * 慢查询的命令。
      */
     Command: string;
     /**
-     * 详细命令行信息。
+     * 慢查询详细命令行信息。
      */
     CommandLine: string;
     /**
@@ -963,6 +963,31 @@ export interface BigKeyInfo {
      */
     Updatetime: number;
 }
+/**
+ * DescribeBandwidthRange返回参数结构体
+ */
+export interface DescribeBandwidthRangeResponse {
+    /**
+     * 标准带宽。指购买实例时，系统为每个节点分配的带宽。
+     */
+    BaseBandwidth: number;
+    /**
+     * 指实例的附加带宽。标准带宽不满足需求的情况下，用户可自行增加的带宽。<ul><li>开启副本只读时，实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数 * Max ([只读副本数量, 1])，标准架构的分片数 = 1。</li><li>没有开启副本只读时，实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数，标准架构的分片数 = 1。</li></ul>
+     */
+    AddBandwidth: number;
+    /**
+     * 附加带宽设置下限。
+     */
+    MinAddBandwidth: number;
+    /**
+     * 附加带宽设置上限。
+     */
+    MaxAddBandwidth: number;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeParamTemplates请求参数结构体
  */
@@ -1010,6 +1035,23 @@ export interface UpgradeVersionToMultiAvailabilityZonesResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeInstanceBackups返回参数结构体
+ */
+export interface DescribeInstanceBackupsResponse {
+    /**
+     * 备份总数。
+     */
+    TotalCount?: number;
+    /**
+     * 实例的备份数组。
+     */
+    BackupSet?: Array<RedisBackupSet>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeInstanceParamRecords返回参数结构体
  */
@@ -1137,41 +1179,43 @@ export interface DescribeProjectSecurityGroupRequest {
  */
 export interface ParameterDetail {
     /**
-     * 参数名称
+     * 参数名称。
      */
     Name: string;
     /**
-     * 参数类型
+     * 参数类型。
      */
     ParamType: string;
     /**
-     * 参数默认值
+     * 参数默认值。
      */
     Default: string;
     /**
-     * 参数描述
+     * 参数描述。
      */
     Description: string;
     /**
-     * 参数当前值
+     * 参数当前值。
      */
     CurrentValue: string;
     /**
-     * 修改参数后，是否需要重启数据库以使参数生效。可能的值包括：0-不需要重启；1-需要重启
-     */
+        * 修改参数后，是否需要重启数据库以使参数生效。
+  - 0：不需要重启。
+  - 1：需要重启。
+        */
     NeedReboot: number;
     /**
-        * 参数允许的最大值
+        * 参数允许的最大值。
   注意：此字段可能返回 null，表示取不到有效值。
         */
     Max: string;
     /**
-        * 参数允许的最小值
+        * 参数允许的最小值。
   注意：此字段可能返回 null，表示取不到有效值。
         */
     Min: string;
     /**
-        * 参数的可选枚举值。如果为非枚举参数，则为空
+        * 参数可选枚举值。如果为非枚举参数，则为空。
   注意：此字段可能返回 null，表示取不到有效值。
         */
     EnumValue: Array<string>;
@@ -1489,60 +1533,69 @@ export interface ModifyInstanceResponse {
  */
 export interface RedisCommonInstanceList {
     /**
-     * 实例名称
+     * 实例名称。
      */
     InstanceName: string;
     /**
-     * 实例id
+     * 实例 ID。
      */
     InstanceId: string;
     /**
-     * 用户id
+     * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。
      */
     AppId: number;
     /**
-     * 实例所属项目id
+     * 实例所属项目 ID。
      */
     ProjectId: number;
     /**
-     * 实例接入区域
+     * 实例接入区域。
      */
     Region: string;
     /**
-     * 实例接入zone
+     * 实例接入可用区。
      */
     Zone: string;
     /**
-     * 实例网络id
+     * 实例私有网络 ID。
      */
     VpcId: string;
     /**
-     * 子网id
+     * 私有网络所属子网 ID。
      */
     SubnetId: string;
     /**
-     * 实例状态信息，1-流程中 ,2-运行中, -2-实例已隔离 ,-3-实例待回收, -4-实例已删除
-     */
+        * 实例状态信息。
+  - 1-流程中。
+  - 2-运行中。
+  - -2-实例已隔离。
+  - -3-实例待回收。
+  - -4-实例已删除。
+        */
     Status: string;
     /**
-     * 实例网络ip
+     * 实例私有网络 IP 地址。
      */
     Vips: Array<string>;
     /**
-     * 实例网络端口
+     * 实例网络端口。
      */
     Vport: number;
     /**
-     * 实例创建时间
+     * 实例创建时间。
      */
     Createtime: string;
     /**
-     * 计费类型，0-按量计费，1-包年包月
-     */
+        * 计费类型。
+  - 0：按量计费。
+  - 1：包年包月。
+        */
     PayMode: number;
     /**
-     * 网络类型，0-基础网络，1-VPC网络
-     */
+        * 网络类型。
+  - 0：基础网络。
+  - 1：VPC 网络。
+        */
     NetType: number;
 }
 /**
@@ -1703,7 +1756,7 @@ export interface ModifyMaintenanceWindowRequest {
  */
 export interface DescribeParamTemplateInfoRequest {
     /**
-     * 参数模板 ID。
+     * 指定查询的参数模板 ID。请通过接口[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)获取参数模板列表信息。
      */
     TemplateId: string;
 }
@@ -1914,21 +1967,13 @@ export interface DescribeInstanceMonitorTookDistResponse {
     RequestId?: string;
 }
 /**
- * DescribeInstanceBackups返回参数结构体
+ * DescribeBandwidthRange请求参数结构体
  */
-export interface DescribeInstanceBackupsResponse {
-    /**
-     * 备份总数。
-     */
-    TotalCount?: number;
+export interface DescribeBandwidthRangeRequest {
     /**
-     * 实例的备份数组。
-     */
-    BackupSet?: Array<RedisBackupSet>;
-    /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     * 实例 ID。
      */
-    RequestId?: string;
+    InstanceId: string;
 }
 /**
  * 实例整型参数描述
@@ -2071,11 +2116,11 @@ export interface CloneInstancesResponse {
     /**
      * 请求任务 ID。
      */
-    DealId: string;
+    DealId?: string;
     /**
      * 克隆实例的 ID。
      */
-    InstanceIds: Array<string>;
+    InstanceIds?: Array<string>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -2086,20 +2131,29 @@ export interface CloneInstancesResponse {
  */
 export interface ParamTemplateInfo {
     /**
-     * 参数模板ID
+     * 参数模板 ID。
      */
     TemplateId: string;
     /**
-     * 参数模板名称
+     * 参数模板名称。
      */
     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内存版（集群架构）
-     */
+        * 实例类型。
+  - 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内存版（集群架构）。
+  
+        */
     ProductType: number;
 }
 /**
@@ -2305,12 +2359,14 @@ export interface DescribeTaskInfoRequest {
  */
 export interface CloneInstancesRequest {
     /**
-     * 当前实例ID。
+     * 指定待克隆的源实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
      */
     InstanceId: string;
     /**
-     * 单次克隆实例的数量。包年包月每次购买最大数量为100。按量计费每次购买最大数量为30，每个地域购买数量取值范围为[1,100]。
-     */
+        * 单次克隆实例的数量。
+  - 包年包月每次购买最大数量为100。
+  - 按量计费每次购买最大数量为30。
+        */
     GoodsNum: number;
     /**
      * 克隆实例所属的可用区ID。当前所支持的可用区 ID，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
@@ -2337,11 +2393,11 @@ export interface CloneInstancesRequest {
      */
     NoAuth?: boolean;
     /**
-     * 私有网络ID。如果未配置该参数，默认选择基础网络。
+     * 配置克隆实例的私有网络ID。如果未配置该参数，默认选择基础网络。
      */
     VpcId?: string;
     /**
-     * 私有网络所属子网。基础网络时该参数无需配置。
+     * 配置克隆实例所属私有网络的子网。基础网络时该参数无需配置。
      */
     SubnetId?: string;
     /**
@@ -2353,7 +2409,7 @@ export interface CloneInstancesRequest {
      */
     Password?: string;
     /**
-     * 自动续费标识。<ul><li>0：默认状态（手动续费）。</li><li>1：自动续费。</li><li>2：不自动续费，到期自动隔离。</li></ul>
+     * 自动续费标识。<ul><li>0：默认状态，手动续费。</li><li>1：自动续费。</li><li>2：不自动续费，到期自动隔离。</li></ul>
      */
     AutoRenew?: number;
     /**
@@ -2365,7 +2421,7 @@ export interface CloneInstancesRequest {
      */
     NodeSet?: Array<RedisNodeInfo>;
     /**
-     * 项目 ID。登录控制台，可在右上角的<b>账号中心</b> > <b>项目管理</b>中查找项目ID。
+     * 项目 ID。登录[Redis 控制台](https://console.cloud.tencent.com/redis#/)，可在右上角的<b>账号中心</b> > <b>项目管理</b>中查找项目ID。
      */
     ProjectId?: number;
     /**
@@ -2373,11 +2429,13 @@ export interface CloneInstancesRequest {
      */
     ResourceTags?: Array<ResourceTag>;
     /**
-     * 克隆实例需要应用的参数模板ID,请登录 Redis 控制台，在<b>参数模板</b>页面获取。若不配置该参数，则应用默认的参数模板。
-     */
+        * 指定克隆实例相关的参数模板 ID。
+  - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。
+  - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。
+        */
     TemplateId?: string;
     /**
-     * 指定克隆实例的告警策略 ID。请登录控制台，在<b>云监控</b> > <b>告警配置</b> > <b>告警策略</b>页面获取策略 ID 信息。
+     * 指定克隆实例的告警策略 ID。请登录[腾讯云可观测平台控制台](https://console.cloud.tencent.com/monitor/alarm2/policy)，在 <b>告警管理</b> > <b>策略管理</b>页面获取策略 ID 信息。
      */
     AlarmPolicyList?: Array<string>;
 }
@@ -2504,23 +2562,26 @@ export interface DescribeInstanceSecurityGroupRequest {
  */
 export interface InstanceParamHistory {
     /**
-     * 参数名称
+     * 参数名称。
      */
     ParamName: string;
     /**
-     * 修改前值
+     * 参数修改之前的值。
      */
     PreValue: string;
     /**
-     * 修改后值
+     * 参数修改之后的值。
      */
     NewValue: string;
     /**
-     * 状态：1-参数配置修改中；2-参数配置修改成功；3-参数配置修改失败
-     */
+        * 参数配置状态。
+  - 1：参数配置修改中。
+  - 2：参数配置修改成功。
+  - 3：参数配置修改失败。
+        */
     Status: number;
     /**
-     * 修改时间
+     * 修改时间。
      */
     ModifyTime: string;
 }
@@ -2795,6 +2856,23 @@ export interface CreateInstanceAccountRequest {
      */
     Remark?: string;
 }
+/**
+ * RemoveReplicationInstance请求参数结构体
+ */
+export interface RemoveReplicationInstanceRequest {
+    /**
+     * 复制组ID
+     */
+    GroupId: string;
+    /**
+     * 实例ID
+     */
+    InstanceId: string;
+    /**
+     * 数据同步类型，true:需要数据强同步,false:不需要强同步，仅限删除主实例
+     */
+    SyncType: boolean;
+}
 /**
  * EnableReplicaReadonly返回参数结构体
  */
@@ -3101,11 +3179,11 @@ export interface TradeDealDetail {
  */
 export interface ResourceTag {
     /**
-     * 标签key
+     * 标签Key。
      */
     TagKey: string;
     /**
-     * 标签value
+     * 标签 Key 对应的 Value。
      */
     TagValue: string;
 }
@@ -3225,7 +3303,7 @@ export interface DescribeInstanceDealDetailResponse {
  */
 export interface Groups {
     /**
-     * 用户AppID
+     * 用户 APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。
      */
     AppId: number;
     /**
@@ -3251,7 +3329,7 @@ export interface Groups {
         */
     RegionId: number;
     /**
-     * 复制组 ID。
+     * 复制组 ID。格式如：crs-rpl-deind****。
      */
     GroupId: string;
     /**
@@ -3414,7 +3492,7 @@ export interface SourceCommand {
  */
 export interface ModfiyInstancePasswordRequest {
     /**
-     * 实例 ID。
+     * 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
      */
     InstanceId: string;
     /**
@@ -3719,12 +3797,22 @@ export interface InstanceSet {
      */
     Size: number;
     /**
-     * 该字段已废弃。可使用云监控 API 接口 [GetMonitorData](https://cloud.tencent.com/document/product/248/31014) 获取实例已使用的内容容量。
+     * 该字段已废弃。请使用腾讯云可观测平台API 接口 [GetMonitorData](https://cloud.tencent.com/document/product/248/31014) 获取实例已使用的内存容量。
      */
     SizeUsed: number;
     /**
-     * 实例类型：<ul><li>1：Redis2.8内存版（集群架构）。</li><li>2：Redis2.8内存版（标准架构）。</li><li>3：CKV 3.2内存版(标准架构)。</li><li>4：CKV 3.2内存版(集群架构)。</li><li>5：Redis2.8内存版（单机）。</li></li><li>6：Redis4.0内存版（标准架构）。</li></li><li>7：Redis4.0内存版（集群架构）。</li></li><li>8：Redis5.0内存版（标准架构）。</li></li><li>9：Redis5.0内存版（集群架构）。</li></ul>
-     */
+        * 实例类型。
+  - 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;
     /**
      * 实例是否设置自动续费标识。<ul><li>1：设置自动续费。</li><li>0：未设置自动续费。</li></ul>
@@ -4430,29 +4518,39 @@ export declare type DescribeBackupDownloadRestrictionRequest = null;
  */
 export interface DescribeParamTemplateInfoResponse {
     /**
-     * 实例参数个数
+     * 参数模板的参数数量。
      */
-    TotalCount: number;
+    TotalCount?: number;
     /**
      * 参数模板 ID。
      */
-    TemplateId: string;
+    TemplateId?: string;
     /**
      * 参数模板名称。
      */
-    Name: string;
+    Name?: 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;
+        * 产品类型。
+  - 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;
+    Description?: string;
     /**
-     * 参数详情
+     * 参数详情。包含：参数的名称，当前运行值，默认值，最大值、最小值、枚举值等信息。
      */
-    Items: Array<ParameterDetail>;
+    Items?: Array<ParameterDetail>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -4489,15 +4587,15 @@ export interface SwitchInstanceVipResponse {
     RequestId?: string;
 }
 /**
- * 自定义的备份文件下载地址的 VPC 信息。
+ * 已配置的备份文件下载地址对应的 VPC 信息。
  */
 export interface BackupLimitVpcItem {
     /**
-     * 自定义下载备份文件的VPC 所属地域。
+     * 备份文件的下载地址对应VPC 所属的地域。
      */
     Region: string;
     /**
-     * 自定义下载备份文件的 VPC 列表。
+     * 备份文件下载地址的 VPC 列表。
      */
     VpcList: Array<string>;
 }
@@ -4633,6 +4731,19 @@ export interface DescribeInstanceBackupsRequest {
      */
     InstanceName?: string;
 }
+/**
+ * RemoveReplicationInstance返回参数结构体
+ */
+export interface RemoveReplicationInstanceResponse {
+    /**
+     * 异步任务ID
+     */
+    TaskId: number;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 安全组详情
  */
@@ -4927,7 +5038,7 @@ export interface DescribeProjectSecurityGroupResponse {
  */
 export interface Instances {
     /**
-     * 用户AppID。
+     * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。
      */
     AppId: number;
     /**
@@ -4997,8 +5108,18 @@ export interface Instances {
      */
     GrocerySysId: number;
     /**
-     * 实例类型。<ul><li>1：Redis 2.8 内存版（集群架构）。</li><li>2：Redis 2.8 内存版（标准架构）。</li><li>3：CKV 3.2 内存版（标准架构）。</li><li>4：CKV 3.2 内存版（集群架构）。</li><li>5：Redis 2.8 单机版。</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></ul>
-     */
+        * 实例类型。
+  - 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;
     /**
      * 实例加入复制组的时间。