tencentcloud-sdk-cdb 3.0.1106 → 3.0.1114

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: 8de96220f542abbb496d52a7d0b0281e240721c4
4
- data.tar.gz: dd575600ba465b8549d5d075b9b399c6b1129b13
3
+ metadata.gz: 987fbf37711184927586e0fb8f58cc2c93563951
4
+ data.tar.gz: 1e70e1a5bb39b64c8120f4cd26ab1f46b80e26a8
5
5
  SHA512:
6
- metadata.gz: 37f706a2a5da5914d7aac5e5ad6d94061747063aa37c6f0782bac75857d3e503685101e85009752afc3affba62ff7db5c63862ea1e29a952b70e862492355cd5
7
- data.tar.gz: a582abe5e54c8e9468a55fd12ee8103af5df51a99717335305f1d2e397e0ef5cb3f51fd8cdced306f88c30b3f6e04c0dd2b319aabf372b94a72365cf1fd527c2
6
+ metadata.gz: 3a04de31f21a8915a2cdf4c04b615e6682c5aabe4dd316f0176985775fda87433ab980e10b2cb111c10da8a44cc368876dc21451dddf9c19e9f13f7a42cee58f
7
+ data.tar.gz: be893c8c54b1114df589914773b1697f8771057eb87d9eb66ac8582fc9a07e0b7f34293ad2bb66f29855dc4c787b6e6492cdc6aa7923d345c6bfa1c1cda636f7
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1106
1
+ 3.0.1114
@@ -1397,7 +1397,7 @@ module TencentCloud
1397
1397
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1398
1398
  end
1399
1399
 
1400
- # 本接口(DescribeBackupSummaries)用于查询备份的统计情况,返回以实例为维度的备份占用容量,以及每个实例的数据备份和日志备份的个数和容量(容量单位为字节)。
1400
+ # 本接口(DescribeBackupSummaries)用于查询备份的统计情况,返回以实例为维度的备份占用容量,以及每个实例的数据备份和日志备份的个数和容量(容量单位为字节)。
1401
1401
 
1402
1402
  # @param request: Request instance for DescribeBackupSummaries.
1403
1403
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeBackupSummariesRequest`
@@ -1781,7 +1781,7 @@ module TencentCloud
1781
1781
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1782
1782
  end
1783
1783
 
1784
- # 本接口(DescribeDBInstanceLogToCLS)用于查询实例慢日志、错误日志投递CLS的配置,通过AppId、Region以及实例ID过滤出当前实例日志投递CLS的配置。
1784
+ # 本接口(DescribeDBInstanceLogToCLS)用于查询实例慢日志、错误日志投递CLS的配置,通过AppId、Region以及实例ID过滤出当前实例日志投递CLS的配置。
1785
1785
 
1786
1786
  # @param request: Request instance for DescribeDBInstanceLogToCLS.
1787
1787
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeDBInstanceLogToCLSRequest`
@@ -2434,7 +2434,7 @@ module TencentCloud
2434
2434
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2435
2435
  end
2436
2436
 
2437
- # 本接口(DescribeRollbackTaskDetail)用于查询云数据库实例回档任务详情。
2437
+ # 本接口(DescribeRollbackTaskDetail)用于查询云数据库实例回档任务详情。
2438
2438
 
2439
2439
  # @param request: Request instance for DescribeRollbackTaskDetail.
2440
2440
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeRollbackTaskDetailRequest`
@@ -2507,7 +2507,8 @@ module TencentCloud
2507
2507
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2508
2508
  end
2509
2509
 
2510
- # 本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。说明:若单次查询数据量过大,则有可能响应超时,建议缩短单次查询时间范围,如一小时,避免导致超时。
2510
+ # 本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。
2511
+ # 说明:若单次查询数据量过大,则有可能响应超时,建议缩短单次查询时间范围,如一小时,避免导致超时。
2511
2512
 
2512
2513
  # @param request: Request instance for DescribeSlowLogs.
2513
2514
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeSlowLogsRequest`
@@ -2555,7 +2556,7 @@ module TencentCloud
2555
2556
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2556
2557
  end
2557
2558
 
2558
- # 本接口(DescribeTableColumns)用于查询云数据库实例的指定数据库表的列信息,仅支持主实例和灾备实例。
2559
+ # 本接口(DescribeTableColumns)用于查询云数据库实例的指定数据库表的列信息,仅支持主实例和灾备实例。
2559
2560
 
2560
2561
  # @param request: Request instance for DescribeTableColumns.
2561
2562
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeTableColumnsRequest`
@@ -3016,7 +3017,7 @@ module TencentCloud
3016
3017
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3017
3018
  end
3018
3019
 
3019
- # 本接口(ModifyBackupConfig)用于修改数据库备份配置信息。
3020
+ # 本接口(ModifyBackupConfig)用于修改数据库备份配置信息。
3020
3021
 
3021
3022
  # @param request: Request instance for ModifyBackupConfig.
3022
3023
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyBackupConfigRequest`
@@ -3376,7 +3377,7 @@ module TencentCloud
3376
3377
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3377
3378
  end
3378
3379
 
3379
- # 该接口用于修改实例本地binlog保留策略。
3380
+ # 本接口(ModifyLocalBinlogConfig)用于修改实例本地 binlog 保留策略。
3380
3381
 
