tencentcloud-sdk-redis 3.0.945 → 3.0.946

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a5b6d44415b08a7019dc04f3ca83ccba7a80e83b
4
- data.tar.gz: 8e1cf0bcf0cc2b5efa5ec583def1366fdbc1bb12
3
+ metadata.gz: 7b1b997fbd5b02c933736b7d877003c5567ccb84
4
+ data.tar.gz: fa47c0c6bbf00121db394a3f34f5f66fca20aa42
5
5
  SHA512:
6
- metadata.gz: 21feedd587a77a406bd35995f27afa49718ed9e276fd4ca63b9f16a9fbbbc36067f0079a3b32f9a6c036275a38cf55770b669c92248e9f4e80dcb8ed2dc60dac
7
- data.tar.gz: 26c79a717d77bc87aaba55e8302d48db4eec5cf56b1b7b2b71c43cb2fd6fd525e2f00b7c416037e36b325030ab40d75fe14ef196f86433b690155c92b9773897
6
+ metadata.gz: 6ac55ba63958cde076aa2023d576ac40f04dff746d2ecdb281a51ac8594c0e589c19d4b881c7df71144d6d2d04dd043539bd806d27149176e7e4590bbfe1d501
7
+ data.tar.gz: 85ff19b08171dfd606c3470538e21d61e5770808d0547b961c794f690535dfff243c3fe85323f599fc467c7cc4b23776c17a8753a843473973c99ecf6834281a
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.945
1
+ 3.0.946
@@ -29,7 +29,7 @@ module TencentCloud
29
29
  end
30
30
 
31
31
 
32
- # 添加复制组成员
32
+ # 本接口(AddReplicationInstance)用于为全球复制组添加实例成员。
33
33
 
34
34
  # @param request: Request instance for AddReplicationInstance.
35
35
  # @type request: :class:`Tencentcloud::redis::V20180412::AddReplicationInstanceRequest`
@@ -53,7 +53,7 @@ module TencentCloud
53
53
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
54
54
  end
55
55
 
56
- # 开通外网
56
+ # 本接口(AllocateWanAddress)用于开通实例外网访问。
57
57
 
58
58
  # @param request: Request instance for AllocateWanAddress.
59
59
  # @type request: :class:`Tencentcloud::redis::V20180412::AllocateWanAddressRequest`
@@ -77,7 +77,7 @@ module TencentCloud
77
77
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
78
78
  end
79
79
 
80
- # 应用参数模板到实例
80
+ # 本接口(ApplyParamsTemplate)用于应用参数模板到实例。
81
81
 
82
82
  # @param request: Request instance for ApplyParamsTemplate.
83
83
  # @type request: :class:`Tencentcloud::redis::V20180412::ApplyParamsTemplateRequest`
@@ -125,7 +125,7 @@ module TencentCloud
125
125
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
126
126
  end
127
127
 
128
- # 复制组实例更换角色
128
+ # 本接口(ChangeInstanceRole)用于更换复制组内实例的角色。
129
129
 
130
130
  # @param request: Request instance for ChangeInstanceRole.
131
131
  # @type request: :class:`Tencentcloud::redis::V20180412::ChangeInstanceRoleRequest`
@@ -197,7 +197,7 @@ module TencentCloud
197
197
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
198
198
  end
199
199
 
200
- # 回收站实例立即下线
200
+ # 本接口(CleanUpInstance)用于立即下线回收站的实例。
201
201
 
202
202
  # @param request: Request instance for CleanUpInstance.
203
203
  # @type request: :class:`Tencentcloud::redis::V20180412::CleanUpInstanceRequest`
@@ -221,7 +221,7 @@ module TencentCloud
221
221
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
222
222
  end
223
223
 
224
- # 清空Redis实例的实例数据。
224
+ # 本接口(ClearInstance)用于清空实例数据。
225
225
 
226
226
  # @param request: Request instance for ClearInstance.
227
227
  # @type request: :class:`Tencentcloud::redis::V20180412::ClearInstanceRequest`
@@ -269,7 +269,7 @@ module TencentCloud
269
269
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
270
270
  end
271
271
 
272
- # 关闭SSL
272
+ # 本接口(CloseSSL)用于关闭SSL加密认证。
273
273
 
274
274
  # @param request: Request instance for CloseSSL.
275
275
  # @type request: :class:`Tencentcloud::redis::V20180412::CloseSSLRequest`
@@ -293,7 +293,7 @@ module TencentCloud
293
293
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
294
294
  end
295
295
 
296
- # 该接口(CreateInstanceAccount)用于自定义访问实例的账号。
296
+ # 本接口(CreateInstanceAccount)用于自定义访问实例的账号。
297
297
 
298
298
  # @param request: Request instance for CreateInstanceAccount.
299
299
  # @type request: :class:`Tencentcloud::redis::V20180412::CreateInstanceAccountRequest`
@@ -365,7 +365,7 @@ module TencentCloud
365
365
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
366
366
  end
367
367
 
368
- # 该接口(CreateReplicationGroup)用于创建复制组。
368
+ # 本接口(CreateReplicationGroup)用于创建复制组。
369
369
 
370
370
  # @param request: Request instance for CreateReplicationGroup.
371
371
  # @type request: :class:`Tencentcloud::redis::V20180412::CreateReplicationGroupRequest`
@@ -389,7 +389,7 @@ module TencentCloud
389
389
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
390
390
  end
391
391
 
392
- # 删除实例子账号
392
+ # 本接口(DeleteInstanceAccount)用于删除实例子账号。
393
393
 
394
394
  # @param request: Request instance for DeleteInstanceAccount.
395
395
  # @type request: :class:`Tencentcloud::redis::V20180412::DeleteInstanceAccountRequest`
@@ -437,7 +437,7 @@ module TencentCloud
437
437
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
438
438
  end
439
439
 
440
- # 移除复制组成员。注:该接口下线中,请使用 [RemoveReplicationInstance](https://cloud.tencent.com/document/product/239/90099)。
440
+ # 本接口(DeleteReplicationInstance)移除复制组成员。注:该接口下线中,请使用 [RemoveReplicationInstance](https://cloud.tencent.com/document/product/239/90099)。
441
441
 
442
442
  # @param request: Request instance for DeleteReplicationInstance.
443
443
  # @type request: :class:`Tencentcloud::redis::V20180412::DeleteReplicationInstanceRequest`
@@ -581,7 +581,7 @@ module TencentCloud
581
581
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
582
582
  end
583
583
 
584
- # 查询Redis实例列表信息。该接口已废弃。
584
+ # 本接口(DescribeCommonDBInstances)用于查询Redis实例列表信息。当前该接口已废弃。
585
585
 
586
586
  # @param request: Request instance for DescribeCommonDBInstances.
587
587
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeCommonDBInstancesRequest`
@@ -701,7 +701,7 @@ module TencentCloud
701
701
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
702
702
  end
703
703
 
704
- # 查询实例DTS信息
704
+ # 本接口(DescribeInstanceDTSInfo)用于查询实例 DTS 信息。
705
705
 
706
706
  # @param request: Request instance for DescribeInstanceDTSInfo.
707
707
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeInstanceDTSInfoRequest`
@@ -917,7 +917,7 @@ module TencentCloud
917
917
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
918
918
  end
919
919
 
920
- # 查询实例访问的耗时分布
920
+ # 本接口(DescribeInstanceMonitorTookDist)用于查询实例访问的耗时分布。
921
921
 
922
922
  # @param request: Request instance for DescribeInstanceMonitorTookDist.
923
923
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeInstanceMonitorTookDistRequest`
@@ -965,7 +965,7 @@ module TencentCloud
965
965
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
966
966
  end
967
967
 
968
- # 查询实例CPU耗时
968
+ # 本接口(DescribeInstanceMonitorTopNCmdTook)用于查询实例 CPU 耗时。
969
969
 
970
970
  # @param request: Request instance for DescribeInstanceMonitorTopNCmdTook.
971
971
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeInstanceMonitorTopNCmdTookRequest`
@@ -1301,7 +1301,7 @@ module TencentCloud
1301
1301
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1302
1302
  end
