tencentcloud-sdk-nodejs-redis 4.0.578 → 4.0.580

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -199,7 +199,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
199
199
  */
200
200
  DescribeInstanceParamRecords(req: DescribeInstanceParamRecordsRequest, cb?: (error: string, rep: DescribeInstanceParamRecordsResponse) => void): Promise<DescribeInstanceParamRecordsResponse>;
201
201
  /**
202
- * 查询参数模板详情。
202
+ * 本接口(DescribeParamTemplateInfo)用于查询参数模板详情。
203
203
  */
204
204
  DescribeParamTemplateInfo(req: DescribeParamTemplateInfoRequest, cb?: (error: string, rep: DescribeParamTemplateInfoResponse) => void): Promise<DescribeParamTemplateInfoResponse>;
205
205
  /**
@@ -316,7 +316,7 @@ class Client extends TencentCloudCommon.AbstractClient {
316
316
  return this.request("DescribeInstanceParamRecords", req, cb);
317
317
  }
318
318
  /**
319
- * 查询参数模板详情。
319
+ * 本接口(DescribeParamTemplateInfo)用于查询参数模板详情。
320
320
  */
321
321
  async DescribeParamTemplateInfo(req, cb) {
322
322
  return this.request("DescribeParamTemplateInfo", req, cb);
@@ -829,7 +829,7 @@ export interface Account {
829
829
  */
830
830
  export interface InstanceProxySlowlogDetail {
831
831
  /**
832
- * 慢查询耗时(单位:毫秒)。
832
+ * 慢查询耗时时长。单位:毫秒。
833
833
  */
834
834
  Duration: number;
835
835
  /**
@@ -837,11 +837,11 @@ export interface InstanceProxySlowlogDetail {
837
837
  */
838
838
  Client: string;
839
839
  /**
840
- * 命令。
840
+ * 慢查询的命令。
841
841
  */
842
842
  Command: string;
843
843
  /**
844
- * 详细命令行信息。
844
+ * 慢查询详细命令行信息。
845
845
  */
846
846
  CommandLine: string;
847
847
  /**
@@ -1179,41 +1179,43 @@ export interface DescribeProjectSecurityGroupRequest {
1179
1179
  */
1180
1180
  export interface ParameterDetail {
1181
1181
  /**
1182
- * 参数名称
1182
+ * 参数名称。
1183
1183
  */
1184
1184
  Name: string;
1185
1185
  /**
1186
- * 参数类型
1186
+ * 参数类型。
1187
1187
  */
1188
1188
  ParamType: string;
1189
1189
  /**
1190
- * 参数默认值
1190
+ * 参数默认值。
1191
1191
  */
1192
1192
  Default: string;
1193
1193
  /**
1194
- * 参数描述
1194
+ * 参数描述。
1195
1195
  */
1196
1196
  Description: string;
1197
1197
  /**
1198
- * 参数当前值
1198
+ * 参数当前值。
1199
1199
  */
1200
1200
  CurrentValue: string;
1201
1201
  /**
1202
- * 修改参数后,是否需要重启数据库以使参数生效。可能的值包括:0-不需要重启;1-需要重启
1203
- */
1202
+ * 修改参数后,是否需要重启数据库以使参数生效。
1203
+ - 0:不需要重启。
1204
+ - 1:需要重启。
1205
+ */
1204
1206
  NeedReboot: number;
1205
1207
  /**
1206
- * 参数允许的最大值
1208
+ * 参数允许的最大值。
1207
1209
  注意:此字段可能返回 null,表示取不到有效值。
1208
1210
  */
1209
1211
  Max: string;
1210
1212
  /**
1211
- * 参数允许的最小值
1213
+ * 参数允许的最小值。
1212
1214
  注意:此字段可能返回 null,表示取不到有效值。
1213
1215
  */
1214
1216
  Min: string;
1215
1217
  /**
1216
- * 参数的可选枚举值。如果为非枚举参数,则为空
1218
+ * 参数可选枚举值。如果为非枚举参数,则为空。
1217
1219
  注意:此字段可能返回 null,表示取不到有效值。
1218
1220
  */
1219
1221
  EnumValue: Array<string>;
@@ -1531,60 +1533,69 @@ export interface ModifyInstanceResponse {
1531
1533
  */
1532
1534
  export interface RedisCommonInstanceList {
1533
1535
  /**
1534
- * 实例名称
1536
+ * 实例名称。
1535
1537
  */
1536
1538
  InstanceName: string;
1537
1539
  /**
1538
- * 实例id
1540
+ * 实例 ID。
1539
1541
  */
1540
1542
  InstanceId: string;
1541
1543
  /**
1542
- * 用户id
1544
+ * 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
1543
1545
  */
1544
1546
  AppId: number;
1545
1547
  /**
1546
- * 实例所属项目id
1548
+ * 实例所属项目 ID。
1547
1549
  */
1548
1550
  ProjectId: number;
1549
1551
  /**
1550
- * 实例接入区域
1552
+ * 实例接入区域。
1551
1553
  */
1552
1554
  Region: string;
1553
1555
  /**
1554
- * 实例接入zone
1556
+ * 实例接入可用区。
1555
1557
  */
1556
1558
  Zone: string;
1557
1559
  /**
1558
- * 实例网络id
1560
+ * 实例私有网络 ID。
1559
1561
  */
1560
1562
  VpcId: string;
1561
1563
  /**
1562
- * 子网id
1564
+ * 私有网络所属子网 ID。
1563
1565
  */
1564
1566
  SubnetId: string;
1565
1567
  /**
1566
- * 实例状态信息,1-流程中 ,2-运行中, -2-实例已隔离 ,-3-实例待回收, -4-实例已删除
1567
- */
1568
+ * 实例状态信息。
1569
+ - 1-流程中。
1570
+ - 2-运行中。
1571
+ - -2-实例已隔离。
1572
+ - -3-实例待回收。
1573
+ - -4-实例已删除。
1574
+ */
1568
1575
  Status: string;
1569
1576
  /**
1570
- * 实例网络ip
1577
+ * 实例私有网络 IP 地址。
1571
1578
  */
1572
1579
  Vips: Array<string>;
1573
1580
  /**
1574
- * 实例网络端口
1581
+ * 实例网络端口。
1575
1582
  */
1576
1583
  Vport: number;
1577
1584
  /**
1578
- * 实例创建时间
1585
+ * 实例创建时间。
1579
1586
  */
1580
1587
  Createtime: string;
1581
1588
  /**
1582
- * 计费类型,0-按量计费,1-包年包月
1583
- */
1589
+ * 计费类型。
1590
+ - 0:按量计费。
1591
+ - 1:包年包月。
1592
+ */
1584
1593
  PayMode: number;
1585
1594
  /**
1586
- * 网络类型,0-基础网络,1-VPC网络
1587
- */
1595
+ * 网络类型。
1596
+ - 0:基础网络。
1597
+ - 1:VPC 网络。
1598
+ */
1588
1599
  NetType: number;
1589
1600
  }
1590
1601
  /**
@@ -1745,7 +1756,7 @@ export interface ModifyMaintenanceWindowRequest {
1745
1756
  */
1746
1757
  export interface DescribeParamTemplateInfoRequest {
1747
1758
  /**
1748
- * 参数模板 ID
1759
+ * 指定查询的参数模板 ID。请通过接口[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)获取参数模板列表信息。
1749
1760
  */
1750
1761
  TemplateId: string;
1751
1762
  }
@@ -2120,20 +2131,30 @@ export interface CloneInstancesResponse {
2120
2131
  */
2121
2132
  export interface ParamTemplateInfo {
2122
2133
  /**
2123
- * 参数模板ID
2134
+ * 参数模板 ID
2124
2135
  */
2125
2136
  TemplateId: string;
2126
2137
  /**
2127
- * 参数模板名称
2138
+ * 参数模板名称。
2128
2139
  */
2129
2140
  Name: string;
2130
2141
  /**
2131
- * 参数模板描述
2142
+ * 参数模板描述。
2132
2143
  */
2133
2144
  Description: string;
2134
2145
  /**
2135
- * 产品类型: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内存版(集群架构)
2136
- */
2146
+ * 实例类型。
2147
+ - 2:Redis 2.8内存版(标准架构)。
2148
+ - 3:CKV 3.2内存版(标准架构)。
2149
+ - 4:CKV 3.2内存版(集群架构)。
2150
+ - 5:Redis 2.8内存版(单机)。
2151
+ - 6:Redis 4.0内存版(标准架构)。
2152
+ - 7:Redis 4.0内存版(集群架构)。
2153
+ - 8:Redis 5.0内存版(标准架构)。
2154
+ - 9:Redis 5.0内存版(集群架构)。
2155
+ - 15:Redis 6.2内存版(标准架构)。
2156
+ - 16:Redis 6.2内存版(集群架构)。
2157
+ */
2137
2158
  ProductType: number;
2138
2159
  }
2139
2160
  /**
@@ -2542,23 +2563,26 @@ export interface DescribeInstanceSecurityGroupRequest {
2542
2563
  */
2543
2564
  export interface InstanceParamHistory {
2544
2565
  /**
2545
- * 参数名称
2566
+ * 参数名称。
2546
2567
  */
2547
2568
  ParamName: string;
2548
2569
  /**
2549
- * 修改前值
2570
+ * 参数修改之前的值。
2550
2571
  */
2551
2572
  PreValue: string;
2552
2573
  /**
2553
- * 修改后值
2574
+ * 参数修改之后的值。
2554
2575
  */
2555
2576
  NewValue: string;
2556
2577
  /**
2557
- * 状态:1-参数配置修改中;2-参数配置修改成功;3-参数配置修改失败
2558
- */
2578
+ * 参数配置状态。
2579
+ - 1:参数配置修改中。
2580
+ - 2:参数配置修改成功。
2581
+ - 3:参数配置修改失败。
2582
+ */
2559
2583
  Status: number;
2560
2584
  /**
2561
- * 修改时间
2585
+ * 修改时间。
2562
2586
  */
2563
2587
  ModifyTime: string;
2564
2588
  }
@@ -2921,56 +2945,72 @@ export interface ReleaseWanAddressResponse {
2921
2945
  */
2922
2946
  export interface ProductConf {
2923
2947
  /**
2924
- * 产品类型,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内存版(集群架构),10 – Redis4.0混合存储版Tendis
2925
- */
2948
+ * 产品类型。
2949
+ - 2:Redis 2.8内存版(标准架构)。
2950
+ - 3:CKV 3.2内存版(标准架构)。
2951
+ - 4:CKV 3.2内存版(集群架构)。
2952
+ - 5:Redis 2.8内存版(单机)。
2953
+ - 6:Redis 4.0内存版(标准架构)。
2954
+ - 7:Redis 4.0内存版(集群架构)。
2955
+ - 8:Redis 5.0内存版(标准架构)。
2956
+ - 9:Redis 5.0内存版(集群架构)。
2957
+ - 15:Redis 6.2内存版(标准架构)。
2958
+ - 16:Redis 6.2内存版(集群架构)。
2959
+ */
2926
2960
  Type: number;
2927
2961
  /**
2928
- * 产品名称,Redis主从版,CKV主从版,CKV集群版,Redis单机版,Redis集群版,混合存储版Tendis
2962
+ * 产品名称。包括:Redis 主从版、CKV 主从版、CKV 集群版、Redis 单机版、Redis 集群版。
2929
2963
  */
2930
2964
  TypeName: string;
2931
2965
  /**
2932
- * 购买时的最小数量
2966
+ * 购买时的最小数量。
2933
2967
  */
2934
2968
  MinBuyNum: number;
2935
2969
  /**
2936
- * 购买时的最大数量
2970
+ * 购买时的最大数量。
2937
2971
  */
2938
2972
  MaxBuyNum: number;
2939
2973
  /**
2940
- * 产品是否售罄
2941
- */
2974
+ * 产品是否售罄。
2975
+ - true:售罄。
2976
+ - false:未售罄。
2977
+ */
2942
2978
  Saleout: boolean;
2943
2979
  /**
2944
- * 产品引擎,腾讯云CKV或者社区版Redis
2980
+ * 产品引擎。包括:腾讯云 CKV与社区版 Redis
2945
2981
  */
2946
2982
  Engine: string;
2947
2983
  /**
2948
- * 兼容版本,Redis-2.8Redis-3.2Redis-4.0
2984
+ * 兼容版本。包括:Redis-2.8Redis-3.2Redis-4.0、Redis-5.0、Redis-6.2。
2949
2985
  */
2950
2986
  Version: string;
2951
2987
  /**
2952
- * 规格总大小,单位G
2988
+ * 规格总大小,单位GB。
2953
2989
  */
2954
2990
  TotalSize: Array<string>;
2955
2991
  /**
2956
- * 每个分片大小,单位G
2992
+ * 每个分片大小,单位GB。
2957
2993
  */
2958
2994
  ShardSize: Array<string>;
2959
2995
  /**
2960
- * 副本数量
2996
+ * 副本数量。
2961
2997
  */
2962
2998
  ReplicaNum: Array<string>;
2963
2999
  /**
2964
- * 分片数量
3000
+ * 分片数量。
2965
3001
  */
2966
3002
  ShardNum: Array<string>;
2967
3003
  /**
2968
- * 支持的计费模式,1-包年包月,0-按量计费
2969
- */
3004
+ * 支持的计费模式。
3005
+ - 1:包年包月。
3006
+ - 0:按量计费。
3007
+ */
2970
3008
  PayMode: string;
2971
3009
  /**
2972
- * 是否支持副本只读
2973
- */
3010
+ * 是否支持副本只读。
3011
+ - true:支持副本只读。
3012
+ - false:不支持。
3013
+ */
2974
3014
  EnableRepicaReadOnly: boolean;
2975
3015
  }
2976
3016
  /**
@@ -3156,11 +3196,11 @@ export interface TradeDealDetail {
3156
3196
  */
3157
3197
  export interface ResourceTag {
3158
3198
  /**
3159
- * 标签key
3199
+ * 标签Key。
3160
3200
  */
3161
3201
  TagKey: string;
3162
3202
  /**
3163
- * 标签value
3203
+ * 标签 Key 对应的 Value。
3164
3204
  */
3165
3205
  TagValue: string;
3166
3206
  }
@@ -3280,7 +3320,7 @@ export interface DescribeInstanceDealDetailResponse {
3280
3320
  */
3281
3321
  export interface Groups {
3282
3322
  /**
3283
- * 用户AppID
3323
+ * 用户 APPID。APPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
3284
3324
  */
3285
3325
  AppId: number;
3286
3326
  /**
@@ -3306,7 +3346,7 @@ export interface Groups {
3306
3346
  */
3307
3347
  RegionId: number;
3308
3348
  /**
3309
- * 复制组 ID
3349
+ * 复制组 ID。格式如:crs-rpl-deind****。
3310
3350
  */
3311
3351
  GroupId: string;
3312
3352
  /**
@@ -3778,8 +3818,18 @@ export interface InstanceSet {
3778
3818
  */
3779
3819
  SizeUsed: number;
3780
3820
  /**
3781
- * 实例类型:<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>
3782
- */
3821
+ * 实例类型。
3822
+ - 2:Redis 2.8内存版(标准架构)。
3823
+ - 3:CKV 3.2内存版(标准架构)。
3824
+ - 4:CKV 3.2内存版(集群架构)。
3825
+ - 5:Redis 2.8内存版(单机)。
3826
+ - 6:Redis 4.0内存版(标准架构)。
3827
+ - 7:Redis 4.0内存版(集群架构)。
3828
+ - 8:Redis 5.0内存版(标准架构)。
3829
+ - 9:Redis 5.0内存版(集群架构)。
3830
+ - 15:Redis 6.2内存版(标准架构)。
3831
+ - 16:Redis 6.2内存版(集群架构)。
3832
+ */
3783
3833
  Type: number;
3784
3834
  /**
3785
3835
  * 实例是否设置自动续费标识。<ul><li>1:设置自动续费。</li><li>0:未设置自动续费。</li></ul>
@@ -4485,29 +4535,39 @@ export declare type DescribeBackupDownloadRestrictionRequest = null;
4485
4535
  */
4486
4536
  export interface DescribeParamTemplateInfoResponse {
4487
4537
  /**
4488
- * 实例参数个数
4538
+ * 参数模板的参数数量。
4489
4539
  */
4490
- TotalCount: number;
4540
+ TotalCount?: number;
4491
4541
  /**
4492
4542
  * 参数模板 ID。
4493
4543
  */
4494
- TemplateId: string;
4544
+ TemplateId?: string;
4495
4545
  /**
4496
4546
  * 参数模板名称。
4497
4547
  */
4498
- Name: string;
4548
+ Name?: string;
4499
4549
  /**
4500
- * 产品类型: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内存版(集群架构)
4501
- */
4502
- ProductType: number;
4550
+ * 产品类型。
4551
+ - 2:Redis 2.8内存版(标准架构)。
4552
+ - 3:CKV 3.2内存版(标准架构)。
4553
+ - 4:CKV 3.2内存版(集群架构)。
4554
+ - 5:Redis 2.8内存版(单机)。
4555
+ - 6:Redis 4.0内存版(标准架构)。
4556
+ - 7:Redis 4.0内存版(集群架构)。
4557
+ - 8:Redis 5.0内存版(标准架构)。
4558
+ - 9:Redis 5.0内存版(集群架构)。
4559
+ - 15:Redis 6.2内存版(标准架构)。
4560
+ - 16:Redis 6.2内存版(集群架构)。
4561
+ */
4562
+ ProductType?: number;
4503
4563
  /**
4504
- * 参数模板描述
4564
+ * 参数模板描述。
4505
4565
  */
4506
- Description: string;
4566
+ Description?: string;
4507
4567
  /**
4508
- * 参数详情
4568
+ * 参数详情。包含:参数的名称,当前运行值,默认值,最大值、最小值、枚举值等信息。
4509
4569
  */
4510
- Items: Array<ParameterDetail>;
4570
+ Items?: Array<ParameterDetail>;
4511
4571
  /**
4512
4572
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4513
4573
  */
@@ -4544,15 +4604,15 @@ export interface SwitchInstanceVipResponse {
4544
4604
  RequestId?: string;
4545
4605
  }
4546
4606
  /**
4547
- * 自定义的备份文件下载地址的 VPC 信息。
4607
+ * 已配置的备份文件下载地址对应的 VPC 信息。
4548
4608
  */
4549
4609
  export interface BackupLimitVpcItem {
4550
4610
  /**
4551
- * 自定义下载备份文件的VPC 所属地域。
4611
+ * 备份文件的下载地址对应VPC 所属的地域。
4552
4612
  */
4553
4613
  Region: string;
4554
4614
  /**
4555
- * 自定义下载备份文件的 VPC 列表。
4615
+ * 备份文件下载地址的 VPC 列表。
4556
4616
  */
4557
4617
  VpcList: Array<string>;
4558
4618
  }
@@ -4995,7 +5055,7 @@ export interface DescribeProjectSecurityGroupResponse {
4995
5055
  */
4996
5056
  export interface Instances {
4997
5057
  /**
4998
- * 用户AppID
5058
+ * 用户APPIDAPPID是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 APPID。
4999
5059
  */
5000
5060
  AppId: number;
5001
5061
  /**
@@ -5065,8 +5125,18 @@ export interface Instances {
5065
5125
  */
5066
5126
  GrocerySysId: number;
5067
5127
  /**
5068
- * 实例类型。<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>
5069
- */
5128
+ * 实例类型。
5129
+ - 2:Redis 2.8内存版(标准架构)。
5130
+ - 3:CKV 3.2内存版(标准架构)。
5131
+ - 4:CKV 3.2内存版(集群架构)。
5132
+ - 5:Redis 2.8内存版(单机)。
5133
+ - 6:Redis 4.0内存版(标准架构)。
5134
+ - 7:Redis 4.0内存版(集群架构)。
5135
+ - 8:Redis 5.0内存版(标准架构)。
5136
+ - 9:Redis 5.0内存版(集群架构)。
5137
+ - 15:Redis 6.2内存版(标准架构)。
5138
+ - 16:Redis 6.2内存版(集群架构)。
5139
+ */
5070
5140
  ProductType: number;
5071
5141
  /**
5072
5142
  * 实例加入复制组的时间。