tencentcloud-sdk-nodejs-redis 4.1.130 → 4.1.137

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-redis",
3
- "version": "4.1.130",
3
+ "version": "4.1.137",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -227,7 +227,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
227
227
  /**
228
228
  * 本接口(DescribeInstanceSpecBandwidth)用于查询或计算带宽规格。
229
229
  */
230
- DescribeInstanceSpecBandwidth(req?: DescribeInstanceSpecBandwidthRequest, cb?: (error: string, rep: DescribeInstanceSpecBandwidthResponse) => void): Promise<DescribeInstanceSpecBandwidthResponse>;
230
+ DescribeInstanceSpecBandwidth(req: DescribeInstanceSpecBandwidthRequest, cb?: (error: string, rep: DescribeInstanceSpecBandwidthResponse) => void): Promise<DescribeInstanceSpecBandwidthResponse>;
231
231
  /**
232
232
  * 本接口(DeleteInstanceAccount)用于删除实例子账号。
233
233
  */
@@ -286,8 +286,13 @@ export interface DescribeReplicationGroupInstanceRequest {
286
286
  export interface UpgradeInstanceVersionResponse {
287
287
  /**
288
288
  * 订单ID
289
+ * @deprecated
289
290
  */
290
291
  DealId?: string;
292
+ /**
293
+ * 订单号。
294
+ */
295
+ DealName?: string;
291
296
  /**
292
297
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
293
298
  */
@@ -299,7 +304,19 @@ export interface UpgradeInstanceVersionResponse {
299
304
  export interface CreateInstancesRequest {
300
305
  /**
301
306
  * 实例类型。
302
- <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>200:Memcached 1.6 内存版(集群架构)。</li>说明:CKV 版本当前有存量用户使用,暂时保留。</ul>
307
+ - 2:Redis 2.8 内存版(标准架构)。
308
+ - 3:CKV 3.2 内存版(标准架构)。
309
+ - 4:CKV 3.2 内存版(集群架构)。
310
+ - 6:Redis 4.0 内存版(标准架构)。
311
+ - 7:Redis 4.0 内存版(集群架构)。
312
+ - 8:Redis 5.0 内存版(标准架构)。
313
+ - 9:Redis 5.0 内存版(集群架构)。
314
+ - 15:Redis 6.2 内存版(标准架构)。
315
+ - 16:Redis 6.2 内存版(集群架构)。
316
+ - 17:Redis 7.0 内存版(标准架构)。
317
+ - 18:Redis 7.0 内存版(集群架构)。
318
+ - 200:Memcached 1.6 内存版(集群架构)。
319
+ **说明**:CKV 版本当前有存量用户使用,暂时保留。
303
320
  */
304
321
  TypeId: number;
305
322
  /**
@@ -372,7 +389,7 @@ export interface CreateInstancesRequest {
372
389
  RedisShardNum?: number;
373
390
  /**
374
391
  * 实例副本数量。
375
- - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。
392
+ - Redis 内存版 4.0、5.0、6.2、7.0 标准架构和集群架构支持副本数量范围为[1,5]。
376
393
  - Redis 2.8标准版、CKV标准版只支持1副本。
377
394
  */
378
395
  RedisReplicasNum?: number;
@@ -426,7 +443,10 @@ export interface CreateInstancesRequest {
426
443
  */
427
444
  ProductVersion?: string;
428
445
  /**
429
- * 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
446
+ * 独享集群 ID
447
+
448
+ - 当 **ProductVersion** 设置为 **cdc** 时,该参数必须设置。
449
+ - 请通过接口[ DescribeRedisClusters](https://cloud.tencent.com/document/product/239/109628) 获取集群 ID。
430
450
  */
431
451
  RedisClusterId?: string;
432
452
  /**
@@ -462,6 +482,14 @@ export interface CreateReplicationGroupRequest {
462
482
  * DescribeInstanceSpecBandwidth返回参数结构体
463
483
  */
464
484
  export interface DescribeInstanceSpecBandwidthResponse {
485
+ /**
486
+ * 基础带宽。
487
+ */
488
+ Bandwidth?: number;
489
+ /**
490
+ * 链接限制。
491
+ */
492
+ ClientLimit?: number;
465
493
  /**
466
494
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
467
495
  */
@@ -660,8 +688,13 @@ export interface DescribeSecondLevelBackupInfoResponse {
660
688
  export interface RenewInstanceResponse {
661
689
  /**
662
690
  * 交易ID。
691
+ * @deprecated
663
692
  */
664
693
  DealId?: string;
694
+ /**
695
+ * 订单号。
696
+ */
697
+ DealName?: string;
665
698
  /**
666
699
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
667
700
  */
@@ -1253,15 +1286,19 @@ export interface DescribeParamTemplatesRequest {
1253
1286
  */
1254
1287
  export interface RenewInstanceRequest {
1255
1288
  /**
1256
- * 购买时长,单位:月。
1289
+ * 购买时长。
1290
+ - 单位:月。
1291
+ - 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
1257
1292
  */
1258
1293
  Period: number;
1259
1294
  /**
1260
- * 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
1295
+ * 实例 ID,请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
1261
1296
  */
1262
1297
  InstanceId: string;
1263
1298
  /**
1264
- * 标识是否修改计费模式。<ul><li>当前实例计费模式为按量计费方式,预转换为包年包月而续费,请指定该参数为 <b>prepaid</b>。</li><li>当前实例计费模式为包年包月方式,可不设置该参数。</li></ul>
1299
+ * 标识是否修改计费模式。
1300
+ - 当前实例计费模式为按量计费方式,预转换为包年包月而续费,请指定该参数为 <b>prepaid</b>。
1301
+ - 当前实例计费模式为包年包月方式,可不设置该参数。
1265
1302
  */
1266
1303
  ModifyPayMode?: string;
1267
1304
  }
@@ -1414,17 +1451,17 @@ export interface ModifyAutoBackupConfigRequest {
1414
1451
  /**
1415
1452
  * 设置自动备份周期。可设置为Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday。该参数暂不支持修改。
1416
1453
  */
1417
- WeekDays: Array<string>;
1454
+ WeekDays?: Array<string>;
1418
1455
  /**
1419
1456
  * 备份时间段。可设置为每个整点。格式如:00:00-01:00, 01:00-02:00...... 23:00-00:00。
1420
1457
  */
1421
- TimePeriod: string;
1458
+ TimePeriod?: string;
1422
1459
  /**
1423
1460
  * 自动备份类型。目前仅能配置为:1 ,指定时备份。
1424
1461
  */
1425
1462
  AutoBackupType?: number;
1426
1463
  /**
1427
- * 全量备份文件保存天数。单位:天。
1464
+ * 全量备份文件保存天数。 仅支持设置为 7,单位:天。如需更长天数,请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。
1428
1465
  */
1429
1466
  BackupStorageDays?: number;
1430
1467
  }
@@ -1474,9 +1511,14 @@ export interface InstanceMultiParam {
1474
1511
  */
1475
1512
  export interface DescribeInstanceDealDetailRequest {
1476
1513
  /**
1477
- * 订单交易ID数组,即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealId。数组最大长度限制为10
1514
+ * 订单号,即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealId。数组最大长度限制为10
1515
+ * @deprecated
1478
1516
  */
1479
- DealIds: Array<string>;
1517
+ DealIds?: Array<string>;
1518
+ /**
1519
+ * 订单号,即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealName。数组最大长度限制为10
1520
+ */
1521
+ DealName?: string;
1480
1522
  }
1481
1523
  /**
1482
1524
  * KillMasterGroup返回参数结构体
@@ -2771,13 +2813,18 @@ export interface SwitchAccessNewInstanceResponse {
2771
2813
  */
2772
2814
  export interface CloneInstancesResponse {
2773
2815
  /**
2774
- * 请求任务 ID。
2816
+ * 交易的ID。
2817
+ * @deprecated
2775
2818
  */
2776
2819
  DealId?: string;
2777
2820
  /**
2778
2821
  * 克隆实例的 ID。
2779
2822
  */
2780
2823
  InstanceIds?: Array<string>;
2824
+ /**
2825
+ * 订单号。
2826
+ */
2827
+ DealName?: string;
2781
2828
  /**
2782
2829
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2783
2830
  */
@@ -3197,12 +3244,17 @@ export interface ChangeReplicaToMasterResponse {
3197
3244
  export interface CreateInstancesResponse {
3198
3245
  /**
3199
3246
  * 交易的ID。
3247
+ * @deprecated
3200
3248
  */
3201
3249
  DealId?: string;
3202
3250
  /**
3203
3251
  * 实例ID。
3204
3252
  */
3205
3253
  InstanceIds?: Array<string>;
3254
+ /**
3255
+ * 订单号。
3256
+ */
3257
+ DealName?: string;
3206
3258
  /**
3207
3259
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3208
3260
  */
@@ -4085,6 +4137,7 @@ export interface DescribeInstanceDTSInstanceInfo {
4085
4137
  export interface TradeDealDetail {
4086
4138
  /**
4087
4139
  * 订单号ID,调用云API时使用此ID
4140
+ * @deprecated
4088
4141
  */
4089
4142
  DealId?: string;
4090
4143
  /**
@@ -4735,8 +4788,13 @@ export interface DescribeBackupDownloadRestrictionResponse {
4735
4788
  export interface UpgradeInstanceResponse {
4736
4789
  /**
4737
4790
  * 订单ID。
4791
+ * @deprecated
4738
4792
  */
4739
4793
  DealId?: string;
4794
+ /**
4795
+ * 订单号。
4796
+ */
4797
+ DealName?: string;
4740
4798
  /**
4741
4799
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4742
4800
  */
@@ -5202,8 +5260,13 @@ export interface DescribeInstanceMonitorTopNCmdTookRequest {
5202
5260
  export interface DestroyPrepaidInstanceResponse {
5203
5261
  /**
5204
5262
  * 订单Id
5263
+ * @deprecated
5205
5264
  */
5206
5265
  DealId?: string;
5266
+ /**
5267
+ * 订单号。
5268
+ */
5269
+ DealName?: string;
5207
5270
  /**
5208
5271
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5209
5272
  */
@@ -5877,7 +5940,34 @@ export interface SwitchProxyRequest {
5877
5940
  /**
5878
5941
  * DescribeInstanceSpecBandwidth请求参数结构体
5879
5942
  */
5880
- export type DescribeInstanceSpecBandwidthRequest = null;
5943
+ export interface DescribeInstanceSpecBandwidthRequest {
5944
+ /**
5945
+ * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。填写实例id或者规格,两者必选其一。
5946
+ */
5947
+ InstanceId?: string;
5948
+ /**
5949
+ * 分片大小,单位:MB
5950
+ */
5951
+ ShardSize?: number;
5952
+ /**
5953
+ * 分片数量。
5954
+ */
5955
+ ShardNum?: number;
5956
+ /**
5957
+ * 复制组数量。
5958
+ */
5959
+ ReplicateNum?: number;
5960
+ /**
5961
+ * 只读权重。
5962
+ - 100:开启从只读。
5963
+ - 0:关闭从只读。
5964
+ */
5965
+ ReadOnlyWeight?: number;
5966
+ /**
5967
+ * 实例类型,同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的Type。
5968
+ */
5969
+ Type?: number;
5970
+ }
5881
5971
  /**
5882
5972
  * SwitchInstanceVip返回参数结构体
5883
5973
  */
@@ -6321,15 +6411,22 @@ export interface UpgradeInstanceRequest {
6321
6411
  */
6322
6412
  InstanceId: string;
6323
6413
  /**
6324
- * 指实例每个分片内存变更后的大小。<ul><li>单位 MB。</li><li>每次只能修改参数MemSize、RedisShardNum和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。</li><li>缩容时,缩容后的规格务必要大于等于使用容量的1.3倍,否则将执行失败。</li></ul>
6414
+ * 指实例每个分片内存变更后的大小。
6415
+ - 单位 MB。
6416
+ - 每次只能修改参数MemSize、RedisShardNum和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
6417
+ - 缩容时,缩容后的规格务必要大于等于使用容量的1.3倍,否则将执行失败。
6325
6418
  */
6326
6419
  MemSize: number;
6327
6420
  /**
6328
- * 指实例变更后的分片数量。<ul><li>标准架构不需要配置该参数,集群架构为必填参数。</li><li>集群架构,每次只能修改参数RedisShardNum、MemSize和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。</li></ul>
6421
+ * 指实例变更后的分片数量。
6422
+ - 标准架构不需要配置该参数,集群架构为必填参数。
6423
+ - 集群架构,每次只能修改参数RedisShardNum、MemSize和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
6329
6424
  */
6330
6425
  RedisShardNum?: number;
6331
6426
  /**
6332
- * 指实例变更后的副本数量。<ul><li>每次只能修改参数RedisReplicasNum、MemSize和RedisShardNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。</li><li>多AZ实例修改副本时必须要传入NodeSet。</li></ul>
6427
+ * 指实例变更后的副本数量。
6428
+ - 每次只能修改参数 RedisReplicasNum、MemSize 和 RedisShardNum 其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
6429
+ - 多AZ实例修改副本时必须要传入 NodeSet。
6333
6430
  */
6334
6431
  RedisReplicasNum?: number;
6335
6432
  /**