tencentcloud-sdk-nodejs-intl-en 3.0.1266 → 3.0.1267

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.
@@ -31,13 +31,13 @@ class UpgradeProxyVersionRequest extends AbstractModel {
31
31
  this.InstanceId = null;
32
32
 
33
33
  /**
34
- * Current Proxy version.
34
+ * Current proxy version. Call the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API to obtain the current proxy version for the instance.
35
35
  * @type {string || null}
36
36
  */
37
37
  this.CurrentProxyVersion = null;
38
38
 
39
39
  /**
40
- * Upgradable Redis version.
40
+ * Upgradable Redis version. Call the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API to obtain the upgradable Redis version for the instance.
41
41
  * @type {string || null}
42
42
  */
43
43
  this.UpgradeProxyVersion = null;
@@ -76,7 +76,7 @@ class RemoveReplicationGroupRequest extends AbstractModel {
76
76
  super();
77
77
 
78
78
  /**
79
- * Replication group ID.
79
+ * Replication group ID. Log in to the [Redis console and go to the global replication](https://console.cloud.tencent.com/redis/replication) page to obtain the ID.
80
80
  * @type {string || null}
81
81
  */
82
82
  this.GroupId = null;
@@ -205,8 +205,7 @@ class EnableReplicaReadonlyRequest extends AbstractModel {
205
205
  /**
206
206
  * Read-only routing policy.
207
207
  - master: read-only routing to the primary node.
208
- - replication: read-only routing to the secondary node.
209
- - Default policy: writing to the primary node and reading from the secondary node.
208
+ - replication: read-only routing to the secondary node. The default value is replication.
210
209
  * @type {Array.<string> || null}
211
210
  */
212
211
  this.ReadonlyPolicy = null;
@@ -550,13 +549,13 @@ class RestoreInstanceRequest extends AbstractModel {
550
549
  super();
551
550
 
552
551
  /**
553
- * ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstances` API.
552
+ * ID of the instance to be operated, which can be obtained through the response parameter InstanceId of the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API.
554
553
  * @type {string || null}
555
554
  */
556
555
  this.InstanceId = null;
557
556
 
558
557
  /**
559
- * Backup ID, which can be obtained through the `backupId` field in the return value of the `GetRedisBackupList` API.
558
+ * Backup ID, which can be obtained through the response parameter RedisBackupSet of the [DescribeInstanceBackups](https://www.tencentcloud.comom/document/product/239/20011?from_cn_redirect=1) API.
560
559
  * @type {string || null}
561
560
  */
562
561
  this.BackupId = null;
@@ -626,7 +625,9 @@ class ApplyParamsTemplateRequest extends AbstractModel {
626
625
  this.InstanceIds = null;
627
626
 
628
627
  /**
629
- * ID of the applied parameter template, which can be obtained through the response parameter **TemplateId** of the API [DescribeParamTemplateInfo](https://intl.cloud.tencent.com/document/product/239/58748?from_cn_redirect=1).
628
+ * ID of the applied parameter template.
629
+ - The parameter template ID can be obtained through the response parameter **TemplateId** of the API [DescribeParamTemplateInfo](https://www.tencentcloud.comom/document/product/239/58748?from_cn_redirect=1).
630
+ - The operation can only be successfully performed when the parameter template version matches the architecture version of the target instance. A version mismatch will trigger an execution error.
630
631
  * @type {string || null}
631
632
  */
632
633
  this.TemplateId = null;
@@ -904,6 +905,12 @@ Node information of an instance. Currently, information about the node type (mas
904
905
  */
905
906
  this.AlarmPolicyList = null;
906
907
 
908
+ /**
909
+ * Whether to encrypt the password.
910
+ * @type {boolean || null}
911
+ */
912
+ this.EncryptPassword = null;
913
+
907
914
  }
908
915
 
909
916
  /**
@@ -955,6 +962,7 @@ Node information of an instance. Currently, information about the node type (mas
955
962
  this.ProductVersion = 'ProductVersion' in params ? params.ProductVersion : null;
956
963
  this.RedisClusterId = 'RedisClusterId' in params ? params.RedisClusterId : null;
957
964
  this.AlarmPolicyList = 'AlarmPolicyList' in params ? params.AlarmPolicyList : null;
965
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
958
966
 
959
967
  }
960
968
  }
@@ -1459,7 +1467,7 @@ class DescribeSecondLevelBackupInfoResponse extends AbstractModel {
1459
1467
 
1460
1468
  /**
1461
1469
  * Timestamp range within which backup is missing.
1462
- Note: This field may return null, indicating that no valid value can be obtained.
1470
+ Note: This field may return null, indicating that no valid values can be obtained.
1463
1471
  * @type {Array.<SecondLevelBackupMissingTimestamps> || null}
1464
1472
  */
1465
1473
  this.MissingTimestamps = null;
@@ -2359,6 +2367,18 @@ class InstanceProxySlowlogDetail extends AbstractModel {
2359
2367
  */
2360
2368
  this.ExecuteTime = null;
2361
2369
 
2370
+ /**
2371
+ * Duration of receiving client requests (ms).
2372
+ * @type {number || null}
2373
+ */
2374
+ this.RecvClientEnd = null;
2375
+
2376
+ /**
2377
+ * Duration of sending client requests (ms).
2378
+ * @type {number || null}
2379
+ */
2380
+ this.SendClientEnd = null;
2381
+
2362
2382
  }
2363
2383
 
2364
2384
  /**
@@ -2373,6 +2393,8 @@ class InstanceProxySlowlogDetail extends AbstractModel {
2373
2393
  this.Command = 'Command' in params ? params.Command : null;
2374
2394
  this.CommandLine = 'CommandLine' in params ? params.CommandLine : null;
2375
2395
  this.ExecuteTime = 'ExecuteTime' in params ? params.ExecuteTime : null;
2396
+ this.RecvClientEnd = 'RecvClientEnd' in params ? params.RecvClientEnd : null;
2397
+ this.SendClientEnd = 'SendClientEnd' in params ? params.SendClientEnd : null;
2376
2398
 
2377
2399
  }
2378
2400
  }
@@ -2485,6 +2507,12 @@ class ClearInstanceRequest extends AbstractModel {
2485
2507
  */
2486
2508
  this.Password = null;
2487
2509
 
2510
+ /**
2511
+ * Whether to encrypt the password.
2512
+ * @type {boolean || null}
2513
+ */
2514
+ this.EncryptPassword = null;
2515
+
2488
2516
  }
2489
2517
 
2490
2518
  /**
@@ -2496,6 +2524,7 @@ class ClearInstanceRequest extends AbstractModel {
2496
2524
  }
2497
2525
  this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
2498
2526
  this.Password = 'Password' in params ? params.Password : null;
2527
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
2499
2528
 
2500
2529
  }
2501
2530
  }
@@ -4125,13 +4154,17 @@ class DescribeInstanceEventsRequest extends AbstractModel {
4125
4154
  this.InstanceId = null;
4126
4155
 
4127
4156
  /**
4128
- * Number of events displayed per page. Default value: 10. Maximum value: 100.
4157
+ * Outputs the number of events displayed per page.
4158
+ - Default value: 10.
4159
+ - Value range: [1, 100].
4129
4160
  * @type {number || null}
4130
4161
  */
4131
4162
  this.PageSize = null;
4132
4163
 
4133
4164
  /**
4134
- * Configures the page number for querying events. You can query events on a certain page by specifying PageNo and PageSize. Default value: 1.
4165
+ * Configures the output page number for querying events. You can query events on a certain page by specifying PageNo (page number) and PageSize (number of output results per page).
4166
+ - Default value: 1.
4167
+ - Value range: positive integers greater than 0.
4135
4168
  * @type {number || null}
4136
4169
  */
4137
4170
  this.PageNo = null;
@@ -4705,7 +4738,7 @@ class CreateParamTemplateRequest extends AbstractModel {
4705
4738
  super();
4706
4739
 
4707
4740
  /**
4708
- * Parameter template name.
4741
+ * Parameter template name, which can contain [2, 64] characters.
4709
4742
  * @type {string || null}
4710
4743
  */
4711
4744
  this.Name = null;
@@ -4718,7 +4751,6 @@ class CreateParamTemplateRequest extends AbstractModel {
4718
4751
 
4719
4752
  /**
4720
4753
  * Product type.
4721
- - 2: Redis 2.8 Memory Edition (standard architecture).
4722
4754
  - 6: Redis 4.0 Memory Edition (standard architecture).
4723
4755
  - 7: Redis 4.0 Memory Edition (cluster architecture).
4724
4756
  - 8: Redis 5.0 Memory Edition (standard architecture).
@@ -4877,48 +4909,56 @@ class ModifyInstanceAccountRequest extends AbstractModel {
4877
4909
  this.InstanceId = null;
4878
4910
 
4879
4911
  /**
4880
- * Sub-account name. If you want to change it to the root account, fill in root.
4912
+ * Specifies the account that needs modification.
4913
+ - root: refers to the automatically generated account when a TencentDB for Redis® instance is created. Users cannot modify read-write permissions for the account, but can only modify its request routing policies.
4914
+ - Custom account: an account manually created by users after successful instance creation. Users can modify read-write permissions and request routing policies for the account at any time.
4881
4915
  * @type {string || null}
4882
4916
  */
4883
4917
  this.AccountName = null;
4884
4918
 
4885
4919
  /**
4886
- * Sub-account password.
4920
+ * Specifies the access password for the account to be modified.
4887
4921
  * @type {string || null}
4888
4922
  */
4889
4923
  this.AccountPassword = null;
4890
4924
 
4891
4925
  /**
4892
- * Sub-account description information
4926
+ * Account description information.
4893
4927
  * @type {string || null}
4894
4928
  */
4895
4929
  this.Remark = null;
4896
4930
 
4897
4931
  /**
4898
- * Account read/write routing policy.
4899
- - master: primary node.
4900
- - replication: secondary node.
4932
+ * Specifies the read-write request routing policies for the account to be modified.
4933
+ - master: read-write request routing to the primary node.
4934
+ - replication: read-write request routing to the secondary node.
4901
4935
  * @type {Array.<string> || null}
4902
4936
  */
4903
4937
  this.ReadonlyPolicy = null;
4904
4938
 
4905
4939
  /**
4906
- * Sub-account read/write policy.
4940
+ * Specifies the read-write permissions for the account to be modified.
4907
4941
  - r: read-only.
4908
4942
  - w: write-only.
4909
- - rw: read/write.
4943
+ - rw: read-write.
4910
4944
  * @type {string || null}
4911
4945
  */
4912
4946
  this.Privilege = null;
4913
4947
 
4914
4948
  /**
4915
- * Whether to switch the root account to a password-free account. This applies only to the root account. Sub-accounts do not support password-free access.
4916
- - true: Switch the root account to a password-free account.
4917
- - false: Do not switch it.
4949
+ * Specifies whether to set the default account (root) to a password-free account. Custom accounts do not support password-free access.
4950
+ - true: set the default account (root) to a password-free account.
4951
+ - false: not set the default account (root) to a password-free account.
4918
4952
  * @type {boolean || null}
4919
4953
  */
4920
4954
  this.NoAuth = null;
4921
4955
 
4956
+ /**
4957
+ * Specifies whether to encrypt the password for the account to be modified.
4958
+ * @type {boolean || null}
4959
+ */
4960
+ this.EncryptPassword = null;
4961
+
4922
4962
  }
4923
4963
 
4924
4964
  /**
@@ -4935,6 +4975,7 @@ class ModifyInstanceAccountRequest extends AbstractModel {
4935
4975
  this.ReadonlyPolicy = 'ReadonlyPolicy' in params ? params.ReadonlyPolicy : null;
4936
4976
  this.Privilege = 'Privilege' in params ? params.Privilege : null;
4937
4977
  this.NoAuth = 'NoAuth' in params ? params.NoAuth : null;
4978
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
4938
4979
 
4939
4980
  }
4940
4981
  }
@@ -4961,6 +5002,7 @@ class ModifyMaintenanceWindowRequest extends AbstractModel {
4961
5002
 
4962
5003
  /**
4963
5004
  * End time of the maintenance window, for example, 19:00.
5005
+ **Note:** Maintenance window duration. Valid values: 30 minutes, 1 hour, 1.5 hours, 2 hours, and 3 hours.
4964
5006
  * @type {string || null}
4965
5007
  */
4966
5008
  this.EndTime = null;
@@ -5536,19 +5578,30 @@ class ResetPasswordRequest extends AbstractModel {
5536
5578
  this.InstanceId = null;
5537
5579
 
5538
5580
  /**
5539
- * Reset password. This parameter can be left blank when a password-free instance is used. It is required in other cases.
5581
+ * Reset password. This parameter can be left unspecified when a password-free instance is used.
5582
+ - It should contain 8 to 32 characters. 12 or more characters are recommended.
5583
+ - It cannot start with a forward slash (/).
5584
+ - It should contain at least two of the following types: lowercase letters, uppercase letters, digits, and special characters (such as ()~!@#$%^&*-+=_|{}[]:;<>,.?/).
5540
5585
  * @type {string || null}
5541
5586
  */
5542
5587
  this.Password = null;
5543
5588
 
5544
5589
  /**
5545
5590
  * Whether to switch to a password-free instance.
5546
- - false: Switch to a non-password-free instance.
5547
- - true: Switch to a password-free instance. Default value: false.
5591
+ - false: switch to an instance that requires a password. The default value is false.
5592
+ - true: switch to a password-free instance.
5548
5593
  * @type {boolean || null}
5549
5594
  */
5550
5595
  this.NoAuth = null;
5551
5596
 
5597
+ /**
5598
+ * Whether to encrypt the password.
5599
+ - false: non-encrypted password. The default value is false.
5600
+ - true: encrypted password.
5601
+ * @type {boolean || null}
5602
+ */
5603
+ this.EncryptPassword = null;
5604
+
5552
5605
  }
5553
5606
 
5554
5607
  /**
@@ -5561,6 +5614,7 @@ class ResetPasswordRequest extends AbstractModel {
5561
5614
  this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
5562
5615
  this.Password = 'Password' in params ? params.Password : null;
5563
5616
  this.NoAuth = 'NoAuth' in params ? params.NoAuth : null;
5617
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
5564
5618
 
5565
5619
  }
5566
5620
  }
@@ -5574,7 +5628,7 @@ class ModifyInstanceAccountResponse extends AbstractModel {
5574
5628
  super();
5575
5629
 
5576
5630
  /**
5577
- * Task ID
5631
+ * Task ID.
5578
5632
  * @type {number || null}
5579
5633
  */
5580
5634
  this.TaskId = null;
@@ -5955,14 +6009,15 @@ class UpgradeVersionToMultiAvailabilityZonesRequest extends AbstractModel {
5955
6009
  super();
5956
6010
 
5957
6011
  /**
5958
- * Instance ID. Log in to the [Redis console](https://console.tencentcloud.com/redis/instance) and copy it in the instance list.
6012
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
5959
6013
  * @type {string || null}
5960
6014
  */
5961
6015
  this.InstanceId = null;
5962
6016
 
5963
6017
  /**
5964
- * Whether to support “Reading Local Nodes Only” feature after upgrading to multi-AZ deployment.
5965
- ul><li>`true`: The “Read Local Nodes Only” feature is supported. During the upgrade, you need to upgrade the proxy version and Redis kernel minor version simultaneously, which will involve data migration and may take hours to complete. </li><li>`false`: The “Read Local Nodes Only” feature is not supported. Upgrading to multi-AZ deployment will involve metadata migration only without affecting the service, which generally take less than three minutes to complete.</li></ul>
6018
+ * Specifies whether the nearby access feature is supported after an upgrade to multi-AZ.
6019
+ - true: support the nearby access feature. The upgrade process requires simultaneous upgrades of the proxy version and Redis kernel minor version, which involves data migration and may take several hours.
6020
+ - false: no need to support the nearby access feature. Upgrade to multi-AZ only involves metadata migration management, with no impact on the service. The upgrade process is usually completed within 3 minutes, and the default value is false.
5966
6021
  * @type {boolean || null}
5967
6022
  */
5968
6023
  this.UpgradeProxyAndRedisServer = null;
@@ -6500,7 +6555,7 @@ class DescribeInstanceAccountRequest extends AbstractModel {
6500
6555
  this.InstanceId = null;
6501
6556
 
6502
6557
  /**
6503
- * Number of entries per page
6558
+ * Pagination size. The default value is 20, the minimum value is 1, and the maximum value is 100.
6504
6559
  * @type {number || null}
6505
6560
  */
6506
6561
  this.Limit = null;
@@ -6653,19 +6708,19 @@ class DescribeInstanceParamRecordsRequest extends AbstractModel {
6653
6708
  super();
6654
6709
 
6655
6710
  /**
6656
- * Instance ID
6711
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
6657
6712
  * @type {string || null}
6658
6713
  */
6659
6714
  this.InstanceId = null;
6660
6715
 
6661
6716
  /**
6662
- * Maximum number of results returned per page
6717
+ * Pagination size. The default value is 100, and the maximum value is 200.
6663
6718
  * @type {number || null}
6664
6719
  */
6665
6720
  this.Limit = null;
6666
6721
 
6667
6722
  /**
6668
- * Offset, which is an integral multiple of `Limit`.
6723
+ * Offset, which is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number – 1). The default value is 0.
6669
6724
  * @type {number || null}
6670
6725
  */
6671
6726
  this.Offset = null;
@@ -6701,7 +6756,7 @@ class DescribeTaskListRequest extends AbstractModel {
6701
6756
  this.InstanceId = null;
6702
6757
 
6703
6758
  /**
6704
- * Instance name
6759
+ * Instance name. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
6705
6760
  * @type {string || null}
6706
6761
  */
6707
6762
  this.InstanceName = null;
@@ -6713,7 +6768,7 @@ class DescribeTaskListRequest extends AbstractModel {
6713
6768
  this.Limit = null;
6714
6769
 
6715
6770
  /**
6716
- * Pagination offset, which is an integral multiple of `Limit`. Calculation formula: `offset` = `limit` * (page number - 1).
6771
+ * Pagination offset, which is an integer multiple of Limit. Offset = Limit x (Page number 1). The default value is 0.
6717
6772
  * @type {number || null}
6718
6773
  */
6719
6774
  this.Offset = null;
@@ -6900,7 +6955,7 @@ class ModifyInstanceEventRequest extends AbstractModel {
6900
6955
  this.InstanceId = null;
6901
6956
 
6902
6957
  /**
6903
- * Event ID. Obtain the ID of the event to be modified using DescribeInstanceEvents.
6958
+ * Event ID. Call the [DescribeInstanceEvents](https://www.tencentcloud.comom/document/product/239/104779?from_cn_redirect=1) API to obtain the ID of the event to be modified.
6904
6959
  * @type {number || null}
6905
6960
  */
6906
6961
  this.EventId = null;
@@ -7253,7 +7308,7 @@ class CloneInstancesRequest extends AbstractModel {
7253
7308
  this.Period = null;
7254
7309
 
7255
7310
  /**
7256
- * Security group ID, which can be obtained on the <b>Security Group</b> page in the console.
7311
+ * Security group ID. Call the [DescribeInstanceSecurityGroup](https://www.tencentcloud.comom/document/product/239/34447?from_cn_redirect=1) API to obtain the security group ID for the instance.
7257
7312
  * @type {Array.<string> || null}
7258
7313
  */
7259
7314
  this.SecurityGroupIdList = null;
@@ -7346,6 +7401,12 @@ Only instances with second-level backup enabled are supported.
7346
7401
  */
7347
7402
  this.CloneTime = null;
7348
7403
 
7404
+ /**
7405
+ * Whether to encrypt the password.
7406
+ * @type {boolean || null}
7407
+ */
7408
+ this.EncryptPassword = null;
7409
+
7349
7410
  }
7350
7411
 
7351
7412
  /**
@@ -7391,6 +7452,7 @@ Only instances with second-level backup enabled are supported.
7391
7452
  this.TemplateId = 'TemplateId' in params ? params.TemplateId : null;
7392
7453
  this.AlarmPolicyList = 'AlarmPolicyList' in params ? params.AlarmPolicyList : null;
7393
7454
  this.CloneTime = 'CloneTime' in params ? params.CloneTime : null;
7455
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
7394
7456
 
7395
7457
  }
7396
7458
  }
@@ -7439,7 +7501,7 @@ class DescribeReplicationGroupRequest extends AbstractModel {
7439
7501
  super();
7440
7502
 
7441
7503
  /**
7442
- * Number of instances returned per page. Default value: `20`.
7504
+ * Size of the output instance list per page. The value is a positive integer greater than 0, and the default value is 20.
7443
7505
  * @type {number || null}
7444
7506
  */
7445
7507
  this.Limit = null;
@@ -7658,7 +7720,7 @@ class DescribeInstanceSecurityGroupRequest extends AbstractModel {
7658
7720
  super();
7659
7721
 
7660
7722
  /**
7661
- * Instance ID list, with the array length ranging from 0 to 100, for example, ["crs-f2ho5rsz\n"].
7723
+ * Instance ID list. The array length limit is [0, 100]. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the instance ID from the instance list.
7662
7724
  * @type {Array.<string> || null}
7663
7725
  */
7664
7726
  this.InstanceIds = null;
@@ -7910,7 +7972,9 @@ class DescribeInstanceShardsRequest extends AbstractModel {
7910
7972
  this.InstanceId = null;
7911
7973
 
7912
7974
  /**
7913
- * Whether to filter out the replica node information. Valid values: `true` (yes), `false` (no).
7975
+ * Specifies whether to filter out secondary node information.
7976
+ - true: filter out secondary nodes.
7977
+ - false: filtering not required. The default value is false.
7914
7978
  * @type {boolean || null}
7915
7979
  */
7916
7980
  this.FilterSlave = null;
@@ -8091,7 +8155,9 @@ class InquiryPriceUpgradeInstanceRequest extends AbstractModel {
8091
8155
  this.MemSize = null;
8092
8156
 
8093
8157
  /**
8094
- * Number of shards. This parameter is not required for Redis 2.8 Primary-Secondary Edition, CKV Primary-Secondary Edition, and Redis 2.8 Single-node Edition.
8158
+ * Number of shards.
8159
+ - The instance adopts the standard architecture. The default value of RedisShardNum is 1.
8160
+ - This parameter is not required for Redis 2.8 Primary-Secondary Edition, CKV Primary-Secondary Edition, and Redis 2.8 Stand-Alone Edition.
8095
8161
  * @type {number || null}
8096
8162
  */
8097
8163
  this.RedisShardNum = null;
@@ -8336,19 +8402,25 @@ class CreateInstanceAccountRequest extends AbstractModel {
8336
8402
  this.ReadonlyPolicy = null;
8337
8403
 
8338
8404
  /**
8339
- * The read/write permission of the account supports the selection of read-only and read/write permissions.
8340
- - r: read-only
8341
- - rw: Read/Write permission.
8405
+ * Read-write permissions of the account. It supports the selection of read-only and read-write permissions.
8406
+ - r: read-only.
8407
+ - rw: read-write.
8342
8408
  * @type {string || null}
8343
8409
  */
8344
8410
  this.Privilege = null;
8345
8411
 
8346
8412
  /**
8347
- * Sub-account description information, with a length of [0, 64] bytes, supports Chinese characters.
8413
+ * Description information about account remarks, with a length of [0, 64] bytes.
8348
8414
  * @type {string || null}
8349
8415
  */
8350
8416
  this.Remark = null;
8351
8417
 
8418
+ /**
8419
+ * Whether to encrypt the password.
8420
+ * @type {boolean || null}
8421
+ */
8422
+ this.EncryptPassword = null;
8423
+
8352
8424
  }
8353
8425
 
8354
8426
  /**
@@ -8364,6 +8436,7 @@ class CreateInstanceAccountRequest extends AbstractModel {
8364
8436
  this.ReadonlyPolicy = 'ReadonlyPolicy' in params ? params.ReadonlyPolicy : null;
8365
8437
  this.Privilege = 'Privilege' in params ? params.Privilege : null;
8366
8438
  this.Remark = 'Remark' in params ? params.Remark : null;
8439
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
8367
8440
 
8368
8441
  }
8369
8442
  }
@@ -8465,9 +8538,10 @@ class ModifyInstanceRequest extends AbstractModel {
8465
8538
 
8466
8539
  /**
8467
8540
  * Instance modification operation. Valid values:
8468
- - rename: Rename the instance.
8469
- - modifyProject: Modify the project to which the instance belongs.
8470
- - modifyAutoRenew: Modify the instance renewal flag.
8541
+ - rename: rename an instance.
8542
+ - modifyProject: modify the project to which the instance belongs.
8543
+ - modifyAutoRenew: modify the instance renewal flag.
8544
+ - modifyDeleteProtectionSwitch: modify the instance deletion protection switch status.
8471
8545
  * @type {string || null}
8472
8546
  */
8473
8547
  this.Operation = null;
@@ -8479,7 +8553,7 @@ class ModifyInstanceRequest extends AbstractModel {
8479
8553
  this.InstanceIds = null;
8480
8554
 
8481
8555
  /**
8482
- * New name of the instance.
8556
+ * New name of the instance. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
8483
8557
  * @type {Array.<string> || null}
8484
8558
  */
8485
8559
  this.InstanceNames = null;
@@ -8500,6 +8574,12 @@ class ModifyInstanceRequest extends AbstractModel {
8500
8574
  */
8501
8575
  this.AutoRenews = null;
8502
8576
 
8577
+ /**
8578
+ * Deletion protection switch. - 0: disabled by default; - 1: enabled.
8579
+ * @type {Array.<number> || null}
8580
+ */
8581
+ this.DeleteProtectionSwitches = null;
8582
+
8503
8583
  /**
8504
8584
  * This parameter is currently being deprecated and can still be used by existing users. It is recommended that new users use InstanceIds.
8505
8585
  * @type {string || null}
@@ -8532,6 +8612,7 @@ class ModifyInstanceRequest extends AbstractModel {
8532
8612
  this.InstanceNames = 'InstanceNames' in params ? params.InstanceNames : null;
8533
8613
  this.ProjectId = 'ProjectId' in params ? params.ProjectId : null;
8534
8614
  this.AutoRenews = 'AutoRenews' in params ? params.AutoRenews : null;
8615
+ this.DeleteProtectionSwitches = 'DeleteProtectionSwitches' in params ? params.DeleteProtectionSwitches : null;
8535
8616
  this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
8536
8617
  this.InstanceName = 'InstanceName' in params ? params.InstanceName : null;
8537
8618
  this.AutoRenew = 'AutoRenew' in params ? params.AutoRenew : null;
@@ -8821,7 +8902,8 @@ class ModifyConnectionConfigRequest extends AbstractModel {
8821
8902
  this.InstanceId = null;
8822
8903
 
8823
8904
  /**
8824
- * Additional bandwidth in MB, which should be greater than 0.
8905
+ * Additional bandwidth, in MB, which should be greater than 0.
8906
+ **Note**: The Bandwidth and ClientLimit parameters cannot be empty simultaneously. You should select at least one of them for configuration.
8825
8907
  * @type {number || null}
8826
8908
  */
8827
8909
  this.Bandwidth = null;
@@ -8830,6 +8912,7 @@ class ModifyConnectionConfigRequest extends AbstractModel {
8830
8912
  * Total number of connections per shard.
8831
8913
  - When read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.
8832
8914
  - When read-only replicas are enabled, the lower limit is 10,000, and the upper limit is calculated as follows: 10,000 x (Number of read-only replicas + 3).
8915
+ **Note**: The Bandwidth and ClientLimit parameters cannot be empty simultaneously. You should select at least one of them for configuration.
8833
8916
  * @type {number || null}
8834
8917
  */
8835
8918
  this.ClientLimit = null;
@@ -9482,7 +9565,7 @@ class CleanUpInstanceRequest extends AbstractModel {
9482
9565
  super();
9483
9566
 
9484
9567
  /**
9485
- * Instance ID. Log in to the [Redis console](https://console.tencentcloud.com/redis/instance) and copy it in the instance list.
9568
+ * Instance ID. Log in to the [Redis console recycle bin](https://console.cloud.tencent.com/redis/recycle), and copy it from the instance list.
9486
9569
  * @type {string || null}
9487
9570
  */
9488
9571
  this.InstanceId = null;
@@ -10006,6 +10089,12 @@ class ModfiyInstancePasswordRequest extends AbstractModel {
10006
10089
  */
10007
10090
  this.Password = null;
10008
10091
 
10092
+ /**
10093
+ * Whether to encrypt the password.
10094
+ * @type {boolean || null}
10095
+ */
10096
+ this.EncryptPassword = null;
10097
+
10009
10098
  }
10010
10099
 
10011
10100
  /**
@@ -10018,6 +10107,7 @@ class ModfiyInstancePasswordRequest extends AbstractModel {
10018
10107
  this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
10019
10108
  this.OldPassword = 'OldPassword' in params ? params.OldPassword : null;
10020
10109
  this.Password = 'Password' in params ? params.Password : null;
10110
+ this.EncryptPassword = 'EncryptPassword' in params ? params.EncryptPassword : null;
10021
10111
 
10022
10112
  }
10023
10113
  }
@@ -10050,19 +10140,19 @@ class DescribeSlowLogRequest extends AbstractModel {
10050
10140
  this.EndTime = null;
10051
10141
 
10052
10142
  /**
10053
- * The average execution time threshold of slow query in microseconds
10143
+ * Average execution time threshold for slow queries, in milliseconds. The value is a positive integer greater than 0
10054
10144
  * @type {number || null}
10055
10145
  */
10056
10146
  this.MinQueryTime = null;
10057
10147
 
10058
10148
  /**
10059
- * Number of slow query logs displayed per page. Default value: 20. Maximum value: 100.
10149
+ * Number of slow query results displayed per page. The default value is 20, the minimum value is 1, and the maximum value is 100.
10060
10150
  * @type {number || null}
10061
10151
  */
10062
10152
  this.Limit = null;
10063
10153
 
10064
10154
  /**
10065
- * Slow query offset, which is an integral multiple of `Limit`. Calculation formula: `offset` = `limit` * (page number - 1).
10155
+ * Offset of the number of slow queries. The value is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number 1). The default value is 0.
10066
10156
  * @type {number || null}
10067
10157
  */
10068
10158
  this.Offset = null;
@@ -10176,7 +10266,7 @@ class DeleteParamTemplateRequest extends AbstractModel {
10176
10266
  super();
10177
10267
 
10178
10268
  /**
10179
- * Parameter template ID.
10269
+ * Parameter template ID. Log in to the [Redis console and go to the parameter template page](https://console.cloud.tencent.com/redis/templates) to obtain the template ID.
10180
10270
  * @type {string || null}
10181
10271
  */
10182
10272
  this.TemplateId = null;
@@ -10275,7 +10365,7 @@ class DestroyPostpaidInstanceRequest extends AbstractModel {
10275
10365
  super();
10276
10366
 
10277
10367
  /**
10278
- * Instance ID. Log in to the [Redis console](https://console.tencentcloud.com/redis/instance) and copy it in the instance list.
10368
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the pay-as-you-go instance ID from the instance list.
10279
10369
  * @type {string || null}
10280
10370
  */
10281
10371
  this.InstanceId = null;
@@ -10347,16 +10437,16 @@ class DescribeInstanceSupportFeatureRequest extends AbstractModel {
10347
10437
  super();
10348
10438
 
10349
10439
  /**
10350
- * Specify the instance ID.
10351
- For example: crs-xjhsdj****. Please log in to the [Redis Console] (https://console.cloud.tencent.com/redis#/) and copy the instance ID from the instance list.
10352
- Sample value: crs-asdasdas.
10440
+ * Specifies the instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis#/), and copy it from the instance list.
10353
10441
  * @type {string || null}
10354
10442
  */
10355
10443
  this.InstanceId = null;
10356
10444
 
10357
10445
  /**
10358
- * Feature names.
10359
- - Read-local-node-only: Proximity access feature.- multi-account: Multiple accounts feature.
10446
+ * The features that support queries are as follows.
10447
+ - read-local-node-only: nearby access.
10448
+ - multi-account: multi-account management.
10449
+ - auto-failback: fault recovery scenario, such as whether automatic failback is enabled for the primary node.
10360
10450
  * @type {string || null}
10361
10451
  */
10362
10452
  this.FeatureName = null;
@@ -10812,7 +10902,7 @@ class InstanceSet extends AbstractModel {
10812
10902
  this.InstanceId = null;
10813
10903
 
10814
10904
  /**
10815
- * App ID of a user, which is an application ID that uniquely corresponds to the account ID. Some Tencent Cloud products use this app ID.
10905
+ * App ID of a user, which is an application ID that uniquely corresponds to the account ID. Certain Tencent Cloud products use this app ID.
10816
10906
 
10817
10907
  * @type {number || null}
10818
10908
  */
@@ -11010,6 +11100,8 @@ class InstanceSet extends AbstractModel {
11010
11100
 
11011
11101
  /**
11012
11102
  * Read weight of a secondary node.
11103
+ - 0: disable read-only replicas.
11104
+ - 100: enable read-only replicas.
11013
11105
  * @type {number || null}
11014
11106
  */
11015
11107
  this.SlaveReadWeight = null;
@@ -11178,6 +11270,12 @@ It is returned only for multi-AZ instances.
11178
11270
  */
11179
11271
  this.BackupMode = null;
11180
11272
 
11273
+ /**
11274
+ * Deletion protection switch. 0: disabled; 1: enabled.
11275
+ * @type {number || null}
11276
+ */
11277
+ this.DeleteProtectionSwitch = null;
11278
+
11181
11279
  }
11182
11280
 
11183
11281
  /**
@@ -11271,6 +11369,7 @@ It is returned only for multi-AZ instances.
11271
11369
  this.UpgradeProxyVersion = 'UpgradeProxyVersion' in params ? params.UpgradeProxyVersion : null;
11272
11370
  this.UpgradeRedisVersion = 'UpgradeRedisVersion' in params ? params.UpgradeRedisVersion : null;
11273
11371
  this.BackupMode = 'BackupMode' in params ? params.BackupMode : null;
11372
+ this.DeleteProtectionSwitch = 'DeleteProtectionSwitch' in params ? params.DeleteProtectionSwitch : null;
11274
11373
 
11275
11374
  }
11276
11375
  }
@@ -11387,6 +11486,12 @@ class CreateReplicationGroupResponse extends AbstractModel {
11387
11486
  */
11388
11487
  this.TaskId = null;
11389
11488
 
11489
+ /**
11490
+ * Replication group ID of the string type.
11491
+ * @type {string || null}
11492
+ */
11493
+ this.GroupId = null;
11494
+
11390
11495
  /**
11391
11496
  * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
11392
11497
  * @type {string || null}
@@ -11403,6 +11508,7 @@ class CreateReplicationGroupResponse extends AbstractModel {
11403
11508
  return;
11404
11509
  }
11405
11510
  this.TaskId = 'TaskId' in params ? params.TaskId : null;
11511
+ this.GroupId = 'GroupId' in params ? params.GroupId : null;
11406
11512
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
11407
11513
 
11408
11514
  }
@@ -11713,19 +11819,22 @@ If `TypeId` indicates the standard architecture, `MemSize` indicates the total m
11713
11819
  this.BillingMode = null;
11714
11820
 
11715
11821
  /**
11716
- * ID of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).
11822
+ * ID of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.comom/document/product/239/4106?from_cn_redirect=1).
11823
+ **Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.
11717
11824
  * @type {number || null}
11718
11825
  */
11719
11826
  this.ZoneId = null;
11720
11827
 
11721
11828
  /**
11722
- * Number of instance shards. For the standard architecture of 2.8, the number of shards does not need to be configured. For the standard architecture of other versions, the number of shards should be set to 1. For the cluster architecture, the number of shards to be purchased needs to be specified.
11829
+ * Number of instance shards.
11830
+ - The number of shards is required to be set to 1 for the standard architecture.
11831
+ - The number of shards can be set to 1, 3, 5, 8, 12, 16, 24, 32, 40, 48, 64, 80, 96, or 128 for the cluster architecture.
11723
11832
  * @type {number || null}
11724
11833
  */
11725
11834
  this.RedisShardNum = null;
11726
11835
 
11727
11836
  /**
11728
- * Number of instance replicas. For the standard architecture of 2.8, the number of replicas does not need to be configured.
11837
+ * Number of instance replicas. Valid values: 1, 2, 3, 4, and 5.
11729
11838
  * @type {number || null}
11730
11839
  */
11731
11840
  this.RedisReplicasNum = null;
@@ -11739,7 +11848,8 @@ If `TypeId` indicates the standard architecture, `MemSize` indicates the total m
11739
11848
  this.ReplicasReadonly = null;
11740
11849
 
11741
11850
  /**
11742
- * Name of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).
11851
+ * Name of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.comom/document/product/239/4106?from_cn_redirect=1).
11852
+ **Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.
11743
11853
  * @type {string || null}
11744
11854
  */
11745
11855
  this.ZoneName = null;
@@ -11956,7 +12066,7 @@ class DescribeSSLStatusRequest extends AbstractModel {
11956
12066
  super();
11957
12067
 
11958
12068
  /**
11959
- * Instance ID
12069
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
11960
12070
  * @type {string || null}
11961
12071
  */
11962
12072
  this.InstanceId = null;
@@ -12215,7 +12325,7 @@ class DescribeInstanceLogDeliveryRequest extends AbstractModel {
12215
12325
  super();
12216
12326
 
12217
12327
  /**
12218
- * Instance ID.
12328
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance), and copy it from the instance list.
12219
12329
  * @type {string || null}
12220
12330
  */
12221
12331
  this.InstanceId = null;
@@ -12249,7 +12359,10 @@ class AddReplicationInstanceRequest extends AbstractModel {
12249
12359
  this.GroupId = null;
12250
12360
 
12251
12361
  /**
12252
- * Instance ID. Log in to the [Redis console](https://console.tencentcloud.com/redis/instance) and copy it in the instance list.
12362
+ * Instance ID.
12363
+ - There are region and AZ limitations for adding a replication group instance. For detailed information, see [Use Limits](https://www.tencentcloud.comom/document/product/239/71934?from_cn_redirect=1).
12364
+ - Currently, only Redis 4.0 and 5.0 cluster architecture instances support being added to the replication groups.
12365
+ - Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the ID of the instance that needs to be added to the replication group in the instance list.
12253
12366
  * @type {string || null}
12254
12367
  */
12255
12368
  this.InstanceId = null;
@@ -12484,19 +12597,19 @@ class DescribeTendisSlowLogRequest extends AbstractModel {
12484
12597
  this.EndTime = null;
12485
12598
 
12486
12599
  /**
12487
- * Slow query threshold in ms
12600
+ * Slow query threshold, in milliseconds. The value is a positive integer greater than 0.
12488
12601
  * @type {number || null}
12489
12602
  */
12490
12603
  this.MinQueryTime = null;
12491
12604
 
12492
12605
  /**
12493
- * Page size. Default value 20. Maximum value 100.
12606
+ * Page size. The default value is 20, the minimum value is 1, and the maximum value is 100.
12494
12607
  * @type {number || null}
12495
12608
  */
12496
12609
  this.Limit = null;
12497
12610
 
12498
12611
  /**
12499
- * Pagination offset, which is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number - 1).
12612
+ * Pagination offset, which is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number 1). The default value is 0.
12500
12613
  * @type {number || null}
12501
12614
  */
12502
12615
  this.Offset = null;
@@ -12548,19 +12661,19 @@ class DescribeProxySlowLogRequest extends AbstractModel {
12548
12661
  this.EndTime = null;
12549
12662
 
12550
12663
  /**
12551
- * Slow query threshold in milliseconds
12664
+ * Slow query threshold, in milliseconds. The value is a positive integer greater than 0.
12552
12665
  * @type {number || null}
12553
12666
  */
12554
12667
  this.MinQueryTime = null;
12555
12668
 
12556
12669
  /**
12557
- * Number of tasks output on each page. Default value: 20. Maximum value: 100.
12670
+ * Size of the output task list per page. The default value is 20, the minimum value is 1, and the maximum value is 100.
12558
12671
  * @type {number || null}
12559
12672
  */
12560
12673
  this.Limit = null;
12561
12674
 
12562
12675
  /**
12563
- * Pagination offset, which is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number - 1).
12676
+ * Pagination offset, which is an integer multiple of Limit. Calculation formula: Offset = Limit x (Page number 1). The default value is 0.
12564
12677
  * @type {number || null}
12565
12678
  */
12566
12679
  this.Offset = null;
@@ -12643,15 +12756,15 @@ class ModifyInstanceBackupModeRequest extends AbstractModel {
12643
12756
  super();
12644
12757
 
12645
12758
  /**
12646
- * Instance ID, which can contain 12 to 36 characters.
12759
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
12647
12760
  * @type {string || null}
12648
12761
  */
12649
12762
  this.InstanceId = null;
12650
12763
 
12651
12764
  /**
12652
12765
  * Backup mode:
12653
- - SecondLevelBackup: second-level backup.
12654
- - NormalLevelBackup: ordinary backup.
12766
+ - SecondLevelBackup: second-level backup.
12767
+ - NormalLevelBackup: ordinary backup.
12655
12768
  * @type {string || null}
12656
12769
  */
12657
12770
  this.BackupMode = null;
@@ -13187,7 +13300,7 @@ class StartupInstanceRequest extends AbstractModel {
13187
13300
  super();
13188
13301
 
13189
13302
  /**
13190
- * Instance ID. Log in to the [Redis console](https://console.tencentcloud.com/redis/instance) and copy it in the instance list.
13303
+ * Instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the ID of the instance to be deisolated from the recycle bin.
13191
13304
  * @type {string || null}
13192
13305
  */
13193
13306
  this.InstanceId = null;
@@ -13334,7 +13447,7 @@ class CreateInstanceAccountResponse extends AbstractModel {
13334
13447
  super();
13335
13448
 
13336
13449
  /**
13337
- * Task ID
13450
+ * Task ID.
13338
13451
  * @type {number || null}
13339
13452
  */
13340
13453
  this.TaskId = null;
@@ -13480,13 +13593,15 @@ class DescribeSecondLevelBackupInfoRequest extends AbstractModel {
13480
13593
  super();
13481
13594
 
13482
13595
  /**
13483
- * Specifies the instance ID. For example, crs-xjhsdj****. Log in to the TencentDB for Redis® console and copy the instance ID from the instance list.
13596
+ * Specifies the instance ID. Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy it from the instance list.
13484
13597
  * @type {string || null}
13485
13598
  */
13486
13599
  this.InstanceId = null;
13487
13600
 
13488
13601
  /**
13489
- * Second-level backup timestamp. The corresponding time should be within the last 7 days.
13602
+ * Second-level backup timestamp.
13603
+ - Setting range: support any second-level time point within 7 days.
13604
+ - Timestamp format: UNIX timestamp.
13490
13605
  * @type {number || null}
13491
13606
  */
13492
13607
  this.BackupTimestamp = null;