tencentcloud-sdk-nodejs-redis 4.0.544 → 4.0.545

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.
@@ -54,44 +54,80 @@ export interface EnableReplicaReadonlyRequest {
54
54
  */
55
55
  export interface RedisBackupSet {
56
56
  /**
57
- * 开始备份的时间
57
+ * 备份开始时间。
58
58
  */
59
59
  StartTime: string;
60
60
  /**
61
- * 备份ID
61
+ * 备份ID
62
62
  */
63
63
  BackupId: string;
64
64
  /**
65
- * 备份类型。1:用户发起的手动备份; 0:凌晨系统发起的备份
66
- */
65
+ * 备份类型。
66
+
67
+ - 1:用户发起的手动备份。
68
+ - 0:凌晨系统发起的备份。
69
+ */
67
70
  BackupType: string;
68
71
  /**
69
- * 备份状态。 1:"备份被其它流程锁定"; 2:"备份正常,没有被任何流程锁定"; -1:"备份已过期"; 3:"备份正在被导出"; 4:"备份导出成功"
70
- */
72
+ * 备份状态。
73
+
74
+ - 1:备份被其它流程锁定。
75
+ - 2:备份正常,没有被任何流程锁定。
76
+ - -1:备份已过期。
77
+ - 3:备份正在被导出。
78
+ - 4:备份导出成功。
79
+ */
71
80
  Status: number;
72
81
  /**
73
- * 备份的备注信息
82
+ * 备份的备注信息。
74
83
  */
75
84
  Remark: string;
76
85
  /**
77
- * 备份是否被锁定,0:未被锁定;1:已被锁定
78
- */
86
+ * 备份是否被锁定。
87
+
88
+ - 0:未被锁定。
89
+ - 1:已被锁定。
90
+ */
79
91
  Locked: number;
80
92
  /**
81
- * 内部字段,用户可忽略
93
+ * 内部字段,用户可忽略。
82
94
  注意:此字段可能返回 null,表示取不到有效值。
83
95
  */
84
96
  BackupSize: number;
85
97
  /**
86
- * 内部字段,用户可忽略
98
+ * 内部字段,用户可忽略。
87
99
  注意:此字段可能返回 null,表示取不到有效值。
88
100
  */
89
101
  FullBackup: number;
90
102
  /**
91
- * 内部字段,用户可忽略
103
+ * 内部字段,用户可忽略。
92
104
  注意:此字段可能返回 null,表示取不到有效值。
93
105
  */
94
106
  InstanceType: number;
107
+ /**
108
+ * 实例 ID。
109
+ */
110
+ InstanceId: string;
111
+ /**
112
+ * 实例名称。
113
+ */
114
+ InstanceName: string;
115
+ /**
116
+ * 本地备份所在地域。
117
+ */
118
+ Region: string;
119
+ /**
120
+ * 备份结束时间。
121
+ */
122
+ EndTime: string;
123
+ /**
124
+ * 备份文件类型。
125
+ */
126
+ FileType: string;
127
+ /**
128
+ * 备份文件过期时间。
129
+ */
130
+ ExpireTime: string;
95
131
  }
96
132
  /**
97
133
  * DescribeInstanceMonitorTopNCmd返回参数结构体
@@ -348,21 +384,25 @@ export interface ModifyConnectionConfigResponse {
348
384
  */
349
385
  export interface ModifyNetworkConfigResponse {
350
386
  /**
351
- * 执行状态:true|false
387
+ * 执行状态,请忽略该参数。
352
388
  */
353
- Status: boolean;
389
+ Status?: boolean;
354
390
  /**
355
- * 子网ID
391
+ * 指实例新私有网络所属子网 ID
356
392
  */
357
- SubnetId: string;
393
+ SubnetId?: string;
358
394
  /**
359
- * 私有网络ID
395
+ * 指实例新的私有网络ID
360
396
  */
361
- VpcId: string;
397
+ VpcId?: string;
362
398
  /**
363
- * VIP地址
399
+ * 指实例新的内网 IPv4 地址。
364
400
  */
365
- Vip: string;
401
+ Vip?: string;
402
+ /**
403
+ * 任务 ID。可获取**taskId**,通过接口 **DescribeTaskInfo **查询任务执行状态。
404
+ */
405
+ TaskId?: number;
366
406
  /**
367
407
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
368
408
  */
@@ -666,9 +706,36 @@ export interface DescribeBackupUrlRequest {
666
706
  */
667
707
  InstanceId: string;
668
708
  /**
669
- * 备份 ID,可通过DescribeInstanceBackups接口返回的参数 BackupSet 获取。
709
+ * 备份 ID,可通过 [DescribeInstanceBackups ](https://cloud.tencent.com/document/product/239/20011)接口返回的参数 RedisBackupSet 获取。
670
710
  */
671
711
  BackupId: string;
712
+ /**
713
+ * 下载备份文件的网络限制类型,如果不配置该参数,则使用用户自定义的配置。
714
+
715
+ - NoLimit:不限制,腾讯云内外网均可以下载备份文件。
716
+ - LimitOnlyIntranet:仅腾讯云自动分配的内网地址可下载备份文件。
717
+ - Customize:指用户自定义的私有网络可下载备份文件。
718
+ */
719
+ LimitType?: string;
720
+ /**
721
+ * 该参数仅支持输入 In,表示自定义的**LimitVpc**可以下载备份文件。
722
+ */
723
+ VpcComparisonSymbol?: string;
724
+ /**
725
+ * 标识自定义的 LimitIp 地址是否可下载备份文件。
726
+
727
+ - In: 自定义的 IP 地址可以下载。默认为 In。
728
+ - NotIn: 自定义的 IP 不可以下载。
729
+ */
730
+ IpComparisonSymbol?: string;
731
+ /**
732
+ * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时,需配置该参数。
733
+ */
734
+ LimitVpc?: Array<BackupLimitVpcItem>;
735
+ /**
736
+ * 自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时,需配置该参数。
737
+ */
738
+ LimitIp?: Array<string>;
672
739
  }
673
740
  /**
674
741
  * DeleteParamTemplate返回参数结构体
@@ -1609,21 +1676,21 @@ export interface DescribeBackupUrlResponse {
1609
1676
  /**
1610
1677
  * 外网下载地址(6小时内链接有效),该字段正在逐步废弃中。
1611
1678
  */
1612
- DownloadUrl: Array<string>;
1679
+ DownloadUrl?: Array<string>;
1613
1680
  /**
1614
1681
  * 内网下载地址(6小时内链接有效),该字段正在逐步废弃中。
1615
1682
  */
1616
- InnerDownloadUrl: Array<string>;
1683
+ InnerDownloadUrl?: Array<string>;
1617
1684
  /**
1618
1685
  * 文件名称,该字段正在逐步废弃中。
1619
1686
  注意:此字段可能返回 null,表示取不到有效值。
1620
1687
  */
1621
- Filenames: Array<string>;
1688
+ Filenames?: Array<string>;
1622
1689
  /**
1623
1690
  * 备份文件信息列表。
1624
1691
  注意:此字段可能返回 null,表示取不到有效值。
1625
1692
  */
1626
- BackupInfos: Array<BackupDownloadInfo>;
1693
+ BackupInfos?: Array<BackupDownloadInfo>;
1627
1694
  /**
1628
1695
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1629
1696
  */
@@ -1683,6 +1750,19 @@ export interface InstanceSecurityGroupDetail {
1683
1750
  */
1684
1751
  SecurityGroupDetails: Array<SecurityGroupDetail>;
1685
1752
  }
1753
+ /**
1754
+ * 自定义的备份文件下载地址的 VPC 信息。
1755
+ */
1756
+ export interface BackupLimitVpcItem {
1757
+ /**
1758
+ * 自定义下载备份文件的VPC 所属地域。
1759
+ */
1760
+ Region: string;
1761
+ /**
1762
+ * 自定义下载备份文件的 VPC 列表。
1763
+ */
1764
+ VpcList: Array<string>;
1765
+ }
1686
1766
  /**
1687
1767
  * UpgradeProxyVersion返回参数结构体
1688
1768
  */
@@ -1784,13 +1864,13 @@ export interface DescribeInstanceMonitorTookDistResponse {
1784
1864
  */
1785
1865
  export interface DescribeInstanceBackupsResponse {
1786
1866
  /**
1787
- * 备份总数
1867
+ * 备份总数。
1788
1868
  */
1789
- TotalCount: number;
1869
+ TotalCount?: number;
1790
1870
  /**
1791
- * 实例的备份数组
1871
+ * 实例的备份数组。
1792
1872
  */
1793
- BackupSet: Array<RedisBackupSet>;
1873
+ BackupSet?: Array<RedisBackupSet>;
1794
1874
  /**
1795
1875
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1796
1876
  */
@@ -2235,29 +2315,41 @@ export interface DescribeInstanceMonitorTopNCmdRequest {
2235
2315
  */
2236
2316
  export interface ModifyNetworkConfigRequest {
2237
2317
  /**
2238
- * 实例ID
2318
+ * 实例 ID
2239
2319
  */
2240
2320
  InstanceId: string;
2241
2321
  /**
2242
- * 操作类型:changeVip——修改实例VIP;changeVpc——修改实例子网;changeBaseToVpc——基础网络转VPC网络
2243
- */
2322
+ * 指预修改网络的类别,包括:
2323
+ - changeVip:指切换私有网络,包含其内网IPv4地址及端口。
2324
+ - changeVpc:指切换私有网络所属子网。
2325
+ - changeBaseToVpc:指基础网络切换为私有网络。
2326
+ - changeVPort:指仅修改实例网络端口。
2327
+ */
2244
2328
  Operation: string;
2245
2329
  /**
2246
- * VIP地址,changeVip的时候填写,不填则默认分配
2330
+ * 指实例私有网络内网 IPv4 地址。当**Operation**为**changeVip**时,需配置该参数。
2247
2331
  */
2248
2332
  Vip?: string;
2249
2333
  /**
2250
- * 私有网络IDchangeVpcchangeBaseToVpc的时候需要提供
2334
+ * 指修改后的私有网络 ID,当**Operation**为**changeVpc**或**changeBaseToVpc**时,需配置该参数。
2251
2335
  */
2252
2336
  VpcId?: string;
2253
2337
  /**
2254
- * 子网IDchangeVpcchangeBaseToVpc的时候需要提供
2338
+ * 指修改后的私有网络所属子网 ID,当**Operation**为**changeVpc**或**changeBaseToVpc**时,需配置该参数。
2255
2339
  */
2256
2340
  SubnetId?: string;
2257
2341
  /**
2258
- * 原VIP保留时间,单位:天,注:需要最新版SDK,否则原VIP立即释放,查看SDK版本,详见 [SDK中心](https://cloud.tencent.com/document/sdk)
2259
- */
2342
+ * 原内网 IPv4 地址保留时长。
2343
+ - 单位:天。
2344
+ - 取值范围:0、1、2、3、7、15。
2345
+
2346
+ **说明**:设置原地址保留时长需最新版SDK,否则原地址将立即释放,查看SDK版本,请参见 [SDK中心](https://cloud.tencent.com/document/sdk)。
2347
+ */
2260
2348
  Recycle?: number;
2349
+ /**
2350
+ * 指修改后的网络端口。当**Operation**为**changeVPort**或**changeVip**时,需配置该参数。取值范围为[1024,65535]。
2351
+ */
2352
+ VPort?: number;
2261
2353
  }
2262
2354
  /**
2263
2355
  * DescribeInstanceSecurityGroup请求参数结构体
@@ -4257,17 +4349,17 @@ export interface CreateInstanceAccountResponse {
4257
4349
  */
4258
4350
  export interface DescribeInstanceBackupsRequest {
4259
4351
  /**
4260
- * 待操作的实例ID,可通过 DescribeInstance 接口返回值中的 InstanceId 获取。
4261
- */
4262
- InstanceId: string;
4263
- /**
4264
- * 实例列表大小,默认大小20
4352
+ * 每页输出的备份列表大小。默认大小为20,最大值为 100。
4265
4353
  */
4266
4354
  Limit?: number;
4267
4355
  /**
4268
- * 偏移量,取Limit整数倍
4356
+ * 分页偏移量,取Limit整数倍。计算公式:offset=limit*(页码-1)。
4269
4357
  */
4270
4358
  Offset?: number;
4359
+ /**
4360
+ * 待操作的实例ID,可通过 DescribeInstance 接口返回值中的 InstanceId 获取。
4361
+ */
4362
+ InstanceId?: string;
4271
4363
  /**
4272
4364
  * 开始时间,格式如:2017-02-08 16:46:34。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。
4273
4365
  */
@@ -4277,9 +4369,19 @@ export interface DescribeInstanceBackupsRequest {
4277
4369
  */
4278
4370
  EndTime?: string;
4279
4371
  /**
4280
- * 1:备份在流程中,2:备份正常,3:备份转RDB文件处理中,4:已完成RDB转换,-1:备份已过期,-2:备份已删除。
4281
- */
4372
+ * 备份任务的状态:
4373
+ 1:备份在流程中。
4374
+ 2:备份正常。
4375
+ 3:备份转RDB文件处理中。
4376
+ 4:已完成RDB转换。
4377
+ -1:备份已过期。
4378
+ -2:备份已删除。
4379
+ */
4282
4380
  Status?: Array<number>;
4381
+ /**
4382
+ * 实例名称,支持根据实例名称模糊搜索。
4383
+ */
4384
+ InstanceName?: string;
4283
4385
  }
4284
4386
  /**
4285
4387
  * 安全组详情