1303
1303
 
1304
- # 查询项目安全组信息
1304
+ # 本接口(DescribeProjectSecurityGroup)用于查询项目安全组信息。
1305
1305
 
1306
1306
  # @param request: Request instance for DescribeProjectSecurityGroup.
1307
1307
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeProjectSecurityGroupRequest`
@@ -1325,7 +1325,7 @@ module TencentCloud
1325
1325
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1326
1326
  end
1327
1327
 
1328
- # 本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。
1328
+ # 本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。
1329
1329
 
1330
1330
  # @param request: Request instance for DescribeProjectSecurityGroups.
1331
1331
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeProjectSecurityGroupsRequest`
@@ -1373,7 +1373,7 @@ module TencentCloud
1373
1373
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1374
1374
  end
1375
1375
 
1376
- # 查询Redis独享集群概览信息
1376
+ # 本接口(DescribeRedisClusterOverview)用于查询 Redis 独享集群概览信息。
1377
1377
 
1378
1378
  # @param request: Request instance for DescribeRedisClusterOverview.
1379
1379
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeRedisClusterOverviewRequest`
@@ -1397,7 +1397,7 @@ module TencentCloud
1397
1397
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1398
1398
  end
1399
1399
 
1400
- # 查询Redis独享集群列表
1400
+ # 本接口(DescribeRedisClusters)用于查询Redis独享集群列表。
1401
1401
 
1402
1402
  # @param request: Request instance for DescribeRedisClusters.
1403
1403
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeRedisClustersRequest`
@@ -1445,7 +1445,7 @@ module TencentCloud
1445
1445
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1446
1446
  end
1447
1447
 
1448
- # 查询复制组信息
1448
+ # 本接口(DescribeReplicationGroupInstance)用于查询复制组信息。
1449
1449
 
1450
1450
  # @param request: Request instance for DescribeReplicationGroupInstance.
1451
1451
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeReplicationGroupInstanceRequest`
@@ -1567,7 +1567,7 @@ module TencentCloud
1567
1567
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1568
1568
  end
1569
1569
 
1570
- # 查询Tendis慢查询
1570
+ # 本接口(DescribeTendisSlowLog)用于查询 Tendis 实例慢查询。
1571
1571
 
1572
1572
  # @param request: Request instance for DescribeTendisSlowLog.
1573
1573
  # @type request: :class:`Tencentcloud::redis::V20180412::DescribeTendisSlowLogRequest`
@@ -1591,7 +1591,7 @@ module TencentCloud
1591
1591
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1592
1592
  end
1593
1593
 
1594
- # 按量计费实例销毁
1594
+ # 本接口(DestroyPostpaidInstance)用于销毁按量计费实例。
1595
1595
 
1596
1596
  # @param request: Request instance for DestroyPostpaidInstance.
1597
1597
  # @type request: :class:`Tencentcloud::redis::V20180412::DestroyPostpaidInstanceRequest`
@@ -1615,7 +1615,7 @@ module TencentCloud
1615
1615
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1616
1616
  end
1617
1617
 
1618
- # 包年包月实例退还
1618
+ # 本接口(DestroyPrepaidInstance)用于退还包年包月计费的 Redis 实例。
1619
1619
 
1620
1620
  # @param request: Request instance for DestroyPrepaidInstance.
1621
1621
  # @type request: :class:`Tencentcloud::redis::V20180412::DestroyPrepaidInstanceRequest`
@@ -1639,7 +1639,7 @@ module TencentCloud
1639
1639
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1640
1640
  end
1641
1641
 
1642
- # 禁用读写分离
1642
+ # 本接口(DisableReplicaReadonly)用于禁用读写分离功能。
1643
1643
 
1644
1644
  # @param request: Request instance for DisableReplicaReadonly.
1645
1645
  # @type request: :class:`Tencentcloud::redis::V20180412::DisableReplicaReadonlyRequest`
@@ -1663,7 +1663,7 @@ module TencentCloud
1663
1663
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1664
1664
  end
1665
1665
 
1666
- # 本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。
1666
+ # 本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。
1667
1667
 
1668
1668
  # @param request: Request instance for DisassociateSecurityGroups.
1669
1669
  # @type request: :class:`Tencentcloud::redis::V20180412::DisassociateSecurityGroupsRequest`
@@ -1687,7 +1687,7 @@ module TencentCloud
1687
1687
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1688
1688
  end
1689
1689
 
1690
- # 启用读写分离
1690
+ # 本接口(EnableReplicaReadonly)用于启用读写分离功能。
1691
1691
 
1692
1692
  # @param request: Request instance for EnableReplicaReadonly.
1693
1693
  # @type request: :class:`Tencentcloud::redis::V20180412::EnableReplicaReadonlyRequest`
@@ -1711,7 +1711,7 @@ module TencentCloud
1711
1711
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1712
1712
  end
1713
1713
 
1714
- # 查询新购实例价格
1714
+ # 本接口(InquiryPriceCreateInstance)用于查询新购实例价格。
1715
1715
 
1716
1716
  # @param request: Request instance for InquiryPriceCreateInstance.
1717
1717
  # @type request: :class:`Tencentcloud::redis::V20180412::InquiryPriceCreateInstanceRequest`
@@ -1759,7 +1759,7 @@ module TencentCloud
1759
1759
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1760
1760
  end
1761
1761
 
1762
- # 查询实例扩容价格
1762
+ # 本接口(InquiryPriceUpgradeInstance)用于查询实例扩容价格。
1763
1763
 
1764
1764
  # @param request: Request instance for InquiryPriceUpgradeInstance.
1765
1765
  # @type request: :class:`Tencentcloud::redis::V20180412::InquiryPriceUpgradeInstanceRequest`
@@ -1783,7 +1783,7 @@ module TencentCloud
1783
1783
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1784
1784
  end
1785
1785
 
1786
- # 本接口(KillMasterGroup)模拟故障。
1786
+ # 本接口(KillMasterGroup)用于模拟故障。
1787
1787
 
1788
1788
  # @param request: Request instance for KillMasterGroup.
1789
1789
  # @type request: :class:`Tencentcloud::redis::V20180412::KillMasterGroupRequest`
@@ -1903,7 +1903,7 @@ module TencentCloud
1903
1903
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1904
1904
  end
1905
1905
 
1906
- # 修改实例的连接配置,包括带宽和最大连接数。
1906
+ # 本接口(ModifyConnectionConfig)用于修改实例的连接配置,包括带宽和最大连接数。
1907
1907
 
1908
1908
  # @param request: Request instance for ModifyConnectionConfig.
1909
1909
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyConnectionConfigRequest`
@@ -1951,7 +1951,7 @@ module TencentCloud
1951
1951
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1952
1952
  end
1953
1953
 
1954
- # 修改实例相关信息
1954
+ # 本接口(ModifyInstance)用于修改实例相关信息。
1955
1955
 
1956
1956
  # @param request: Request instance for ModifyInstance.
1957
1957
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyInstanceRequest`
@@ -1975,7 +1975,7 @@ module TencentCloud
1975
1975
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1976
1976
  end
1977
1977
 
1978
- # 修改实例子账号
1978
+ # 本接口(ModifyInstanceAccount)用于修改实例子账号。
1979
1979
 
1980
1980
  # @param request: Request instance for ModifyInstanceAccount.
1981
1981
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyInstanceAccountRequest`
@@ -2071,7 +2071,7 @@ module TencentCloud
2071
2071
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2072
2072
  end
2073
2073
 
2074
- # 本接口(ModifyInstanceParams)用于修改Redis实例的参数配置。
2074
+ # 本接口(ModifyInstanceParams)用于修改 Redis 实例的参数配置。
2075
2075
 
2076
2076
  # @param request: Request instance for ModifyInstanceParams.
2077
2077
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyInstanceParamsRequest`
@@ -2119,7 +2119,7 @@ module TencentCloud
2119
2119
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2120
2120
  end
2121
2121
 
2122
- # 设置实例输入模式
2122
+ # 本接口(ModifyInstanceReadOnly)用于设置实例输入模式。
2123
2123
 
2124
2124
  # @param request: Request instance for ModifyInstanceReadOnly.
2125
2125
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyInstanceReadOnlyRequest`
@@ -2143,7 +2143,7 @@ module TencentCloud
2143
2143
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2144
2144
  end