3381
3382
  # @param request: Request instance for ModifyLocalBinlogConfig.
3382
3383
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyLocalBinlogConfigRequest`
@@ -1392,8 +1392,10 @@ module TencentCloud
1392
1392
  # @param Date: 文件存储时间,时间格式:2016-03-17 02:10:37
1393
1393
  # @type Date: String
1394
1394
  # @param IntranetUrl: 下载地址
1395
+ # 说明:此下载地址和参数 InternetUrl 的下载地址一样。
1395
1396
  # @type IntranetUrl: String
1396
1397
  # @param InternetUrl: 下载地址
1398
+ # 说明:此下载地址和参数 IntranetUrl 的下载地址一样。
1397
1399
  # @type InternetUrl: String
1398
1400
  # @param Type: 日志具体类型,可能的值有:binlog - 二进制日志
1399
1401
  # @type Type: String
@@ -1413,6 +1415,9 @@ module TencentCloud
1413
1415
  # @type InstanceId: String
1414
1416
 
1415
1417
  attr_accessor :Name, :Size, :Date, :IntranetUrl, :InternetUrl, :Type, :BinlogStartTime, :BinlogFinishTime, :Region, :Status, :RemoteInfo, :CosStorageType, :InstanceId
1418
+ extend Gem::Deprecate
1419
+ deprecate :InstanceId, :none, 2025, 7
1420
+ deprecate :InstanceId=, :none, 2025, 7
1416
1421
 
1417
1422
  def initialize(name=nil, size=nil, date=nil, intraneturl=nil, interneturl=nil, type=nil, binlogstarttime=nil, binlogfinishtime=nil, region=nil, status=nil, remoteinfo=nil, cosstoragetype=nil, instanceid=nil)
1418
1423
  @Name = name
@@ -2590,9 +2595,9 @@ module TencentCloud
2590
2595
  # @param BackupDBTableList: 需要备份的库表信息,如果不设置该参数,则默认整实例备份。在 BackupMethod=logical 逻辑备份中才可设置该参数。指定的库表必须存在,否则可能导致备份失败。
2591
2596
  # 例:如果需要备份 db1 库的 tb1、tb2 表 和 db2 库。则该参数设置为 [{"Db": "db1", "Table": "tb1"}, {"Db": "db1", "Table": "tb2"}, {"Db": "db2"}]。
2592
2597
  # @type BackupDBTableList: Array
2593
- # @param ManualBackupName: 手动备份别名
2598
+ # @param ManualBackupName: 手动备份别名,输入长度请在60个字符内。
2594
2599
  # @type ManualBackupName: String
2595
- # @param EncryptionFlag: 是否需要加密物理备份, BackupMethod为physical 时,该值才有意义。 不指定则使用实例备份默认加密策略。
2600
+ # @param EncryptionFlag: 是否需要加密物理备份,可选值为:on - 是,off - 否。当 BackupMethod physical 时,该值才有意义。不指定则使用实例备份默认加密策略,这里的默认加密策略指通过 [DescribeBackupEncryptionStatus](https://cloud.tencent.com/document/product/236/86508) 接口查询出的实例当前加密策略。
2596
2601
  # @type EncryptionFlag: String
2597
2602
 
2598
2603
  attr_accessor :InstanceId, :BackupMethod, :BackupDBTableList, :ManualBackupName, :EncryptionFlag
@@ -2845,7 +2850,7 @@ module TencentCloud
2845
2850
 
2846
2851
  # CreateCloneInstance请求参数结构体
2847
2852
  class CreateCloneInstanceRequest < TencentCloud::Common::AbstractModel
2848
- # @param InstanceId: 克隆源实例Id。
2853
+ # @param InstanceId: 克隆源实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/api/236/15872) 接口获取。
2849
2854
  # @type InstanceId: String
2850
2855
  # @param SpecifiedRollbackTime: 如果需要克隆实例回档到指定时间,则指定该值。时间格式为:yyyy-mm-dd hh:mm:ss。
2851
2856
  # 说明:此参数和 SpecifiedBackupId 参数需要2选1进行设置。
@@ -2861,7 +2866,7 @@ module TencentCloud
2861
2866
  # @type Memory: Integer
2862
2867
  # @param Volume: 实例硬盘大小,单位:GB,需要不低于克隆源实例,默认和源实例相同。
2863
2868
  # @type Volume: Integer
2864
- # @param InstanceName: 新产生的克隆实例名称。
2869
+ # @param InstanceName: 新产生的克隆实例名称。支持输入最大60个字符。
2865
2870
  # @type InstanceName: String
2866
2871
  # @param SecurityGroup: 安全组参数,可使用 [查询项目安全组信息](https://cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。
2867
2872
  # @type SecurityGroup: Array
@@ -3608,19 +3613,20 @@ module TencentCloud
3608
3613
 
3609
3614
  # CreateParamTemplate请求参数结构体
3610
3615
  class CreateParamTemplateRequest < TencentCloud::Common::AbstractModel
3611
- # @param Name: 参数模板名称。
3616
+ # @param Name: 参数模板名称。支持输入最大60个字符。
3612
3617
  # @type Name: String
3613
3618
  # @param Description: 参数模板描述。
3614
3619
  # @type Description: String
3615
- # @param EngineVersion: MySQL 版本号。
3620
+ # @param EngineVersion: MySQL 版本号。可选值:5.6、5.7、8.0。
3616
3621
  # @type EngineVersion: String
3617
- # @param TemplateId: 源参数模板 ID
3622
+ # @param TemplateId: 源参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。
3618
3623
  # @type TemplateId: Integer
3619
3624
  # @param ParamList: 参数列表。
3620
3625
  # @type ParamList: Array
3621
3626
  # @param TemplateType: 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。
3622
3627
  # @type TemplateType: String
3623
3628
  # @param EngineType: 实例引擎类型,默认为"InnoDB",支持值包括:"InnoDB","RocksDB"。
3629
+ # 说明:数据库版本 MySQL 5.7、MySQL 8.0才支持 RocksDB。
3624
3630
  # @type EngineType: String
3625
3631
 
3626
3632
  attr_accessor :Name, :Description, :EngineVersion, :TemplateId, :ParamList, :TemplateType, :EngineType
@@ -4153,7 +4159,7 @@ module TencentCloud
4153
4159
 
4154
4160
  # DeleteParamTemplate请求参数结构体
4155
4161
  class DeleteParamTemplateRequest < TencentCloud::Common::AbstractModel
4156
- # @param TemplateId: 参数模板ID
4162
+ # @param TemplateId: 参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。
4157
4163
  # @type TemplateId: Integer
4158
4164
 
4159
4165
  attr_accessor :TemplateId
@@ -5135,11 +5141,11 @@ module TencentCloud
5135
5141
 
5136
5142
  # DescribeBackupDecryptionKey请求参数结构体
5137
5143
  class DescribeBackupDecryptionKeyRequest < TencentCloud::Common::AbstractModel
5138
- # @param InstanceId: 实例ID,格式如:cdb-XXXX。与云数据库控制台页面中显示的实例 ID 相同。
5144
+ # @param InstanceId: 实例 ID,格式如:cdb-fybaegd8。与云数据库控制台页面中显示的实例 ID 相同。
5139
5145
  # @type InstanceId: String
5140
- # @param BackupId: 实例的备份ID,可通过DescribeBackups接口查询备份的ID。
5146
+ # @param BackupId: 实例的备份 ID,可通过 [DescribeBackups](https://cloud.tencent.com/document/api/236/15842) 接口查询备份的 ID。
5141
5147
  # @type BackupId: Integer
5142
- # @param BackupType: 备份类型 data: 数据备份 binlog:日志备份,默认为data
5148
+ # @param BackupType: 备份类型。data-数据备份,binlog-日志备份,默认为 data
5143
5149
  # @type BackupType: String
5144
5150
 
5145
5151
  attr_accessor :InstanceId, :BackupId, :BackupType
@@ -5269,7 +5275,7 @@ module TencentCloud
5269
5275
 
5270
5276
  # DescribeBackupOverview请求参数结构体
5271
5277
  class DescribeBackupOverviewRequest < TencentCloud::Common::AbstractModel
5272
- # @param Product: 需要查询的云数据库产品类型,目前仅支持 "mysql"。
5278
+ # @param Product: 需要查询备份概览的云数据库产品类型。可取值为:mysql 指双节点/三节点的高可用实例,mysql-basic 指单节点云盘版实例,mysql-cluster 指云盘版(原集群版)实例。
5273
5279
  # @type Product: String
5274
5280
 
5275
5281
  attr_accessor :Product
@@ -5329,7 +5335,7 @@ module TencentCloud
5329
5335
 
5330
5336
  # DescribeBackupSummaries请求参数结构体
5331
5337
  class DescribeBackupSummariesRequest < TencentCloud::Common::AbstractModel
5332
- # @param Product: 需要查询的云数据库产品类型,目前仅支持 "mysql"。
5338
+ # @param Product: 需要查询备份实时统计的云数据库产品类型。可取值为:mysql 指双节点/三节点的高可用实例,mysql-basic 指单节点云盘版实例,mysql-cluster 指云盘版(原集群版)实例。
5333
5339
  # @type Product: String
5334
5340
  # @param Offset: 分页查询数据的偏移量,默认为0。
5335
5341
  # @type Offset: Integer
@@ -5392,11 +5398,11 @@ module TencentCloud
5392
5398
 
5393
5399
  # DescribeBackups请求参数结构体
5394
5400
  class DescribeBackupsRequest < TencentCloud::Common::AbstractModel
5395
- # @param InstanceId: 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
5401
+ # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
5396
5402
  # @type InstanceId: String
5397
5403
  # @param Offset: 偏移量,最小值为0。
5398
5404
  # @type Offset: Integer
5399
- # @param Limit: 分页大小,默认值为20,最小值为1,最大值为100
5405
+ # @param Limit: 分页大小,默认值为20,最小值为1,最大值为1000
5400
5406
  # @type Limit: Integer
5401
5407
 
5402
5408
  attr_accessor :InstanceId, :Offset, :Limit
@@ -5447,7 +5453,7 @@ module TencentCloud
5447
5453
 
5448
5454
  # DescribeBinlogBackupOverview请求参数结构体
5449
5455
  class DescribeBinlogBackupOverviewRequest < TencentCloud::Common::AbstractModel
5450
- # @param Product: 需要查询的云数据库产品类型,目前仅支持 "mysql"。
5456
+ # @param Product: 需要查询日志备份概览的云数据库产品类型。可取值为:mysql 指双节点/三节点的高可用实例,mysql-basic 指单节点云盘版实例,mysql-cluster 指云盘版(原集群版)实例。
5451
5457
  # @type Product: String
5452
5458
 
5453
5459
  attr_accessor :Product
@@ -5515,7 +5521,7 @@ module TencentCloud
5515
5521
  # @type InstanceId: String
5516
5522
  # @param Offset: 偏移量,最小值为0。
5517
5523
  # @type Offset: Integer
5518
- # @param Limit: 分页大小,默认值为20,最小值为1,最大值为100
5524
+ # @param Limit: 分页大小,默认值为20,最小值为1,最大值为1000
5519
5525
  # @type Limit: Integer
5520
5526
  # @param MinStartTime: binlog最早开始时间,时间格式:2016-03-17 02:10:37
5521
5527
  # @type MinStartTime: String
@@ -5728,11 +5734,11 @@ module TencentCloud
5728
5734
 
5729
5735
  # DescribeCloneList请求参数结构体
5730
5736
  class DescribeCloneListRequest < TencentCloud::Common::AbstractModel
5731
- # @param InstanceId: 查询指定源实例的克隆任务列表。
5737
+ # @param InstanceId: 查询指定源实例的克隆任务列表。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/api/236/15872) 接口获取实例 ID。
5732
5738
  # @type InstanceId: String
5733
5739
  # @param Offset: 分页查询时的偏移量,默认值为0。
5734
5740
  # @type Offset: Integer
5735
- # @param Limit: 分页查询时的每页条目数,默认值为20。
5741
+ # @param Limit: 分页查询时的每页条目数,默认值为20,建议最大取值100
5736
5742
  # @type Limit: Integer
5737
5743
 
5738
5744
  attr_accessor :InstanceId, :Offset, :Limit
@@ -6253,7 +6259,7 @@ module TencentCloud
6253
6259
 
6254
6260
  # DescribeDBInstanceLogToCLS请求参数结构体
6255
6261
  class DescribeDBInstanceLogToCLSRequest < TencentCloud::Common::AbstractModel
6256
- # @param InstanceId: 实例ID
6262
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
6257
6263
  # @type InstanceId: String
6258
6264
  # @param ClsRegion: CLS服务所在地域
6259
6265
  # @type ClsRegion: String
@@ -6753,7 +6759,7 @@ module TencentCloud
6753
6759
 
6754
6760
  # DescribeDataBackupOverview请求参数结构体
6755
6761
  class DescribeDataBackupOverviewRequest < TencentCloud::Common::AbstractModel
6756
- # @param Product: 需要查询的云数据库产品类型,目前仅支持 "mysql"。
6762
+ # @param Product: 需要查询数据备份概览的云数据库产品类型。可取值为:mysql 指双节点/三节点的高可用实例,mysql-basic 指单节点云盘版实例,mysql-cluster 指云盘版(原集群版)实例。
6757
6763
  # @type Product: String
6758
6764
 
6759
6765
  attr_accessor :Product
@@ -6837,7 +6843,7 @@ module TencentCloud
6837
6843
  # @type InstanceId: String
6838
6844
  # @param Offset: 偏移量,最小值为0。
6839
6845
  # @type Offset: Integer
6840
- # @param Limit: 单次请求数量,默认值为20,最小值为1,最大值为100
6846
+ # @param Limit: 单次请求数量,默认值为20,最小值为1,最大值为5000
6841
6847
  # @type Limit: Integer
6842
6848
  # @param DatabaseRegexp: 匹配数据库库名的正则表达式。
6843
6849
  # @type DatabaseRegexp: String
@@ -6863,7 +6869,7 @@ module TencentCloud
6863
6869
  class DescribeDatabasesResponse < TencentCloud::Common::AbstractModel
6864
6870
  # @param TotalCount: 符合查询条件的实例总数。
6865
6871
  # @type TotalCount: Integer
6866
- # @param Items: 返回的实例信息。
6872
+ # @param Items: 实例中的数据库名称列表。
6867
6873
  # @type Items: Array
6868
6874
  # @param DatabaseList: 数据库名以及字符集
6869
6875
  # @type DatabaseList: Array
@@ -6896,11 +6902,12 @@ module TencentCloud
6896
6902
 
6897
6903
  # DescribeDefaultParams请求参数结构体
6898
6904
  class DescribeDefaultParamsRequest < TencentCloud::Common::AbstractModel
6899
- # @param EngineVersion: 引擎版本,目前支持 ["5.1", "5.5", "5.6", "5.7", "8.0"]
6905
+ # @param EngineVersion: 引擎版本,目前支持 ["5.1", "5.5", "5.6", "5.7", "8.0"]
6906
+ # 说明:引擎版本为必填。
6900
6907
  # @type EngineVersion: String
6901
- # @param TemplateType: 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。
6908
+ # @param TemplateType: 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。默认值为:HIGH_STABILITY。
6902
6909
  # @type TemplateType: String
6903
- # @param EngineType: 参数模板引擎,默认值:InnoDB
6910
+ # @param EngineType: 参数模板引擎,默认值:InnoDB,可取值:InnoDB、RocksDB。
6904
6911
  # @type EngineType: String
6905
6912
 
6906
6913
  attr_accessor :EngineVersion, :TemplateType, :EngineType
@@ -7074,13 +7081,13 @@ module TencentCloud
7074
7081
 
7075
7082
  # DescribeErrorLogData请求参数结构体
7076
7083
  class DescribeErrorLogDataRequest < TencentCloud::Common::AbstractModel
7077
- # @param InstanceId: 实例 ID
7084
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7078
7085
  # @type InstanceId: String
7079
- # @param StartTime: 开始时间戳。例如 1585142640
7086
+ # @param StartTime: 开始时间戳。例如1585142640,秒级。
7080
7087
  # @type StartTime: Integer
7081
- # @param EndTime: 结束时间戳。例如 1585142640
7088
+ # @param EndTime: 结束时间戳。例如1585142640,秒级。
7082
7089
  # @type EndTime: Integer
7083
- # @param KeyWords: 要匹配的关键字列表,最多支持15个关键字。
7090
+ # @param KeyWords: 要匹配的关键字列表,最多支持15个关键字,支持模糊匹配。
7084
7091
  # @type KeyWords: Array
7085
7092
  # @param Limit: 分页的返回数量,默认为100,最大为400。
7086
7093
  # @type Limit: Integer
@@ -7228,7 +7235,7 @@ module TencentCloud
7228
7235
  # @type InstanceId: String
7229
7236
  # @param Offset: 分页偏移量,默认值:0。
7230
7237
  # @type Offset: Integer
7231
- # @param Limit: 分页大小,默认值:20。
7238
+ # @param Limit: 分页大小,默认值:20,最大值为100
7232
7239
  # @type Limit: Integer
7233
7240
 
7234
7241
  attr_accessor :InstanceId, :Offset, :Limit
@@ -7511,7 +7518,7 @@ module TencentCloud
7511
7518
 
7512
7519
  # DescribeParamTemplateInfo请求参数结构体
7513
7520
  class DescribeParamTemplateInfoRequest < TencentCloud::Common::AbstractModel
7514
- # @param TemplateId: 参数模板 ID
7521
+ # @param TemplateId: 参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。
7515
7522
  # @type TemplateId: Integer
7516
7523
 
7517
7524
  attr_accessor :TemplateId
@@ -7531,7 +7538,7 @@ module TencentCloud
7531
7538
  # @type TemplateId: Integer
7532
7539
  # @param Name: 参数模板名称。
7533
7540
  # @type Name: String
7534
- # @param EngineVersion: 参数模板对应实例版本
7541
+ # @param EngineVersion: 参数模板对应实例版本,可取值:5.5、5.6、5.7、8.0。
7535
7542
  # @type EngineVersion: String
7536
7543
  # @param TotalCount: 参数模板中的参数数量
7537
7544
  # @type TotalCount: Integer
@@ -7582,13 +7589,13 @@ module TencentCloud
7582
7589
 
7583
7590
  # DescribeParamTemplates请求参数结构体
7584
7591
  class DescribeParamTemplatesRequest < TencentCloud::Common::AbstractModel
7585
- # @param EngineVersions: 引擎版本,缺省则查询所有
7592
+ # @param EngineVersions: 引擎版本,缺省则查询所有。可取值为:5.5、5.6、5.7、8.0。
7586
7593
  # @type EngineVersions: Array
7587
- # @param EngineTypes: 引擎类型,缺省则查询所有
7594
+ # @param EngineTypes: 引擎类型,缺省则查询所有。可取值为:InnoDB、RocksDB,不区分大小写。
7588
7595
  # @type EngineTypes: Array
7589
- # @param TemplateNames: 模板名称,缺省则查询所有
7596
+ # @param TemplateNames: 模板名称,缺省则查询所有。支持模糊匹配。
7590
7597
  # @type TemplateNames: Array
7591
- # @param TemplateIds: 模板id,缺省则查询所有
7598
+ # @param TemplateIds: 模板 ID,缺省则查询所有。
7592
7599
  # @type TemplateIds: Array
7593
7600
 
7594
7601
  attr_accessor :EngineVersions, :EngineTypes, :TemplateNames, :TemplateIds
@@ -8016,7 +8023,7 @@ module TencentCloud
8016
8023
  # @type InstanceId: String
8017
8024
  # @param AsyncRequestId: 异步任务 ID。
8018
8025
  # @type AsyncRequestId: String
8019
- # @param Limit: 分页参数,每次请求返回的记录数。默认值为 20,最大值为 100。
8026
+ # @param Limit: 分页参数,每次请求返回的记录数。默认值为20,建议最大取值为100。
8020
8027
  # @type Limit: Integer
8021
8028
  # @param Offset: 分页偏移量。默认为 0。
8022
8029
  # @type Offset: Integer
@@ -8117,7 +8124,7 @@ module TencentCloud
8117
8124
 
8118
8125
  # DescribeSlowLogData请求参数结构体
8119
8126
  class DescribeSlowLogDataRequest < TencentCloud::Common::AbstractModel
8120
- # @param InstanceId: 实例 ID
8127
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
8121
8128
  # @type InstanceId: String
8122
8129
  # @param StartTime: 开始时间戳。例如 1585142640。
8123
8130
  # 说明:此参数单位为秒的时间戳。
@@ -8131,13 +8138,18 @@ module TencentCloud
8131
8138
  # @type UserNames: Array
8132
8139
  # @param DataBases: 访问的 数据库 列表。
8133
8140
  # @type DataBases: Array
8134
- # @param SortBy: 排序字段。当前支持:Timestamp,QueryTime,LockTime,RowsExamined,RowsSent
8141
+ # @param SortBy: 排序字段,当前支持字段及含义如下,默认值为 Timestamp。
8142
+ # 1. Timestamp:SQL 的执行时间
8143
+ # 2. QueryTime:SQL 的执行时长(秒)
8144
+ # 3. LockTime:锁时长(秒)
8145
+ # 4. RowsExamined:扫描行数
8146
+ # 5. RowsSent:结果集行数
8135
8147
  # @type SortBy: String
8136
- # @param OrderBy: 升序还是降序排列。当前支持:ASC,DESC 。
8148
+ # @param OrderBy: 升序还是降序排列。当前支持值为 ASC - 升序,DESC - 降序 ,默认值为 ASC
8137
8149
  # @type OrderBy: String
8138
8150
  # @param Offset: 偏移量,默认为0,最大为9999。
8139
8151
  # @type Offset: Integer
8140
- # @param Limit: 一次性返回的记录数量,默认为100,最大为400
8152
+ # @param Limit: 一次性返回的记录数量,默认为100,最大为800
8141
8153
  # @type Limit: Integer
8142
8154
  # @param InstType: 仅在实例为主实例或者灾备实例时生效,可选值:slave,代表拉取从机的日志。
8143
8155
  # @type InstType: String
@@ -8214,7 +8226,7 @@ module TencentCloud
8214
8226
  # @type InstanceId: String
8215
8227
  # @param Offset: 偏移量,默认值为0,最小值为0。
8216
8228
  # @type Offset: Integer
8217
- # @param Limit: 分页大小,默认值为20,最小值为1,最大值为100
8229
+ # @param Limit: 分页大小,默认值为20,最小值为1,最大值为1000
8218
8230
  # @type Limit: Integer
8219
8231
 
8220
8232
  attr_accessor :InstanceId, :Offset, :Limit
@@ -8313,9 +8325,9 @@ module TencentCloud
8313
8325
 
8314
8326
  # DescribeTableColumns请求参数结构体
8315
8327
  class DescribeTableColumnsRequest < TencentCloud::Common::AbstractModel
8316
- # @param InstanceId: 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
8328
+ # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
8317
8329
  # @type InstanceId: String
8318
- # @param Database: 数据库名称,可使用[查询数据库](https://cloud.tencent.com/document/api/236/17493)接口获得。
8330
+ # @param Database: 数据库名称,可使用 [查询数据库](https://cloud.tencent.com/document/api/236/17493) 接口获得。
8319
8331
  # @type Database: String
8320
8332
  # @param Table: 数据库中的表的名称。
8321
8333
  # @type Table: String
@@ -8367,7 +8379,7 @@ module TencentCloud
8367
8379
  # @type Database: String
8368
8380
  # @param Offset: 记录偏移量,默认值为0。
8369
8381
  # @type Offset: Integer
8370
- # @param Limit: 单次请求返回的数量,默认值为20,最大值为2000
8382
+ # @param Limit: 单次请求返回的数量,默认值为20,最大值为5000
8371
8383
  # @type Limit: Integer
8372
8384
  # @param TableRegexp: 匹配数据库表名的正则表达式,规则同 MySQL 官网
8373
8385
  # @type TableRegexp: String
@@ -8926,7 +8938,7 @@ module TencentCloud
8926
8938
 
8927
8939
  # 结构化的错误日志详情
8928
8940
  class ErrlogItem < TencentCloud::Common::AbstractModel
8929
- # @param Timestamp: 错误发生时间。
8941
+ # @param Timestamp: 错误发生时间。时间戳,秒级
8930
8942
  # @type Timestamp: Integer
8931
8943
  # @param Content: 错误详情
8932
8944
  # @type Content: String
@@ -10503,19 +10515,23 @@ module TencentCloud
10503
10515
 
10504
10516
  # ModifyBackupConfig请求参数结构体
10505
10517
  class ModifyBackupConfigRequest < TencentCloud::Common::AbstractModel
10506
- # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。
10518
+ # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
10507
10519
  # @type InstanceId: String
10508
- # @param ExpireDays: 备份文件的保留时间,单位为天。最小值为7天,最大值为1830天。
10520
+ # @param ExpireDays: 数据备份文件的保留时间,单位为天。
10521
+ # 1. MySQL 双节点、三节点、云盘版数据备份文件可以保留7天 - 1830天。
10522
+ # 2. MySQL 单节点(云盘)数据备份文件可以保留7天 - 30天。
10509
10523
  # @type ExpireDays: Integer
10510
10524
  # @param StartTime: (将废弃,建议使用 BackupTimeWindow 参数) 备份时间范围,格式为:02:00-06:00,起点和终点时间目前限制为整点,目前可以选择的范围为: 00:00-12:00,02:00-06:00,06:00-10:00,10:00-14:00,14:00-18:00,18:00-22:00,22:00-02:00。
10511
10525
  # @type StartTime: String
10512
10526
  # @param BackupMethod: 自动备份方式,仅支持:physical - 物理冷备
10513
10527
  # @type BackupMethod: String
10514
- # @param BinlogExpireDays: binlog的保留时间,单位为天。最小值为7天,最大值为1830天。该值的设置不能大于备份文件的保留时间。
10528
+ # @param BinlogExpireDays: binlog 的保留时间,单位为天。
10529
+ # 1. MySQL 双节点、三节点、云盘版日志备份文件可以保留7天 - 3650天。
10530
+ # 2. MySQL 单节点(云盘)日志备份文件可以保留7天 - 30天。
10515
10531
  # @type BinlogExpireDays: Integer
10516
10532
  # @param BackupTimeWindow: 备份时间窗,比如要设置每周二和周日 10:00-14:00之间备份,该参数如下:{"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (注:可以设置一周的某几天备份,但是每天的备份时间需要设置为相同的时间段。 如果设置了该字段,将忽略StartTime字段的设置)
10517
10533
  # @type BackupTimeWindow: :class:`Tencentcloud::Cdb.v20170320.models.CommonTimeWindow`
10518
- # @param EnableBackupPeriodSave: 定期保留开关,off - 不开启定期保留策略,on - 开启定期保留策略,默认为off。首次开启定期保留策略时,BackupPeriodSaveDays,BackupPeriodSaveInterval,BackupPeriodSaveCount,StartBackupPeriodSaveDate参数为必填项,否则定期保留策略不会生效
10534
+ # @param EnableBackupPeriodSave: 定期保留开关,off - 不开启定期保留策略,on - 开启定期保留策略,默认为off
10519
10535
  # @type EnableBackupPeriodSave: String
10520
10536
  # @param EnableBackupPeriodLongTermSave: 长期保留开关,该字段功能暂未上线,可忽略。off - 不开启长期保留策略,on - 开启长期保留策略,默认为off,如果开启,则BackupPeriodSaveDays,BackupPeriodSaveInterval,BackupPeriodSaveCount参数无效
10521
10537
  # @type EnableBackupPeriodLongTermSave: String
@@ -10842,25 +10858,27 @@ module TencentCloud
10842
10858
 
10843
10859
  # ModifyDBInstanceLogToCLS请求参数结构体
10844
10860
  class ModifyDBInstanceLogToCLSRequest < TencentCloud::Common::AbstractModel
10845
- # @param InstanceId: 实例ID
10861
+ # @param InstanceId: 实例 ID,可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10846
10862
  # @type InstanceId: String
10847
- # @param LogType: 日志类型:error/slowlog
10863
+ # @param LogType: 日志类型。error:错误日志,slowlog:慢日志。
10848
10864
  # @type LogType: String
10849
- # @param Status: 投递状态:ON/OFF
10865
+ # @param Status: 投递状态。ON:开启,OFF:关闭。
10850
10866
  # @type Status: String
10851
- # @param CreateLogset: 是否需要创建日志集
10867
+ # @param CreateLogset: 是否需要创建日志集。默认为 false。
10852
10868
  # @type CreateLogset: Boolean
10853
- # @param Logset: 需要创建日志集时为日志集名称;选择已有日志集时,为日志集ID
10869
+ # @param Logset: 需要创建日志集时为日志集名称;选择已有日志集时,为日志集 ID。默认为空。
10870
+ # 说明:当参数 Status 的值为 ON 时,Logset 和 LogTopic 参数必须填一个。
10854
10871
  # @type Logset: String
10855
- # @param CreateLogTopic: 是否需要创建日志主题
10872
+ # @param CreateLogTopic: 是否需要创建日志主题。默认为 false。
10856
10873
  # @type CreateLogTopic: Boolean
10857
- # @param LogTopic: 需要创建日志主题时为日志主题名称;选择已有日志主题时,为日志主题ID
10874
+ # @param LogTopic: 需要创建日志主题时为日志主题名称;选择已有日志主题时,为日志主题 ID。默认为空。
10875
+ # 说明:当参数 Status 的值为 ON 时,Logset 和 LogTopic 参数必须填一个。
10858
10876
  # @type LogTopic: String
10859
- # @param Period: 日志主题有效期,不填写时,默认30
10877
+ # @param Period: 日志主题有效期,不填写时,默认30天,最大值3600。
10860
10878
  # @type Period: Integer
10861
- # @param CreateIndex: 创建日志主题时,是否创建索引
10879
+ # @param CreateIndex: 创建日志主题时,是否创建索引,默认为 false。
10862
10880
  # @type CreateIndex: Boolean
10863
- # @param ClsRegion: CLS所在地域
10881
+ # @param ClsRegion: CLS 所在地域,不填择默认为 Region 的参数值。
10864
10882
  # @type ClsRegion: String
10865
10883
 
10866
10884
  attr_accessor :InstanceId, :LogType, :Status, :CreateLogset, :Logset, :CreateLogTopic, :LogTopic, :Period, :CreateIndex, :ClsRegion
@@ -11310,11 +11328,15 @@ module TencentCloud
11310
11328
 
11311
11329
  # ModifyLocalBinlogConfig请求参数结构体
11312
11330
  class ModifyLocalBinlogConfigRequest < TencentCloud::Common::AbstractModel
11313
- # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。
11331
+ # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
11314
11332
  # @type InstanceId: String
11315
- # @param SaveHours: 本地binlog保留时长,可取值范围:[72,168],当实例存在灾备实例时,可取值范围:[120,168]。
11333
+ # @param SaveHours: 本地 binlog 保留时长。不同实例的可取值如下:
11334
+ # 1. 云盘版实例、双节点实例、三节点实例的本地 binlog 保留时长(小时)默认为120,范围:6 - 168。
11335
+ # 2. 灾备实例的本地 binlog 保留时长(小时)默认为120,范围:120 - 168。
11336
+ # 3. 单节点云盘实例的本地 binlog 保留时长(小时)默认为120,范围:0 - 168。
11337
+ # 4. 若双节点实例、三节点实例下无灾备实例,则该主实例的本地 binlog 保留时长(小时)范围是:6 - 168;若双节点实例、三节点实例下有灾备实例,或者要为双节点实例、三节点实例添加灾备实例,为避免同步异常,该主实例的本地 binlog 保留时长(小时)不能设置低于120小时,范围是:120 - 168。
11316
11338
  # @type SaveHours: Integer
11317
- # @param MaxUsage: 本地binlog空间使用率,可取值范围:[30,50]。
11339
+ # @param MaxUsage: 本地 binlog 空间使用率,可取值范围:[30,50]。
11318
11340
  # @type MaxUsage: Integer
11319
11341
 
11320
11342
  attr_accessor :InstanceId, :SaveHours, :MaxUsage
@@ -11390,9 +11412,9 @@ module TencentCloud
11390
11412
 
11391
11413
  # ModifyParamTemplate请求参数结构体
11392
11414
  class ModifyParamTemplateRequest < TencentCloud::Common::AbstractModel
11393
- # @param TemplateId: 模板 ID
11415
+ # @param TemplateId: 模板 ID。可通过 [DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/236/32660) 接口获取。
11394
11416
  # @type TemplateId: Integer
11395
- # @param Name: 模板名称,长度不超过64
11417
+ # @param Name: 模板名称,仅支持数字、英文大小写字母、中文以及特殊字符_-./()()[]+=::@,且长度不能超过60
11396
11418
  # @type Name: String
11397
11419
  # @param Description: 模板描述,长度不超过255。
11398
11420
  # @type Description: String
@@ -12076,17 +12098,17 @@ module TencentCloud
12076
12098
 
12077
12099
  # 参数模板信息
12078
12100
  class ParamTemplateInfo < TencentCloud::Common::AbstractModel
12079
- # @param TemplateId: 参数模板ID
12101
+ # @param TemplateId: 参数模板 ID
12080
12102
  # @type TemplateId: Integer
12081
12103
  # @param Name: 参数模板名称
12082
12104
  # @type Name: String
12083
12105
  # @param Description: 参数模板描述
12084
12106
  # @type Description: String
12085
- # @param EngineVersion: 实例引擎版本
12107
+ # @param EngineVersion: 实例引擎版本,值为:5.5、5.6、5.7、8.0。
12086
12108
  # @type EngineVersion: String
12087
- # @param TemplateType: 参数模板类型
12109
+ # @param TemplateType: 参数模板类型,值为:HIGH_STABILITY、HIGH_PERFORMANCE。
12088
12110
  # @type TemplateType: String
12089
- # @param EngineType: 参数模板引擎
12111
+ # @param EngineType: 参数模板引擎,值为:InnoDB、RocksDB。
12090
12112
  # @type EngineType: String
12091
12113
 
12092
12114
  attr_accessor :TemplateId, :Name, :Description, :EngineVersion, :TemplateType, :EngineType
@@ -13173,15 +13195,15 @@ module TencentCloud
13173
13195
 
13174
13196
  # 用于回档的实例详情
13175
13197
  class RollbackInstancesInfo < TencentCloud::Common::AbstractModel
13176
- # @param InstanceId: 云数据库实例ID
13198
+ # @param InstanceId: 云数据库实例 ID
13177
13199
  # @type InstanceId: String
13178
- # @param Strategy: 回档策略。可选值为:table、db、full;默认值为full。table - 极速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和binlog,速度较慢。
13200
+ # @param Strategy: 回档策略。可选值为:table、db、full。table - 极速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和 binlog,速度较慢。
13179
13201
  # @type Strategy: String
13180
- # @param RollbackTime: 数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss
13202
+ # @param RollbackTime: 数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss
13181
13203
  # @type RollbackTime: String
13182
- # @param Databases: 待回档的数据库信息,表示整库回档
13204
+ # @param Databases: 待回档的数据库信息,表示整库回档。
13183
13205
  # @type Databases: Array
13184
- # @param Tables: 待回档的数据库表信息,表示按表回档
13206
+ # @param Tables: 待回档的数据库表信息,表示按表回档。
13185
13207
  # @type Tables: Array
13186
13208
 
13187
13209
  attr_accessor :InstanceId, :Strategy, :RollbackTime, :Databases, :Tables
@@ -13622,7 +13644,7 @@ module TencentCloud
13622
13644
 
13623
13645
  # 结构化的慢日志详情
13624
13646
  class SlowLogItem < TencentCloud::Common::AbstractModel
13625
- # @param Timestamp: Sql的执行时间。
13647
+ # @param Timestamp: Sql的执行时间。秒级时间戳。
13626
13648
  # @type Timestamp: Integer
13627
13649
  # @param QueryTime: Sql的执行时长(秒)。
13628
13650
  # @type QueryTime: Float
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-cdb
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1106
4
+ version: 3.0.1114
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-22 00:00:00.000000000 Z
11
+ date: 2025-07-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common