2145
2145
 
2146
- # 修改实例维护时间窗时间,需要进行版本升级或者架构升级的实例,会在维护时间窗内进行时间切换。注意:已经发起版本升级或者架构升级的实例,无法修改维护时间窗。
2146
+ # 本接口(ModifyMaintenanceWindow)用于修改实例维护时间窗时间,需要进行版本升级或者架构升级的实例,会在维护时间窗内进行时间切换。注意:已经发起版本升级或者架构升级的实例,无法修改维护时间窗。
2147
2147
 
2148
2148
  # @param request: Request instance for ModifyMaintenanceWindow.
2149
2149
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyMaintenanceWindowRequest`
@@ -2191,7 +2191,7 @@ module TencentCloud
2191
2191
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2192
2192
  end
2193
2193
 
2194
- # 修改参数模板
2194
+ # 本接口(ModifyParamTemplate)用于修改参数模板。
2195
2195
 
2196
2196
  # @param request: Request instance for ModifyParamTemplate.
2197
2197
  # @type request: :class:`Tencentcloud::redis::V20180412::ModifyParamTemplateRequest`
@@ -2239,7 +2239,7 @@ module TencentCloud
2239
2239
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2240
2240
  end
2241
2241
 
2242
- # 开启SSL
2242
+ # 本接口(OpenSSL)用于开启 SSL 加密认证功能。
2243
2243
 
2244
2244
  # @param request: Request instance for OpenSSL.
2245
2245
  # @type request: :class:`Tencentcloud::redis::V20180412::OpenSSLRequest`
@@ -2263,7 +2263,7 @@ module TencentCloud
2263
2263
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2264
2264
  end
2265
2265
 
2266
- # 关闭外网
2266
+ # 本接口(ReleaseWanAddress)用于关闭外网访问。
2267
2267
 
2268
2268
  # @param request: Request instance for ReleaseWanAddress.
2269
2269
  # @type request: :class:`Tencentcloud::redis::V20180412::ReleaseWanAddressRequest`
@@ -2287,7 +2287,7 @@ module TencentCloud
2287
2287
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2288
2288
  end
2289
2289
 
2290
- # 移除复制组成员
2290
+ # 本接口(RemoveReplicationInstance)用于移除复制组中的实例。
2291
2291
 
2292
2292
  # @param request: Request instance for RemoveReplicationInstance.
2293
2293
  # @type request: :class:`Tencentcloud::redis::V20180412::RemoveReplicationInstanceRequest`
@@ -2335,7 +2335,7 @@ module TencentCloud
2335
2335
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2336
2336
  end
2337
2337
 
2338
- # 重置密码
2338
+ # 本接口(ResetPassword)用于重置实例访问密码。
2339
2339
 
2340
2340
  # @param request: Request instance for ResetPassword.
2341
2341
  # @type request: :class:`Tencentcloud::redis::V20180412::ResetPasswordRequest`
@@ -2383,7 +2383,7 @@ module TencentCloud
2383
2383
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2384
2384
  end
2385
2385
 
2386
- # 实例解隔离
2386
+ # 本接口(StartupInstance)用于实例解隔离。
2387
2387
 
2388
2388
  # @param request: Request instance for StartupInstance.
2389
2389
  # @type request: :class:`Tencentcloud::redis::V20180412::StartupInstanceRequest`
@@ -2431,7 +2431,7 @@ module TencentCloud
2431
2431
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2432
2432
  end
2433
2433
 
2434
- # 在通过DTS支持跨可用区灾备的场景中,通过该接口交换实例VIP完成实例灾备切换。交换VIP后目标实例可写,源和目标实例VIP互换,同时源与目标实例间DTS同步任务断开
2434
+ # 在通过 DTS 支持跨可用区灾备的场景中,通过该接口(SwitchInstanceVip)交换实例 VIP 完成实例灾备切换。交换 VIP 后目标实例可写,源和目标实例VIP互换,同时源与目标实例间 DTS 同步任务断开。
2435
2435
 
2436
2436
  # @param request: Request instance for SwitchInstanceVip.
2437
2437
  # @type request: :class:`Tencentcloud::redis::V20180412::SwitchInstanceVipRequest`
@@ -2455,7 +2455,7 @@ module TencentCloud
2455
2455
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2456
2456
  end
2457
2457
 
2458
- # Proxy模拟故障接口
2458
+ # 本接口(SwitchProxy)为 Proxy 模拟故障接口。
2459
2459
 
2460
2460
  # @param request: Request instance for SwitchProxy.
2461
2461
  # @type request: :class:`Tencentcloud::redis::V20180412::SwitchProxyRequest`
@@ -2503,7 +2503,7 @@ module TencentCloud
2503
2503
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2504
2504
  end
2505
2505
 
2506
- # 将当前实例升级到更高版本,或者将当前标准架构升级至集群架构。
2506
+ # 本接口(UpgradeInstanceVersion)用于将当前实例升级到更高版本,或者将当前标准架构升级至集群架构。
2507
2507
 
2508
2508
  # @param request: Request instance for UpgradeInstanceVersion.
2509
2509
  # @type request: :class:`Tencentcloud::redis::V20180412::UpgradeInstanceVersionRequest`
@@ -2527,7 +2527,7 @@ module TencentCloud
2527
2527
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2528
2528
  end
2529
2529
 
2530
- # 实例proxy版本升级
2530
+ # 本接口(UpgradeProxyVersion)用于升级实例 Proxy 版本。
2531
2531
 
2532
2532
  # @param request: Request instance for UpgradeProxyVersion.
2533
2533
  # @type request: :class:`Tencentcloud::redis::V20180412::UpgradeProxyVersionRequest`
@@ -2551,7 +2551,7 @@ module TencentCloud
2551
2551
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2552
2552
  end
2553
2553
 
2554
- # 实例小版本升级
2554
+ # 本接口(UpgradeSmallVersion)用于实例小版本升级。
2555
2555
 
2556
2556
  # @param request: Request instance for UpgradeSmallVersion.
2557
2557
  # @type request: :class:`Tencentcloud::redis::V20180412::UpgradeSmallVersionRequest`
@@ -2575,7 +2575,7 @@ module TencentCloud
2575
2575
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2576
2576
  end
2577
2577
 
2578
- # 升级实例支持多AZ
2578
+ # 本接口(UpgradeVersionToMultiAvailabilityZones)用于升级实例支持多AZ
2579
2579
 
2580
2580
  # @param request: Request instance for UpgradeVersionToMultiAvailabilityZones.
2581
2581
  # @type request: :class:`Tencentcloud::redis::V20180412::UpgradeVersionToMultiAvailabilityZonesRequest`
@@ -74,9 +74,9 @@ module TencentCloud
74
74
 
75
75
  # AddReplicationInstance请求参数结构体
76
76
  class AddReplicationInstanceRequest < TencentCloud::Common::AbstractModel
77
- # @param GroupId: 复制组ID。
77
+ # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID
78
78
  # @type GroupId: String
79
- # @param InstanceId: 实例ID。
79
+ # @param InstanceId: 实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
80
80
  # @type InstanceId: String
81
81
  # @param InstanceRole: 给复制组添加的实例分配角色。<ul><li>rw:可读写。</li><li>r:只读。</li></ul>
82
82
  # @type InstanceRole: String
@@ -118,7 +118,7 @@ module TencentCloud
118
118
 
119
119
  # AllocateWanAddress请求参数结构体
120
120
  class AllocateWanAddressRequest < TencentCloud::Common::AbstractModel
121
- # @param InstanceId: 实例ID
121
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
122
122
  # @type InstanceId: String
123
123
 
124
124
  attr_accessor :InstanceId
@@ -158,9 +158,9 @@ module TencentCloud
158
158
 
159
159
  # ApplyParamsTemplate请求参数结构体
160
160
  class ApplyParamsTemplateRequest < TencentCloud::Common::AbstractModel
161
- # @param InstanceIds: 实例ID列表
161
+ # @param InstanceIds: 实例 ID 列表,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
162
162
  # @type InstanceIds: Array
163
- # @param TemplateId: 应用的参数模板ID
163
+ # @param TemplateId: 应用的参数模板ID,请通过接口[DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748)的返回参数 **TemplateId** 获取参数模板 ID。
164
164
  # @type TemplateId: String
165
165
 
166
166
  attr_accessor :InstanceIds, :TemplateId
@@ -200,9 +200,9 @@ module TencentCloud
200
200
  class AssociateSecurityGroupsRequest < TencentCloud::Common::AbstractModel
201
201
  # @param Product: 数据库引擎名称,本接口取值:redis。
202
202
  # @type Product: String
203
- # @param SecurityGroupId: 要绑定的安全组ID,类似sg-efil73jd
203
+ # @param SecurityGroupId: 要绑定的安全组ID,请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID
204
204
  # @type SecurityGroupId: String
205
- # @param InstanceIds: 被绑定的实例ID,类似ins-lesecurk,支持指定多个实例。
205
+ # @param InstanceIds: 被绑定的实例ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID,支持指定多个实例。
206
206
  # @type InstanceIds: Array
207
207
 
208
208
  attr_accessor :Product, :SecurityGroupId, :InstanceIds
@@ -450,11 +450,13 @@ module TencentCloud
450
450
 
451
451
  # ChangeInstanceRole请求参数结构体
452
452
  class ChangeInstanceRoleRequest < TencentCloud::Common::AbstractModel
453
- # @param GroupId: 复制组ID
453
+ # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。
454
454
  # @type GroupId: String
455
- # @param InstanceId: 实例ID
455
+ # @param InstanceId: 实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
456
456
  # @type InstanceId: String
457
- # @param InstanceRole: 实例角色,rw可读写,r只读
457
+ # @param InstanceRole: 实例角色。
458
+ # - rw:可读写。
459
+ # - r:只读。
458
460
  # @type InstanceRole: String
459
461
 
460
462
  attr_accessor :GroupId, :InstanceId, :InstanceRole
@@ -581,7 +583,7 @@ module TencentCloud
581
583
 
582
584
  # CleanUpInstance请求参数结构体
583
585
  class CleanUpInstanceRequest < TencentCloud::Common::AbstractModel
584
- # @param InstanceId: 实例ID
586
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
585
587
  # @type InstanceId: String
586
588
 
587
589
  attr_accessor :InstanceId
@@ -617,9 +619,11 @@ module TencentCloud
617
619
 
618
620
  # ClearInstance请求参数结构体
619
621
  class ClearInstanceRequest < TencentCloud::Common::AbstractModel
620
- # @param InstanceId: 实例ID
622
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
621
623
  # @type InstanceId: String
622
- # @param Password: redis的实例密码(免密实例不需要传密码,非免密实例必传)
624
+ # @param Password: 实例访问密码。
625
+ # - 免密访问:无需配置。
626
+ # - 密码认证:必须配置。字符个数为[8,64],至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。
623
627
  # @type Password: String
624
628
 
625
629
  attr_accessor :InstanceId, :Password
@@ -792,7 +796,7 @@ module TencentCloud
792
796
 
793
797
  # CloseSSL请求参数结构体
794
798
  class CloseSSLRequest < TencentCloud::Common::AbstractModel
795
- # @param InstanceId: 实例ID。
799
+ # @param InstanceId: 实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID
796
800
  # @type InstanceId: String
797
801
 
798
802
  attr_accessor :InstanceId
@@ -848,9 +852,9 @@ module TencentCloud
848
852
 
849
853
  # CreateInstanceAccount请求参数结构体
850
854
  class CreateInstanceAccountRequest < TencentCloud::Common::AbstractModel
851
- # @param InstanceId: 实例 ID。
855
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID
852
856
  # @type InstanceId: String
853
- # @param AccountName: 自定义访问数据库的名称。
857
+ # @param AccountName: 自定义的访问数据库的账号名称。
854
858
  # - 仅由字母、数字、下划线、中划线组成。
855
859
  # - 长度不能大于32位。
856
860
  # @type AccountName: String
@@ -1170,9 +1174,9 @@ module TencentCloud
1170
1174
 
1171
1175
  # CreateReplicationGroup请求参数结构体
1172
1176
  class CreateReplicationGroupRequest < TencentCloud::Common::AbstractModel
1173
- # @param InstanceId: 指定复制组中的主实例ID。
1177
+ # @param InstanceId: 指定复制组中的主实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID
1174
1178
  # @type InstanceId: String
1175
- # @param GroupName: 复制组名称。名称只支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。
1179
+ # @param GroupName: 配置复制组名称。仅支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。
1176
1180
  # @type GroupName: String
1177
1181
  # @param Remark: 备注信息。
1178
1182
  # @type Remark: String
@@ -1244,9 +1248,9 @@ module TencentCloud
1244
1248
 
1245
1249
  # DeleteInstanceAccount请求参数结构体
1246
1250
  class DeleteInstanceAccountRequest < TencentCloud::Common::AbstractModel
1247
- # @param InstanceId: 实例ID
1251
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
1248
1252
  # @type InstanceId: String
1249
- # @param AccountName: 子账号名称
1253
+ # @param AccountName: 子账号名称。请登录[Redis控制台](https://console.cloud.tencent.com/redis),切换至**账号管理**页面获取。具体信息,请参见[管理账号](https://cloud.tencent.com/document/product/239/36710)。
1250
1254
  # @type AccountName: String
1251
1255
 
1252
1256
  attr_accessor :InstanceId, :AccountName
@@ -1316,11 +1320,13 @@ module TencentCloud
1316
1320
 
1317
1321
  # DeleteReplicationInstance请求参数结构体
1318
1322
  class DeleteReplicationInstanceRequest < TencentCloud::Common::AbstractModel
1319
- # @param GroupId: 复制组ID
1323
+ # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。
1320
1324
  # @type GroupId: String
1321
- # @param InstanceId: 实例ID
1325
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
1322
1326
  # @type InstanceId: String
1323
- # @param SyncType: 数据同步类型,true:需要数据强同步,false:不需要强同步,仅限删除主实例
1327
+ # @param SyncType: 数据同步类型。
1328
+ # - true:需要数据强同步。
1329
+ # - false:不需要强同步,仅限删除主实例。
1324
1330
  # @type SyncType: Boolean
1325
1331
 
1326
1332
  attr_accessor :GroupId, :InstanceId, :SyncType
@@ -1412,7 +1418,7 @@ module TencentCloud
1412
1418
 
1413
1419
  # DescribeBackupDetail请求参数结构体
1414
1420
  class DescribeBackupDetailRequest < TencentCloud::Common::AbstractModel
1415
- # @param InstanceId: 实例 ID。
1421
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
1416
1422
  # @type InstanceId: String
1417
1423
  # @param BackupId: 备份 ID,可通过接口 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 返回的参数 **RedisBackupSet** 获取。
1418
1424
  # @type BackupId: String
@@ -1662,7 +1668,7 @@ module TencentCloud
1662
1668
 
1663
1669
  # DescribeBandwidthRange请求参数结构体
1664
1670
  class DescribeBandwidthRangeRequest < TencentCloud::Common::AbstractModel
1665
- # @param InstanceId: 实例 ID。
1671
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID
1666
1672
  # @type InstanceId: String
1667
1673
 
1668
1674
  attr_accessor :InstanceId
@@ -2032,7 +2038,7 @@ module TencentCloud
2032
2038
 
2033
2039
  # DescribeInstanceDTSInfo请求参数结构体
2034
2040
  class DescribeInstanceDTSInfoRequest < TencentCloud::Common::AbstractModel
2035
- # @param InstanceId: 实例ID
2041
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
2036
2042
  # @type InstanceId: String
2037
2043
 
2038
2044
  attr_accessor :InstanceId
@@ -2523,7 +2529,7 @@ module TencentCloud
2523
2529
 
2524
2530
  # DescribeInstanceMonitorSIP请求参数结构体
2525
2531
  class DescribeInstanceMonitorSIPRequest < TencentCloud::Common::AbstractModel
2526
- # @param InstanceId: 实例Id
2532
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
2527
2533
  # @type InstanceId: String
2528
2534
 
2529
2535
  attr_accessor :InstanceId
@@ -2566,7 +2572,7 @@ module TencentCloud
2566
2572
 
2567
2573
  # DescribeInstanceMonitorTookDist请求参数结构体
2568
2574
  class DescribeInstanceMonitorTookDistRequest < TencentCloud::Common::AbstractModel
2569
- # @param InstanceId: 实例 ID。
2575
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
2570
2576
  # @type InstanceId: String
2571
2577
  # @param Date: 查询时间日期。
2572
2578
  # @type Date: String
@@ -2672,7 +2678,7 @@ module TencentCloud
2672
2678
 
2673
2679
  # DescribeInstanceMonitorTopNCmdTook请求参数结构体
2674
2680
  class DescribeInstanceMonitorTopNCmdTookRequest < TencentCloud::Common::AbstractModel
2675
- # @param InstanceId: 实例 ID。
2681
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
2676
2682
  # @type InstanceId: String
2677
2683
  # @param SpanType: 查询时间范围。
2678
2684
  # - 1:实时。
@@ -3579,9 +3585,12 @@ module TencentCloud
3579
3585
 
3580
3586
  # DescribeProjectSecurityGroup请求参数结构体
3581
3587
  class DescribeProjectSecurityGroupRequest < TencentCloud::Common::AbstractModel
3582
- # @param ProjectId: 0:默认项目;-1 所有项目; >0: 特定项目
3588
+ # @param ProjectId: 指定查询的项目 ID。
3589
+ # - 0:默认项目。
3590
+ # - -1:所有项目。
3591
+ # - 大于0:特定项目。请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID。
3583
3592
  # @type ProjectId: Integer
3584
- # @param SecurityGroupId: 安全组Id
3593
+ # @param SecurityGroupId: 安全组 ID,通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数 **InstanceSecurityGroupsDetail** 的子参数 **SecurityGroupId** 获取。
3585
3594
  # @type SecurityGroupId: String
3586
3595
 
3587
3596
  attr_accessor :ProjectId, :SecurityGroupId
@@ -3628,7 +3637,7 @@ module TencentCloud
3628
3637
  class DescribeProjectSecurityGroupsRequest < TencentCloud::Common::AbstractModel
3629
3638
  # @param Product: 数据库引擎名称,本接口取值:redis。
3630
3639
  # @type Product: String
3631
- # @param ProjectId: 项目 ID。
3640
+ # @param ProjectId: 项目 ID,请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID
3632
3641
  # @type ProjectId: Integer
3633
3642
  # @param Offset: 偏移量,取值为Limit的整数倍。
3634
3643
  # @type Offset: Integer
@@ -3756,7 +3765,8 @@ module TencentCloud
3756
3765
 
3757
3766
  # DescribeRedisClusterOverview请求参数结构体
3758
3767
  class DescribeRedisClusterOverviewRequest < TencentCloud::Common::AbstractModel
3759
- # @param DedicatedClusterId: 本地专用集群id
3768
+ # @param DedicatedClusterId: 本地专用集群 ID,请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1
3769
+ # )实例列表获取集群 ID。
3760
3770
  # @type DedicatedClusterId: String
3761
3771
 
3762
3772
  attr_accessor :DedicatedClusterId
@@ -3796,23 +3806,31 @@ module TencentCloud
3796
3806
 
3797
3807
  # DescribeRedisClusters请求参数结构体
3798
3808
  class DescribeRedisClustersRequest < TencentCloud::Common::AbstractModel
3799
- # @param RedisClusterIds: Redis独享集群id
3809
+ # @param RedisClusterIds: Redis独享集群 ID。请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1
3810
+ # )切换至**云服务管理**页面,在下拉框选择**云数据库 Redis**,可获取独享集群ID。
3800
3811
  # @type RedisClusterIds: Array
3801
- # @param Status: 集群状态:1-流程中,2-运行中,3-已隔离
3812
+ # @param Status: 集群状态。
3813
+ # - 1:流程。
3814
+ # - 2:运行中。
3815
+ # - 3:已隔离。
3802
3816
  # @type Status: Array
3803
- # @param ProjectIds: 项目ID数组
3817
+ # @param ProjectIds: 项目ID数组。请登录[项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID。
3804
3818
  # @type ProjectIds: Array
3805
- # @param AutoRenewFlag: 续费模式:0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
3819
+ # @param AutoRenewFlag: 续费模式。
3820
+ # - 0:默认状态,手动续费。
3821
+ # - 1:自动续费。
3822
+ # - 2:明确不自动续费。
3806
3823
  # @type AutoRenewFlag: Array
3807
- # @param ClusterName: Redis独享集群名称
3824
+ # @param ClusterName: Redis 独享集群名称。
3808
3825
  # @type ClusterName: String
3809
- # @param SearchKey: 搜索关键词:支持集群Id、集群名称
3826
+ # @param SearchKey: 搜索关键词:支持集群 ID、集群名称。
3810
3827
  # @type SearchKey: String
3811
- # @param Limit: 分页限制返回大小,不传则默认为20
3828
+ # @param Limit: 分页限制返回大小,不传则默认为20
3812
3829
  # @type Limit: Integer
3813
3830
  # @param Offset: 偏移量,取Limit整数倍
3814
3831
  # @type Offset: Integer
3815
- # @param DedicatedClusterId: 本地专用集群id
3832
+ # @param DedicatedClusterId: 本地专用集群 ID,请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1
3833
+ # )实例列表获取集群 ID。
3816
3834
  # @type DedicatedClusterId: String
3817
3835
 
3818
3836
  attr_accessor :RedisClusterIds, :Status, :ProjectIds, :AutoRenewFlag, :ClusterName, :SearchKey, :Limit, :Offset, :DedicatedClusterId
@@ -4130,7 +4148,7 @@ module TencentCloud
4130
4148
 
4131
4149
  # DescribeTaskInfo请求参数结构体
4132
4150
  class DescribeTaskInfoRequest < TencentCloud::Common::AbstractModel
4133
- # @param TaskId: 任务 ID
4151
+ # @param TaskId: 任务 ID, 请通过接口[DescribeTaskList](https://cloud.tencent.com/document/product/239/39374) 的返回参数 **Tasks** 的子参数 **TaskId** 获取。
4134
4152
  # @type TaskId: Integer
4135
4153
 
4136
4154
  attr_accessor :TaskId
@@ -4338,7 +4356,7 @@ module TencentCloud
4338
4356
 
4339
4357
  # DescribeTendisSlowLog请求参数结构体
4340
4358
  class DescribeTendisSlowLogRequest < TencentCloud::Common::AbstractModel
4341
- # @param InstanceId: 实例Id:crs-ngvou0i1
4359
+ # @param InstanceId: 实例 ID,请登录[Tendis控制台](https://console.cloud.tencent.com/tendis)在实例列表复制实例 ID。
4342
4360
  # @type InstanceId: String
4343
4361
  # @param BeginTime: 开始时间:2019-09-08 12:12:41,查询时间最大跨度30天。
4344
4362
  # @type BeginTime: String
@@ -4405,7 +4423,7 @@ module TencentCloud
4405
4423
 
4406
4424
  # DestroyPostpaidInstance请求参数结构体
4407
4425
  class DestroyPostpaidInstanceRequest < TencentCloud::Common::AbstractModel
4408
- # @param InstanceId: 实例ID
4426
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4409
4427
  # @type InstanceId: String
4410
4428
 
4411
4429
  attr_accessor :InstanceId
@@ -4441,7 +4459,7 @@ module TencentCloud
4441
4459
 
4442
4460
  # DestroyPrepaidInstance请求参数结构体
4443
4461
  class DestroyPrepaidInstanceRequest < TencentCloud::Common::AbstractModel
4444
- # @param InstanceId: 实例ID
4462
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4445
4463
  # @type InstanceId: String
4446
4464
 
4447
4465
  attr_accessor :InstanceId
@@ -4477,7 +4495,7 @@ module TencentCloud
4477
4495
 
4478
4496
  # DisableReplicaReadonly请求参数结构体
4479
4497
  class DisableReplicaReadonlyRequest < TencentCloud::Common::AbstractModel
4480
- # @param InstanceId: 实例序号ID
4498
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4481
4499
  # @type InstanceId: String
4482
4500
 
4483
4501
  attr_accessor :InstanceId
@@ -4516,9 +4534,9 @@ module TencentCloud
4516
4534
  class DisassociateSecurityGroupsRequest < TencentCloud::Common::AbstractModel
4517
4535
  # @param Product: 数据库引擎名称,本接口取值:redis。
4518
4536
  # @type Product: String
4519
- # @param SecurityGroupId: 安全组 ID
4537
+ # @param SecurityGroupId: 安全组 ID,请通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数InstanceSecurityGroupsDetail 的子参数**SecurityGroupId**获取。
4520
4538
  # @type SecurityGroupId: String
4521
- # @param InstanceIds: 实例ID列表,一个或者多个实例 ID 组成的数组。
4539
+ # @param InstanceIds: 实例ID列表,一个或者多个实例 ID 组成的数组。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4522
4540
  # @type InstanceIds: Array
4523
4541
 
4524
4542
  attr_accessor :Product, :SecurityGroupId, :InstanceIds
@@ -4554,9 +4572,12 @@ module TencentCloud
4554
4572
 
4555
4573
  # EnableReplicaReadonly请求参数结构体
4556
4574
  class EnableReplicaReadonlyRequest < TencentCloud::Common::AbstractModel
4557
- # @param InstanceId: 实例序号ID
4575
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4558
4576
  # @type InstanceId: String
4559
- # @param ReadonlyPolicy: 账号路由策略:填写master或者replication,表示路由主节点,从节点;不填路由策略默认为写主节点,读从节点
4577
+ # @param ReadonlyPolicy: 只读路由策略。
4578
+ # - master:表示只读路由至主节点。
4579
+ # - replication:表示只读路由至从节点。
4580
+ # - 默认策略:表示写主节点,读从节点。
4560
4581
  # @type ReadonlyPolicy: Array
4561
4582
 
4562
4583
  attr_accessor :InstanceId, :ReadonlyPolicy
@@ -4878,13 +4899,13 @@ module TencentCloud
4878
4899
 
4879
4900
  # InquiryPriceUpgradeInstance请求参数结构体
4880
4901
  class InquiryPriceUpgradeInstanceRequest < TencentCloud::Common::AbstractModel
4881
- # @param InstanceId: 实例Id
4902
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
4882
4903
  # @type InstanceId: String
4883
- # @param MemSize: 分片大小 单位 MB
4904
+ # @param MemSize: 分片大小,单位:MB
4884
4905
  # @type MemSize: Integer
4885
- # @param RedisShardNum: 分片数量,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写
4906
+ # @param RedisShardNum: 分片数量,Redis 2.8主从版、CKV主从版和Redis2.8单机版不需要填写。
4886
4907
  # @type RedisShardNum: Integer
4887
- # @param RedisReplicasNum: 副本数量,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写
4908
+ # @param RedisReplicasNum: 副本数量,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写。
4888
4909
  # @type RedisReplicasNum: Integer
4889
4910
 
4890
4911
  attr_accessor :InstanceId, :MemSize, :RedisShardNum, :RedisReplicasNum
@@ -5876,7 +5897,7 @@ module TencentCloud
5876
5897
  # - 不能以"/"开头
5877
5898
  # - 至少包含小写字母a-z、大写字母A-Z、数字0-9及其 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。
5878
5899
  # @type Password: String
5879
- # @param ShardIds: 分片集群的分片 ID
5900
+ # @param ShardIds: 分片集群的分片 ID。请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603) 的返回参数 **Redis** 中的 **ClusterId** 获取。
5880
5901
  # @type ShardIds: Array
5881
5902
 
5882
5903
  attr_accessor :InstanceId, :Password, :ShardIds
@@ -6164,13 +6185,13 @@ module TencentCloud
6164
6185
 
6165
6186
  # ModifyConnectionConfig请求参数结构体
6166
6187
  class ModifyConnectionConfigRequest < TencentCloud::Common::AbstractModel
6167
- # @param InstanceId: 实例的ID,长度在12-36之间。
6188
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
6168
6189
  # @type InstanceId: String
6169
6190
  # @param Bandwidth: 附加带宽,大于0,单位MB。
6170
6191
  # @type Bandwidth: Integer
6171
6192
  # @param ClientLimit: 单分片的总连接数。
6172
- # 未开启副本只读时,下限为10000,上限为40000
6173
- # 开启副本只读时,下限为10000,上限为10000×(只读副本数+3)。
6193
+ # - 未开启副本只读时,下限为10000,上限为40000
6194
+ # - 开启副本只读时,下限为10000,上限为10000×(只读副本数+3)。
6174
6195
  # @type ClientLimit: Integer
6175
6196
 
6176
6197
  attr_accessor :InstanceId, :Bandwidth, :ClientLimit
@@ -6212,9 +6233,11 @@ module TencentCloud
6212
6233
  class ModifyDBInstanceSecurityGroupsRequest < TencentCloud::Common::AbstractModel
6213
6234
  # @param Product: 数据库引擎名称,本接口取值:redis。
6214
6235
  # @type Product: String
6215
- # @param SecurityGroupIds: 更换为新的安全组 ID 列表,即一个或者多个安全组 ID 组成的数组。若实例第一次配置安全组,请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。
6236
+ # @param SecurityGroupIds: 更换为新的安全组 ID 列表,即一个或者多个安全组 ID 组成的数组。
6237
+ # - 若实例第一次配置安全组,请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。
6238
+ # - 更换安全组,请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。
6216
6239
  # @type SecurityGroupIds: Array
6217
- # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv或者cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
6240
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
6218
6241
  # @type InstanceId: String
6219
6242
 
6220
6243
  attr_accessor :Product, :SecurityGroupIds, :InstanceId
@@ -6250,19 +6273,26 @@ module TencentCloud
6250
6273
 
6251
6274
  # ModifyInstanceAccount请求参数结构体
6252
6275
  class ModifyInstanceAccountRequest < TencentCloud::Common::AbstractModel
6253
- # @param InstanceId: 实例ID
6276
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
6254
6277
  # @type InstanceId: String
6255
- # @param AccountName: 子账号名称,如果要修改主账号,填root
6278
+ # @param AccountName: 子账号名称,如果要修改主账号,填 root
6256
6279
  # @type AccountName: String
6257
- # @param AccountPassword: 子账号密码
6280
+ # @param AccountPassword: 子账号密码。
6258
6281
  # @type AccountPassword: String
6259
6282
  # @param Remark: 子账号描述信息
6260
6283
  # @type Remark: String
6261
- # @param ReadonlyPolicy: 路由策略:填写master或者replication,表示主节点或者从节点
6284
+ # @param ReadonlyPolicy: 账号读写路由策略。
6285
+ # - master:表示主节点。
6286
+ # - replication:表示从节点。
6262
6287
  # @type ReadonlyPolicy: Array
6263
- # @param Privilege: 子账号读写策略:填写r、w、rw,表示只读,只写,读写策略
6288
+ # @param Privilege: 子账号读写策略。
6289
+ # - r:只读。
6290
+ # - w:只写。
6291
+ # - rw:读写。
6264
6292
  # @type Privilege: String
6265
- # @param NoAuth: true表示将主账号切换为免密账号,这里只适用于主账号,子账号不可免密。
6293
+ # @param NoAuth: 指定是否将主账号切换为免密账号。这里只适用于主账号,子账号不可免密。
6294
+ # - true:将主账号切换为免密账号。
6295
+ # - false:不切换。
6266
6296
  # @type NoAuth: Boolean
6267
6297
 
6268
6298
  attr_accessor :InstanceId, :AccountName, :AccountPassword, :Remark, :ReadonlyPolicy, :Privilege, :NoAuth
@@ -6422,7 +6452,7 @@ module TencentCloud
6422
6452
 
6423
6453
  # ModifyInstanceLogDelivery请求参数结构体
6424
6454
  class ModifyInstanceLogDeliveryRequest < TencentCloud::Common::AbstractModel
6425
- # @param InstanceId: 实例ID。
6455
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
6426
6456
  # @type InstanceId: String
6427
6457
  # @param LogType: 日志类型。当前仅支持设置为slowlog,指慢查询日志。
6428
6458
  # @type LogType: String
@@ -6430,9 +6460,9 @@ module TencentCloud
6430
6460
  # - true:开启。
6431
6461
  # - false:关闭。
6432
6462
  # @type Enabled: Boolean
6433
- # @param LogsetId: 投递的日志集ID
6463
+ # @param LogsetId: 投递的日志集ID。通过接口[DescribeInstanceLogDelivery](https://cloud.tencent.com/document/product/239/110878)的返回参数 **SlowLog** 的子参数 **LogsetId** 获取。
6434
6464
  # @type LogsetId: String
6435
- # @param TopicId: 投递的日志主题ID
6465
+ # @param TopicId: 投递的日志主题ID。请通过接口[DescribeInstanceLogDelivery](https://cloud.tencent.com/document/product/239/110878)的返回参数 **SlowLog** 的子参数 **TopicId** 获取。
6436
6466
  # @type TopicId: String
6437
6467
  # @param LogsetName: 日志集名称。若**LogsetId**未指定具体的日志集ID,请配置该参数,设置日志集名称,系统会以设置的日志集名称自动创建新的日志集。
6438
6468
  # @type LogsetName: String
@@ -6492,7 +6522,7 @@ module TencentCloud
6492
6522
 
6493
6523
  # ModifyInstanceParams请求参数结构体
6494
6524
  class ModifyInstanceParamsRequest < TencentCloud::Common::AbstractModel
6495
- # @param InstanceId: 实例ID。
6525
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
6496
6526
  # @type InstanceId: String
6497
6527
  # @param InstanceParams: 实例修改的参数列表。
6498
6528
  # @type InstanceParams: Array
@@ -6590,9 +6620,11 @@ module TencentCloud
6590
6620
 
6591
6621
  # ModifyInstanceReadOnly请求参数结构体
6592
6622
  class ModifyInstanceReadOnlyRequest < TencentCloud::Common::AbstractModel
6593
- # @param InstanceId: 实例ID
6623
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
6594
6624
  # @type InstanceId: String
6595
- # @param InputMode: 实例输入模式,0:读写 1:只读
6625
+ # @param InputMode: 实例输入模式。
6626
+ # - 0:读写。
6627
+ # - 1:只读。
6596
6628
  # @type InputMode: String
6597
6629
 
6598
6630
  attr_accessor :InstanceId, :InputMode
@@ -6630,21 +6662,27 @@ module TencentCloud
6630
6662
 
6631
6663
  # ModifyInstance请求参数结构体
6632
6664
  class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
6633
- # @param Operation: 修改实例操作,如填写:rename-表示实例重命名;modifyProject-修改实例所属项目;modifyAutoRenew-修改实例续费标记
6665
+ # @param Operation: 修改实例操作。如填写:
6666
+ # - rename:表示实例重命名。
6667
+ # - modifyProject:修改实例所属项目。
6668
+ # - modifyAutoRenew:修改实例续费标记。
6634
6669
  # @type Operation: String
6635
- # @param InstanceIds: 实例Id,每次请求的实例的上限为10。
6670
+ # @param InstanceIds: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。每次请求的实例数量的上限为10。
6636
6671
  # @type InstanceIds: Array
6637
- # @param InstanceNames: 实例的新名称
6672
+ # @param InstanceNames: 实例的新名称。
6638
6673
  # @type InstanceNames: Array
6639
- # @param ProjectId: 项目Id
6674
+ # @param ProjectId: 项目 ID,请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面,在**项目名称**中复制项目 ID。
6640
6675
  # @type ProjectId: Integer
6641
- # @param AutoRenews: 自动续费标识。0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
6676
+ # @param AutoRenews: 自动续费标识。
6677
+ # - 0:默认状态,指手动续费。
6678
+ # - 1:自动续费。
6679
+ # - 2:明确不自动续费。
6642
6680
  # @type AutoRenews: Array
6643
- # @param InstanceId: 已经废弃
6681
+ # @param InstanceId: 目前在废弃中,存量用户还可以使用,建议新用户使用 InstanceIds。
6644
6682
  # @type InstanceId: String
6645
6683
  # @param InstanceName: 已经废弃
6646
6684
  # @type InstanceName: String
6647
- # @param AutoRenew: 已经废弃
6685
+ # @param AutoRenew: 已经废弃。
6648
6686
  # @type AutoRenew: Integer
6649
6687
 
6650
6688
  attr_accessor :Operation, :InstanceIds, :InstanceNames, :ProjectId, :AutoRenews, :InstanceId, :InstanceName, :AutoRenew
@@ -6690,11 +6728,11 @@ module TencentCloud
6690
6728
 
6691
6729
  # ModifyMaintenanceWindow请求参数结构体
6692
6730
  class ModifyMaintenanceWindowRequest < TencentCloud::Common::AbstractModel
6693
- # @param InstanceId: 实例ID
6731
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
6694
6732
  # @type InstanceId: String
6695
- # @param StartTime: 维护时间窗起始时间,如:17:00
6733
+ # @param StartTime: 维护时间窗起始时间,如:17:00
6696
6734
  # @type StartTime: String
6697
- # @param EndTime: 维护时间窗结束时间,如:19:00
6735
+ # @param EndTime: 维护时间窗结束时间,如:19:00
6698
6736
  # @type EndTime: String
6699
6737
 
6700
6738
  attr_accessor :InstanceId, :StartTime, :EndTime
@@ -6821,7 +6859,7 @@ module TencentCloud
6821
6859
 
6822
6860
  # ModifyParamTemplate请求参数结构体
6823
6861
  class ModifyParamTemplateRequest < TencentCloud::Common::AbstractModel
6824
- # @param TemplateId: 源参数模板 ID。
6862
+ # @param TemplateId: 源参数模板 ID。 请通过接口[DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748)的返回参数 **TemplateId** 获取参数模板 ID。
6825
6863
  # @type TemplateId: String
6826
6864
  # @param Name: 参数模板修改后的新名称。
6827
6865
  # @type Name: String
@@ -6912,7 +6950,7 @@ module TencentCloud
6912
6950
 
6913
6951
  # OpenSSL请求参数结构体
6914
6952
  class OpenSSLRequest < TencentCloud::Common::AbstractModel
6915
- # @param InstanceId: 实例ID。
6953
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
6916
6954
  # @type InstanceId: String
6917
6955
 
6918
6956
  attr_accessor :InstanceId
@@ -7565,7 +7603,7 @@ module TencentCloud
7565
7603
 
7566
7604
  # ReleaseWanAddress请求参数结构体
7567
7605
  class ReleaseWanAddressRequest < TencentCloud::Common::AbstractModel
7568
- # @param InstanceId: 实例ID
7606
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
7569
7607
  # @type InstanceId: String
7570
7608
 
7571
7609
  attr_accessor :InstanceId
@@ -7605,11 +7643,13 @@ module TencentCloud
7605
7643
 
7606
7644
  # RemoveReplicationInstance请求参数结构体
7607
7645
  class RemoveReplicationInstanceRequest < TencentCloud::Common::AbstractModel
7608
- # @param GroupId: 复制组ID
7646
+ # @param GroupId: 复制组 ID。例如:crs-rpl-m3zt****。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。
7609
7647
  # @type GroupId: String
7610
- # @param InstanceId: 实例ID
7648
+ # @param InstanceId: 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
7611
7649
  # @type InstanceId: String
7612
- # @param SyncType: 数据同步类型,true:需要数据强同步,false:不需要强同步,仅限删除主实例
7650
+ # @param SyncType: 数据同步类型。
7651
+ # - true:需数据强同步。
7652
+ # - false:无需强同步,仅限删除主实例。
7613
7653
  # @type SyncType: Boolean
7614
7654
 
7615
7655
  attr_accessor :GroupId, :InstanceId, :SyncType
@@ -7629,7 +7669,7 @@ module TencentCloud
7629
7669
 
7630
7670
  # RemoveReplicationInstance返回参数结构体
7631
7671
  class RemoveReplicationInstanceResponse < TencentCloud::Common::AbstractModel
7632
- # @param TaskId: 异步任务ID
7672
+ # @param TaskId: 异步任务ID
7633
7673
  # @type TaskId: Integer
7634
7674
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7635
7675
  # @type RequestId: String
@@ -7732,11 +7772,13 @@ module TencentCloud
7732
7772
 
7733
7773
  # ResetPassword请求参数结构体
7734
7774
  class ResetPasswordRequest < TencentCloud::Common::AbstractModel
7735
- # @param InstanceId: Redis实例ID
7775
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
7736
7776
  # @type InstanceId: String
7737
- # @param Password: 重置的密码(切换为免密实例时,可不传;其他情况必传)
7777
+ # @param Password: 重置的密码。若切换为免密实例时,可不配置该参数。其他情况必须配置。
7738
7778
  # @type Password: String
7739
- # @param NoAuth: 是否切换免密实例,false-切换为非免密码实例,true-切换为免密码实例;默认false
7779
+ # @param NoAuth: 是否切换免密实例。
7780
+ # - false:切换为非免密码实例。
7781
+ # - true:切换为免密码实例。默认 false。
7740
7782
  # @type NoAuth: Boolean
7741
7783
 
7742
7784
  attr_accessor :InstanceId, :Password, :NoAuth
@@ -8046,7 +8088,7 @@ module TencentCloud
8046
8088
 
8047
8089
  # StartupInstance请求参数结构体
8048
8090
  class StartupInstanceRequest < TencentCloud::Common::AbstractModel
8049
- # @param InstanceId: 实例id
8091
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8050
8092
  # @type InstanceId: String
8051
8093
 
8052
8094
  attr_accessor :InstanceId
@@ -8115,13 +8157,15 @@ module TencentCloud
8115
8157
 
8116
8158
  # SwitchInstanceVip请求参数结构体
8117
8159
  class SwitchInstanceVipRequest < TencentCloud::Common::AbstractModel
8118
- # @param SrcInstanceId: 源实例ID
8160
+ # @param SrcInstanceId: 源实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8119
8161
  # @type SrcInstanceId: String
8120
- # @param DstInstanceId: 目标实例ID
8162
+ # @param DstInstanceId: 目标实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8121
8163
  # @type DstInstanceId: String
8122
- # @param TimeDelay: 单位为秒。源实例与目标实例间DTS已断开时间,如果DTS断开时间大于TimeDelay,则不切换VIP,建议尽量根据业务设置一个可接受的值。
8164
+ # @param TimeDelay: 单位为秒。源实例与目标实例间DTS已断开时间。如果 DTS 断开时间大于TimeDelay,则不切换VIP,建议尽量根据业务设置一个可接受的值。
8123
8165
  # @type TimeDelay: Integer
8124
- # @param ForceSwitch: 在DTS断开的情况下是否强制切换。1:强制切换,0:不强制切换
8166
+ # @param ForceSwitch: 在 DTS 断开的情况下是否强制切换。
8167
+ # - 1:强制切换。
8168
+ # - 0:不强制切换。
8125
8169
  # @type ForceSwitch: Integer
8126
8170
  # @param SwitchTime: now: 立即切换,syncComplete:等待同步完成后切换
8127
8171
  # @type SwitchTime: String
@@ -8167,9 +8211,9 @@ module TencentCloud
8167
8211
 
8168
8212
  # SwitchProxy请求参数结构体
8169
8213
  class SwitchProxyRequest < TencentCloud::Common::AbstractModel
8170
- # @param InstanceId: 实例ID
8214
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8171
8215
  # @type InstanceId: String
8172
- # @param ProxyID: 实例ProxyID
8216
+ # @param ProxyID: 实例 ProxyID,请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603)的返回参数**Proxy**中的**NodeId**获取。
8173
8217
  # @type ProxyID: String
8174
8218
 
8175
8219
  attr_accessor :InstanceId, :ProxyID
@@ -8545,13 +8589,15 @@ module TencentCloud
8545
8589
 
8546
8590
  # UpgradeProxyVersion请求参数结构体
8547
8591
  class UpgradeProxyVersionRequest < TencentCloud::Common::AbstractModel
8548
- # @param InstanceId: 实例ID
8592
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8549
8593
  # @type InstanceId: String
8550
- # @param CurrentProxyVersion: 当前proxy版本
8594
+ # @param CurrentProxyVersion: 当前 Proxy 版本。
8551
8595
  # @type CurrentProxyVersion: String
8552
- # @param UpgradeProxyVersion: 可升级的redis版本
8596
+ # @param UpgradeProxyVersion: 可升级的 Redis 版本。
8553
8597
  # @type UpgradeProxyVersion: String
8554
- # @param InstanceTypeUpgradeNow: 1-立即升级 0-维护时间窗口升级
8598
+ # @param InstanceTypeUpgradeNow: 指定是否立即升级。
8599
+ # - 1:立即升级。
8600
+ # - 0:维护时间窗口升级。
8555
8601
  # @type InstanceTypeUpgradeNow: Integer
8556
8602
 
8557
8603
  attr_accessor :InstanceId, :CurrentProxyVersion, :UpgradeProxyVersion, :InstanceTypeUpgradeNow
@@ -8593,13 +8639,15 @@ module TencentCloud
8593
8639
 
8594
8640
  # UpgradeSmallVersion请求参数结构体
8595
8641
  class UpgradeSmallVersionRequest < TencentCloud::Common::AbstractModel
8596
- # @param InstanceId: 实例ID
8642
+ # @param InstanceId: 实例 ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
8597
8643
  # @type InstanceId: String
8598
- # @param CurrentRedisVersion: 当前redis版本
8644
+ # @param CurrentRedisVersion: 当前 Redis 小版本。小版本信息,请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。
8599
8645
  # @type CurrentRedisVersion: String
8600
- # @param UpgradeRedisVersion: 可升级的redis版本
8646
+ # @param UpgradeRedisVersion: 升级后的 Redis 小版本。小版本信息,请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。
8601
8647
  # @type UpgradeRedisVersion: String
8602
- # @param InstanceTypeUpgradeNow: 1-立即升级 0-维护时间窗口升级
8648
+ # @param InstanceTypeUpgradeNow: 指定是否立即升级。
8649
+ # - 1:立即升级。
8650
+ # - 0:维护时间窗口升级。
8603
8651
  # @type InstanceTypeUpgradeNow: Integer
8604
8652
 
8605
8653
  attr_accessor :InstanceId, :CurrentRedisVersion, :UpgradeRedisVersion, :InstanceTypeUpgradeNow
@@ -8641,7 +8689,7 @@ module TencentCloud
8641
8689
 
8642
8690
  # UpgradeVersionToMultiAvailabilityZones请求参数结构体
8643
8691
  class UpgradeVersionToMultiAvailabilityZonesRequest < TencentCloud::Common::AbstractModel
8644
- # @param InstanceId: 实例ID。
8692
+ # @param InstanceId: 实例ID,请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID
8645
8693
  # @type InstanceId: String
8646
8694
  # @param UpgradeProxyAndRedisServer: 升级多可用区之后是否支持就近访问功能。
8647
8695
  # <ul><li>true:支持就近访问功能。升级过程,需同时升级 Proxy 版本和 Redis 内核小版本,涉及数据搬迁,可能会长达数小时。</li><li>false:无需支持就近访问功能。升级多可用区仅涉及管理元数据迁移,对服务没有影响,升级过程通常在3分钟内完成。</li></ul>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-redis
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.945
4
+ version: 3.0.946
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-21 00:00:00.000000000 Z
11
+ date: 2024-11-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common