tencentcloud-sdk-dbbrain 3.0.1143 → 3.0.1150

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.
@@ -113,7 +113,7 @@ module TencentCloud
113
113
  # @type ReceiveType: Array
114
114
  # @param ReceiveInfo: 接收用户信息
115
115
  # @type ReceiveInfo: Array
116
- # @param UpdateTime: 更新时间
116
+ # @param UpdateTime: 更新时间,格式: "yyyy-MM-dd HH:mm:ss"
117
117
  # @type UpdateTime: String
118
118
  # @param TemplateName: 模板名
119
119
  # @type TemplateName: String
@@ -346,9 +346,9 @@ module TencentCloud
346
346
  # @type DownloadUrl: String
347
347
  # @param ErrMsg: 错误信息。
348
348
  # @type ErrMsg: String
349
- # @param Progress: 文件生成进度。
349
+ # @param Progress: 文件生成进度。(单位:%)
350
350
  # @type Progress: Float
351
- # @param FinishTime: 文件生成成功时间。
351
+ # @param FinishTime: 文件生成成功时间。格式: "yyyy-MM-dd HH:mm:ss"
352
352
  # @type FinishTime: String
353
353
 
354
354
  attr_accessor :AsyncRequestId, :FileName, :CreateTime, :Status, :FileSize, :DownloadUrl, :ErrMsg, :Progress, :FinishTime
@@ -422,19 +422,24 @@ module TencentCloud
422
422
  # @type EventId: Integer
423
423
  # @param Type: 类型:支持RedisAutoScaleUp
424
424
  # @type Type: String
425
- # @param TriggerTime: 自治任务触发时间。
425
+ # @param TriggerTime: 自治任务触发时间。格式: "yyyy-MM-dd HH:mm:ss"
426
426
  # @type TriggerTime: String
427
- # @param CreateTime: 自治任务创建时间。
427
+ # @param CreateTime: 自治任务创建时间。格式: "yyyy-MM-dd HH:mm:ss"
428
428
  # @type CreateTime: String
429
- # @param UpdateTime: 自治任务更新时间
429
+ # @param UpdateTime: 自治任务更新时间,格式: "yyyy-MM-dd HH:mm:ss"
430
430
  # @type UpdateTime: String
431
- # @param FinishTime: 自治任务完成时间。
431
+ # @param FinishTime: 自治任务完成时间。格式: "yyyy-MM-dd HH:mm:ss"
432
432
  # @type FinishTime: String
433
433
  # @param ExpireTime: 剩余时间,单位:秒。
434
434
  # @type ExpireTime: Integer
435
435
  # @param Reason: 触发原因。
436
436
  # @type Reason: String
437
- # @param Status: 自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED
437
+ # @param Status: 自治任务状态:RUNNING,FINISHED,TERMINATED,CANCELLED
438
+ # 其中:
439
+ # RUNNING - 运行中
440
+ # FINISHED - 已完成
441
+ # TERMINATED - 已终止
442
+ # CANCELLED - 已取消
438
443
  # @type Status: String
439
444
 
440
445
  attr_accessor :ActionId, :EventId, :Type, :TriggerTime, :CreateTime, :UpdateTime, :FinishTime, :ExpireTime, :Reason, :Status
@@ -516,7 +521,10 @@ module TencentCloud
516
521
 
517
522
  # 自治用户配置详情
518
523
  class AutonomyUserProfileInfo < TencentCloud::Common::AbstractModel
519
- # @param Enabled: 是否开启自治。
524
+ # @param Enabled: 是否开启自治。枚举值:true,false。
525
+ # 其中:
526
+ # true - 开启
527
+ # false - 关闭
520
528
  # @type Enabled: Boolean
521
529
  # @param Uin: 用户Uin。
522
530
  # @type Uin: String
@@ -717,9 +725,9 @@ module TencentCloud
717
725
  class CloseAuditServiceRequest < TencentCloud::Common::AbstractModel
718
726
  # @param Product: 服务产品类型,支持值包括: "dcdb" - 云数据库 Tdsql, "mariadb" - 云数据库 MariaDB。
719
727
  # @type Product: String
720
- # @param NodeRequestType: Product保持一致。如:"dcdb" ,"mariadb"。
728
+ # @param NodeRequestType: NodeRequestType主要标识数据库产品类型,与Product保持一致。如:"dcdb" ,"mariadb"。
721
729
  # @type NodeRequestType: String
722
- # @param InstanceId: 实例Id。
730
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
723
731
  # @type InstanceId: String
724
732
 
725
733
  attr_accessor :Product, :NodeRequestType, :InstanceId
@@ -838,11 +846,11 @@ module TencentCloud
838
846
  # @type Product: String
839
847
  # @param NodeRequestType: 与Product保持一致。如:"dcdb" ,"mariadb"
840
848
  # @type NodeRequestType: String
841
- # @param InstanceId: 实例 ID
849
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
842
850
  # @type InstanceId: String
843
- # @param StartTime: 开始时间,如“2019-09-10 12:13:14”。
851
+ # @param StartTime: 开始时间,如“2025-03-17T00:00:00+00:00”。
844
852
  # @type StartTime: String
845
- # @param EndTime: 截止时间,如“2019-09-11 10:13:14”。
853
+ # @param EndTime: 结束时间,如“2025-03-17T01:00:00+00:00”。
846
854
  # @type EndTime: String
847
855
  # @param Filter: 过滤条件。可按设置的过滤条件过滤日志。
848
856
  # @type Filter: :class:`Tencentcloud::Dbbrain.v20210527.models.AuditLogFilter`
@@ -893,7 +901,7 @@ module TencentCloud
893
901
 
894
902
  # CreateDBDiagReportTask请求参数结构体
895
903
  class CreateDBDiagReportTaskRequest < TencentCloud::Common::AbstractModel
896
- # @param InstanceId: 实例ID
904
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
897
905
  # @type InstanceId: String
898
906
  # @param StartTime: 开始时间,如“2020-11-08T14:00:00+08:00”。
899
907
  # @type StartTime: String
@@ -905,7 +913,7 @@ module TencentCloud
905
913
  # @type ContactPerson: Array
906
914
  # @param ContactGroup: 接收邮件的联系组ID数组。
907
915
  # @type ContactGroup: Array
908
- # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL"cynosdb" - 云数据库 CynosDB for MySQL,"redis" - 云数据库 Redis,默认值为"mysql"。
916
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL"cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis"mongodb" - 云数据库 MongoDB,"mariadb" - 云数据库 MariaDB,"dcdb" - 云数据库 TDSQL MySQL,默认为"mysql"。
909
917
  # @type Product: String
910
918
 
911
919
  attr_accessor :InstanceId, :StartTime, :EndTime, :SendMailFlag, :ContactPerson, :ContactGroup, :Product
@@ -953,11 +961,12 @@ module TencentCloud
953
961
 
954
962
  # CreateDBDiagReportUrl请求参数结构体
955
963
  class CreateDBDiagReportUrlRequest < TencentCloud::Common::AbstractModel
956
- # @param InstanceId: 实例ID
964
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
965
+ # 示例值:cdb-dctw4edd
957
966
  # @type InstanceId: String
958
- # @param AsyncRequestId: 健康报告相应的任务ID,可通过DescribeDBDiagReportTasks查询。
967
+ # @param AsyncRequestId: 健康报告相应的任务ID,可通过[DescribeDBDiagReportTasks](https://cloud.tencent.com/document/product/1130/54873)查询。
959
968
  # @type AsyncRequestId: Integer
960
- # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis,默认为"mysql"。
969
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis,"mongodb" - 云数据库 MongoDB,"mariadb" - 云数据库 MariaDB,"dcdb" - 云数据库 TDSQL MySQL,默认为"mysql"。
961
970
  # @type Product: String
962
971
 
963
972
  attr_accessor :InstanceId, :AsyncRequestId, :Product
@@ -1077,13 +1086,13 @@ module TencentCloud
1077
1086
  # @type ProfileInfo: :class:`Tencentcloud::Dbbrain.v20210527.models.ProfileInfo`
1078
1087
  # @param ProfileLevel: 配置级别,支持值包括:"User" - 用户级别,"Instance" - 实例级别,其中数据库巡检邮件配置为用户级别,定期生成邮件配置为实例级别。
1079
1088
  # @type ProfileLevel: String
1080
- # @param ProfileName: 配置名称,需要保持唯一性,数据库巡检邮件配置名称自拟;定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"schduler_cdb-test"。
1089
+ # @param ProfileName: 配置名称,需要保持唯一性,数据库巡检邮件配置名称自拟;定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"scheduler_cdb-test"。
1081
1090
  # @type ProfileName: String
1082
1091
  # @param ProfileType: 配置类型,支持值包括:"dbScan_mail_configuration" - 数据库巡检邮件配置,"scheduler_mail_configuration" - 定期生成邮件配置。
1083
1092
  # @type ProfileType: String
1084
- # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL"cynosdb" - 云数据库 CynosDB for MySQL。
1093
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL"cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis,"mongodb" - 云数据库 MongoDB,"mariadb" - 云数据库 MariaDB,"dcdb" - 云数据库 TDSQL MySQL,默认为"mysql"
1085
1094
  # @type Product: String
1086
- # @param BindInstanceIds: 配置绑定的实例ID,当配置级别为"Instance"时需要传入且只能为一个实例;当配置级别为“User”时,此参数不填。
1095
+ # @param BindInstanceIds: 配置绑定的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。当配置级别为"Instance"时需要传入且只能为一个实例;当配置级别为“User”时,此参数不填。
1087
1096
  # @type BindInstanceIds: Array
1088
1097
 
1089
1098
  attr_accessor :ProfileInfo, :ProfileLevel, :ProfileName, :ProfileType, :Product, :BindInstanceIds
@@ -1172,7 +1181,7 @@ module TencentCloud
1172
1181
 
1173
1182
  # CreateRedisBigKeyAnalysisTask请求参数结构体
1174
1183
  class CreateRedisBigKeyAnalysisTaskRequest < TencentCloud::Common::AbstractModel
1175
- # @param InstanceId: 实例ID
1184
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1176
1185
  # @type InstanceId: String
1177
1186
  # @param Product: 服务产品类型,支持值包括 "redis" - 云数据库 Redis。
1178
1187
  # @type Product: String
@@ -1225,11 +1234,11 @@ module TencentCloud
1225
1234
  # @type WeekConfiguration: Array
1226
1235
  # @param ProfileInfo: 邮件配置内容。
1227
1236
  # @type ProfileInfo: :class:`Tencentcloud::Dbbrain.v20210527.models.ProfileInfo`
1228
- # @param ProfileName: 配置名称,需要保持唯一性,定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"schduler_cdb-test"。
1237
+ # @param ProfileName: 配置名称,需要保持唯一性,定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"scheduler_cdb-test"。
1229
1238
  # @type ProfileName: String
1230
- # @param BindInstanceId: 配置订阅的实例ID
1239
+ # @param BindInstanceId: 配置订阅的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1231
1240
  # @type BindInstanceId: String
1232
- # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1241
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL"cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis,"mongodb" - 云数据库 MongoDB,"mariadb" - 云数据库 MariaDB,"dcdb" - 云数据库 TDSQL MySQL,默认为"mysql"。
1233
1242
  # @type Product: String
1234
1243
 
1235
1244
  attr_accessor :WeekConfiguration, :ProfileInfo, :ProfileName, :BindInstanceId, :Product
@@ -1324,9 +1333,15 @@ module TencentCloud
1324
1333
 
1325
1334
  # CreateSqlFilter请求参数结构体
1326
1335
  class CreateSqlFilterRequest < TencentCloud::Common::AbstractModel
1327
- # @param InstanceId: 实例ID
1336
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1328
1337
  # @type InstanceId: String
1329
- # @param SqlType: SQL类型,取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE。
1338
+ # @param SqlType: SQL语句的类型,取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE。
1339
+ # 其中:
1340
+ # SELECT - 查询
1341
+ # UPDATE - 更新
1342
+ # DELETE - 删除
1343
+ # INSERT - 插入
1344
+ # REPLACE - 替换
1330
1345
  # @type SqlType: String
1331
1346
  # @param FilterKey: 关键字,用于筛选SQL语句,多个关键字用英文逗号分隔,逗号不能作为关键词,多个关键词之间的关系为“逻辑与”。
1332
1347
  # @type FilterKey: String
@@ -1334,7 +1349,7 @@ module TencentCloud
1334
1349
  # @type MaxConcurrency: Integer
1335
1350
  # @param Duration: 限流时长,单位秒,支持-1和小于2147483647的正整数,-1表示永不过期。
1336
1351
  # @type Duration: Integer
1337
- # @param SessionToken: 通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
1352
+ # @param SessionToken: 通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
1338
1353
  # @type SessionToken: String
1339
1354
  # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1340
1355
  # @type Product: String
@@ -1384,9 +1399,9 @@ module TencentCloud
1384
1399
 
1385
1400
  # CreateUserAutonomyProfile请求参数结构体
1386
1401
  class CreateUserAutonomyProfileRequest < TencentCloud::Common::AbstractModel
1387
- # @param ProfileType: 配置类型,为需要配置的功能枚举值,目前包含一下枚举值:AutonomyGlobal(自治功能全局配置)、RedisAutoScaleUp(Redis自治扩容配置)
1402
+ # @param ProfileType: 配置类型,为需要配置的功能枚举值,目前包含以下枚举值:AutonomyGlobal(自治功能全局配置)、RedisAutoScaleUp(Redis自治扩容配置)
1388
1403
  # @type ProfileType: String
1389
- # @param InstanceId: 实列ID
1404
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1390
1405
  # @type InstanceId: String
1391
1406
  # @param Product: 服务产品类型,支持值包括: "redis" - 云数据库 Redis。
1392
1407
  # @type Product: String
@@ -1428,13 +1443,13 @@ module TencentCloud
1428
1443
 
1429
1444
  # DeleteAuditLogFile请求参数结构体
1430
1445
  class DeleteAuditLogFileRequest < TencentCloud::Common::AbstractModel
1431
- # @param Product: 服务产品类型,支持值包括: "dcdb" - 云数据库 Tdsql, "mariadb" - 云数据库 MariaDB for MariaDB。
1446
+ # @param Product: 服务产品类型,支持值包括: "dcdb" - 云数据库 Tdsql, "mariadb" - 云数据库 MariaDB for MariaDB, "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL, "postgres" - 云数据库 PostgreSQL
1432
1447
  # @type Product: String
1433
- # @param NodeRequestType: Product保持一致。如:"dcdb" ,"mariadb"
1448
+ # @param NodeRequestType: NodeRequestType主要标识数据库产品类型,与Product保持一致。该字段规则如下: 当product为"dcdb"则输入"dcdb", 当product为"mariadb"则输入"mariadb", 当product为"mysql"则输入"mysql", 当product为"cynosdb"则输入"mysql", 当product为"postgres"则输入"postgres"。
1434
1449
  # @type NodeRequestType: String
1435
- # @param InstanceId: 实例 ID
1450
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1436
1451
  # @type InstanceId: String
1437
- # @param AsyncRequestId: 审计日志文件生成异步任务ID
1452
+ # @param AsyncRequestId: 审计日志文件生成异步任务ID。可通过[查询审计日志文件](https://cloud.tencent.com/document/product/1130/90371)获得。
1438
1453
  # @type AsyncRequestId: Integer
1439
1454
 
1440
1455
  attr_accessor :Product, :NodeRequestType, :InstanceId, :AsyncRequestId
@@ -1472,11 +1487,11 @@ module TencentCloud
1472
1487
 
1473
1488
  # DeleteDBDiagReportTasks请求参数结构体
1474
1489
  class DeleteDBDiagReportTasksRequest < TencentCloud::Common::AbstractModel
1475
- # @param AsyncRequestIds: 需要删除的任务id列表
1490
+ # @param AsyncRequestIds: 需要删除的任务id列表。可通过[查询健康报告生成任务列表](https://cloud.tencent.com/document/product/1130/57805)获取
1476
1491
  # @type AsyncRequestIds: Array
1477
- # @param InstanceId: 实例ID
1492
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1478
1493
  # @type InstanceId: String
1479
- # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1494
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,"dbbrain-mysql" - 自建 MySQL,"redis" - 云数据库 Redis,默认为"mysql"。
1480
1495
  # @type Product: String
1481
1496
 
1482
1497
  attr_accessor :AsyncRequestIds, :InstanceId, :Product
@@ -1600,11 +1615,11 @@ module TencentCloud
1600
1615
 
1601
1616
  # DeleteSqlFilters请求参数结构体
1602
1617
  class DeleteSqlFiltersRequest < TencentCloud::Common::AbstractModel
1603
- # @param InstanceId: 实例ID
1618
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1604
1619
  # @type InstanceId: String
1605
- # @param FilterIds: 限流任务ID列表。
1620
+ # @param FilterIds: 限流任务ID列表。通过接口[创建实例SQL限流任务](https://cloud.tencent.com/document/product/1130/72835)获得。
1606
1621
  # @type FilterIds: Array
1607
- # @param SessionToken: 通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
1622
+ # @param SessionToken: 通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
1608
1623
  # @type SessionToken: String
1609
1624
  # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1610
1625
  # @type Product: String
@@ -1646,12 +1661,11 @@ module TencentCloud
1646
1661
  class DescribeAlarmTemplateRequest < TencentCloud::Common::AbstractModel
1647
1662
  # @param TemplateNameRegexp: 搜索字段
1648
1663
  # @type TemplateNameRegexp: String
1649
- # @param Limit: 返回限制长度
1664
+ # @param Limit: 返回限制长度,最大值: 50,默认值: 50
1650
1665
  # @type Limit: Integer
1651
- # @param Offset: 偏置
1666
+ # @param Offset: 偏置,最大值: 无限制,默认值: 0
1652
1667
  # @type Offset: Integer
1653
- # @param Product: mysql - mysql
1654
- # cynosdb - tdsql-c
1668
+ # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL
1655
1669
  # @type Product: String
1656
1670
 
1657
1671
  attr_accessor :TemplateNameRegexp, :Limit, :Offset, :Product
@@ -1808,7 +1822,7 @@ module TencentCloud
1808
1822
  class DescribeAuditInstanceListRequest < TencentCloud::Common::AbstractModel
1809
1823
  # @param Product: 服务产品类型,支持值包括: "dcdb" - 云数据库 Tdsql, "mariadb" - 云数据库 MariaDB。
1810
1824
  # @type Product: String
1811
- # @param NodeRequestType: Product保持一致。如:"dcdb" ,"mariadb"。
1825
+ # @param NodeRequestType: NodeRequestType主要标识数据库产品类型,与Product保持一致。如:"dcdb" ,"mariadb"。
1812
1826
  # @type NodeRequestType: String
1813
1827
  # @param AuditSwitch: 审计状态标识,0-未开通审计;1-已开通审计,默认为0。
1814
1828
  # @type AuditSwitch: Integer
@@ -1816,7 +1830,7 @@ module TencentCloud
1816
1830
  # @type Offset: Integer
1817
1831
  # @param Limit: 查询数目,默认为20,最大为100。
1818
1832
  # @type Limit: Integer
1819
- # @param Filters: 查询实例的搜索条件。
1833
+ # @param Filters: 查询实例的搜索条件。Name包括:InstanceId, InstanceName。
1820
1834
  # @type Filters: Array
1821
1835
 
1822
1836
  attr_accessor :Product, :NodeRequestType, :AuditSwitch, :Offset, :Limit, :Filters
@@ -1884,7 +1898,7 @@ module TencentCloud
1884
1898
  # @type Product: String
1885
1899
  # @param NodeRequestType: 该字段规则如下: 当product为"dcdb"则输入"dcdb", 当product为"mariadb"则输入"mariadb", 当product为"mysql"则输入"mysql", 当product为"cynosdb"则输入"mysql", 当product为"postgres"则输入"postgres"。
1886
1900
  # @type NodeRequestType: String
1887
- # @param InstanceId: 实例 ID
1901
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1888
1902
  # @type InstanceId: String
1889
1903
  # @param Offset: 偏移量,默认为0。
1890
1904
  # @type Offset: Integer
@@ -1943,9 +1957,9 @@ module TencentCloud
1943
1957
 
1944
1958
  # DescribeDBAutonomyAction请求参数结构体
1945
1959
  class DescribeDBAutonomyActionRequest < TencentCloud::Common::AbstractModel
1946
- # @param ActionId: 自治任务ID
1960
+ # @param ActionId: 自治任务ID。可通过 [DescribeDBAutonomyActions](https://cloud.tencent.com/document/product/1130/116974) 接口获取。
1947
1961
  # @type ActionId: Integer
1948
- # @param InstanceId: 实列ID
1962
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
1949
1963
  # @type InstanceId: String
1950
1964
  # @param Product: 服务产品类型,支持值包括: "redis" - 云数据库 Redis。
1951
1965
  # @type Product: String
@@ -1975,19 +1989,24 @@ module TencentCloud
1975
1989
  # @type TaskId: Integer
1976
1990
  # @param Type: 类型:支持RedisAutoScaleUp
1977
1991
  # @type Type: String
1978
- # @param TriggerTime: 自治任务触发时间。
1992
+ # @param TriggerTime: 自治任务触发时间。格式: "yyyy-MM-dd HH:mm:ss"
1979
1993
  # @type TriggerTime: String
1980
- # @param CreateTime: 自治任务创建时间。
1994
+ # @param CreateTime: 自治任务创建时间。格式: "yyyy-MM-dd HH:mm:ss"
1981
1995
  # @type CreateTime: String
1982
- # @param UpdateTime: 自治任务更新时间。
1996
+ # @param UpdateTime: 自治任务更新时间。格式: "yyyy-MM-dd HH:mm:ss"
1983
1997
  # @type UpdateTime: String
1984
- # @param FinishTime: 自治任务完成时间。
1998
+ # @param FinishTime: 自治任务完成时间。格式: "yyyy-MM-dd HH:mm:ss"
1985
1999
  # @type FinishTime: String
1986
2000
  # @param ExpireTime: 剩余时间,单位:秒。
1987
2001
  # @type ExpireTime: Integer
1988
2002
  # @param Reason: 触发原因。
1989
2003
  # @type Reason: String
1990
2004
  # @param Status: 自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED
2005
+ # 其中:
2006
+ # RUNNING - 运行中
2007
+ # FINISHED - 已完成
2008
+ # TERMINATED - 已终止
2009
+ # CANCELLED - 已取消
1991
2010
  # @type Status: String
1992
2011
  # @param Info: 任务相关的图表等信息。
1993
2012
  # @type Info: String
@@ -2031,9 +2050,9 @@ module TencentCloud
2031
2050
 
2032
2051
  # DescribeDBAutonomyActions请求参数结构体
2033
2052
  class DescribeDBAutonomyActionsRequest < TencentCloud::Common::AbstractModel
2034
- # @param EventId: 事件ID
2053
+ # @param EventId: 事件ID。可通过 [DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) 接口获取。
2035
2054
  # @type EventId: Integer
2036
- # @param InstanceId: 实列ID
2055
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2037
2056
  # @type InstanceId: String
2038
2057
  # @param Product: 服务产品类型,支持值包括: "redis" - 云数据库 Redis。
2039
2058
  # @type Product: String
@@ -2153,9 +2172,9 @@ module TencentCloud
2153
2172
 
2154
2173
  # DescribeDBDiagEvent请求参数结构体
2155
2174
  class DescribeDBDiagEventRequest < TencentCloud::Common::AbstractModel
2156
- # @param InstanceId: 实例 ID
2175
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2157
2176
  # @type InstanceId: String
2158
- # @param EventId: 事件 ID 。通过“获取实例诊断历史DescribeDBDiagHistory”获取。
2177
+ # @param EventId: 事件 ID 。通过“获取实例诊断历史[DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) ”获取。
2159
2178
  # @type EventId: Integer
2160
2179
  # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,"redis" - 云数据库 Redis,默认为"mysql"。
2161
2180
  # @type Product: String
@@ -2179,7 +2198,7 @@ module TencentCloud
2179
2198
  class DescribeDBDiagEventResponse < TencentCloud::Common::AbstractModel
2180
2199
  # @param DiagItem: 诊断项。
2181
2200
  # @type DiagItem: String
2182
- # @param DiagType: 诊断类型。
2201
+ # @param DiagType: 诊断类型。支持值包括"高危账号","自增键耗尽","连接性检查","CPU利用率","死锁","全表扫描","高并发/压力请求","预编译语句过多","内存利用率","Metadata lock","磁盘超限","内存超限","只读锁","只读实例剔除","行锁","活跃会话","慢SQL","数据库快照","磁盘空间利用率","执行计划变化","主从切换","Table open cache命中率低","大表","事务未提交","事务导致复制延迟"等。
2183
2202
  # @type DiagType: String
2184
2203
  # @param EventId: 事件 ID 。
2185
2204
  # @type EventId: Integer
@@ -2191,13 +2210,13 @@ module TencentCloud
2191
2210
  # @type Problem: String
2192
2211
  # @param Severity: 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
2193
2212
  # @type Severity: Integer
2194
- # @param StartTime: 开始时间
2213
+ # @param StartTime: 开始时间。格式: "yyyy-MM-dd HH:mm:ss"
2195
2214
  # @type StartTime: String
2196
2215
  # @param Suggestions: 诊断建议,若无建议则输出为空。
2197
2216
  # @type Suggestions: String
2198
2217
  # @param Metric: 保留字段。
2199
2218
  # @type Metric: String
2200
- # @param EndTime: 结束时间。
2219
+ # @param EndTime: 结束时间。格式: "yyyy-MM-dd HH:mm:ss"
2201
2220
  # @type EndTime: String
2202
2221
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2203
2222
  # @type RequestId: String
@@ -2308,9 +2327,9 @@ module TencentCloud
2308
2327
 
2309
2328
  # DescribeDBDiagHistory请求参数结构体
2310
2329
  class DescribeDBDiagHistoryRequest < TencentCloud::Common::AbstractModel
2311
- # @param InstanceId: 实例 ID
2330
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2312
2331
  # @type InstanceId: String
2313
- # @param StartTime: 开始时间,如“2019-09-10 12:13:14”。
2332
+ # @param StartTime: 开始时间,如“2019-09-10 12:13:14”。结束时间与开始时间的间隔最大可为2天。
2314
2333
  # @type StartTime: String
2315
2334
  # @param EndTime: 结束时间,如“2019-09-11 12:13:14”,结束时间与开始时间的间隔最大可为2天。
2316
2335
  # @type EndTime: String
@@ -2792,13 +2811,13 @@ module TencentCloud
2792
2811
  class DescribeIndexRecommendAggregationSlowLogsRequest < TencentCloud::Common::AbstractModel
2793
2812
  # @param Product: 服务产品类型,支持值包括:"mongodb" - 云数据库 。
2794
2813
  # @type Product: String
2795
- # @param InstanceId: 实例ID
2814
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2796
2815
  # @type InstanceId: String
2797
2816
  # @param Db: 数据库名称。
2798
2817
  # @type Db: String
2799
2818
  # @param Collection: 表名。
2800
2819
  # @type Collection: String
2801
- # @param Signs: 签名。这个值是DescribelndexRecommendInfo接口返回
2820
+ # @param Signs: 签名。这个值是 [DescribeIndexRecommendInfo](https://cloud.tencent.com/document/product/1130/98911) 接口返回
2802
2821
  # @type Signs: Array
2803
2822
 
2804
2823
  attr_accessor :Product, :InstanceId, :Db, :Collection, :Signs
@@ -2847,7 +2866,7 @@ module TencentCloud
2847
2866
  class DescribeIndexRecommendInfoRequest < TencentCloud::Common::AbstractModel
2848
2867
  # @param Product: 服务产品类型,支持值包括:"mongodb" - 云数据库 。
2849
2868
  # @type Product: String
2850
- # @param InstanceId: 实例ID
2869
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2851
2870
  # @type InstanceId: String
2852
2871
 
2853
2872
  attr_accessor :Product, :InstanceId
@@ -2973,9 +2992,72 @@ module TencentCloud
2973
2992
  end
2974
2993
  end
2975
2994
 
2995
+ # DescribeMetricTopProxies请求参数结构体
2996
+ class DescribeMetricTopProxiesRequest < TencentCloud::Common::AbstractModel
2997
+ # @param StartTime: 开始时间,如“2021-05-27 00:00:00”,支持的最早查询时间为当前时间的前30天。
2998
+ # @type StartTime: String
2999
+ # @param EndTime: 结束时间,如“2021-05-27 01:00:00”,支持的最早查询时间为当前时间的前30天。
3000
+ # @type EndTime: String
3001
+ # @param InstanceId: 实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3002
+ # @type InstanceId: String
3003
+ # @param Product: 服务产品类型,支持值包括:"mysql" - 云数据库 MySQL,"redis" - 云数据库 Redis,"mariadb"-数据库mariadb 默认为"mysql"。
3004
+ # @type Product: String
3005
+ # @param Metric: 指标 eg: cpu_util, connections
3006
+ # @type Metric: String
3007
+ # @param Limit: 默认前20条
3008
+ # @type Limit: Integer
3009
+
3010
+ attr_accessor :StartTime, :EndTime, :InstanceId, :Product, :Metric, :Limit
3011
+
3012
+ def initialize(starttime=nil, endtime=nil, instanceid=nil, product=nil, metric=nil, limit=nil)
3013
+ @StartTime = starttime
3014
+ @EndTime = endtime
3015
+ @InstanceId = instanceid
3016
+ @Product = product
3017
+ @Metric = metric
3018
+ @Limit = limit
3019
+ end
3020
+
3021
+ def deserialize(params)
3022
+ @StartTime = params['StartTime']
3023
+ @EndTime = params['EndTime']
3024
+ @InstanceId = params['InstanceId']
3025
+ @Product = params['Product']
3026
+ @Metric = params['Metric']
3027
+ @Limit = params['Limit']
3028
+ end
3029
+ end
3030
+
3031
+ # DescribeMetricTopProxies返回参数结构体
3032
+ class DescribeMetricTopProxiesResponse < TencentCloud::Common::AbstractModel
3033
+ # @param Data: 命令列表
3034
+ # @type Data: Array
3035
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3036
+ # @type RequestId: String
3037
+
3038
+ attr_accessor :Data, :RequestId
3039
+
3040
+ def initialize(data=nil, requestid=nil)
3041
+ @Data = data
3042
+ @RequestId = requestid
3043
+ end
3044
+
3045
+ def deserialize(params)
3046
+ unless params['Data'].nil?
3047
+ @Data = []
3048
+ params['Data'].each do |i|
3049
+ redismetrictopproxiesdata_tmp = RedisMetricTopProxiesData.new
3050
+ redismetrictopproxiesdata_tmp.deserialize(i)
3051
+ @Data << redismetrictopproxiesdata_tmp
3052
+ end
3053
+ end
3054
+ @RequestId = params['RequestId']
3055
+ end
3056
+ end
3057
+
2976
3058
  # DescribeMySqlProcessList请求参数结构体
2977
3059
  class DescribeMySqlProcessListRequest < TencentCloud::Common::AbstractModel
2978
- # @param InstanceId: 实例ID
3060
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
2979
3061
  # @type InstanceId: String
2980
3062
  # @param ID: 线程的ID,用于筛选线程列表。
2981
3063
  # @type ID: Integer
@@ -2985,9 +3067,9 @@ module TencentCloud
2985
3067
  # @type Host: String
2986
3068
  # @param DB: 线程的操作数据库,用于筛选线程列表。
2987
3069
  # @type DB: String
2988
- # @param State: 线程的操作状态,用于筛选线程列表。
3070
+ # @param State: 线程的操作状态,用于筛选线程列表。包含以下值:Sending data,Updating, Opening tables 等
2989
3071
  # @type State: String
2990
- # @param Command: 线程的执行类型,用于筛选线程列表。
3072
+ # @param Command: 线程的操作状态,用于筛选线程列表。包含以下值:Sending data,Updating, Opening tables 等
2991
3073
  # @type Command: String
2992
3074
  # @param Time: 线程的操作时长最小值,单位秒,用于筛选操作时长大于该值的线程列表。
2993
3075
  # @type Time: Integer
@@ -3080,7 +3162,7 @@ module TencentCloud
3080
3162
 
3081
3163
  # DescribeNoPrimaryKeyTables请求参数结构体
3082
3164
  class DescribeNoPrimaryKeyTablesRequest < TencentCloud::Common::AbstractModel
3083
- # @param InstanceId: 实例ID
3165
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3084
3166
  # @type InstanceId: String
3085
3167
  # @param Date: 查询日期,如2021-05-27,最早为30天前的日期。
3086
3168
  # @type Date: String
@@ -3332,7 +3414,7 @@ module TencentCloud
3332
3414
 
3333
3415
  # DescribeRedisCmdPerfTimeSeries请求参数结构体
3334
3416
  class DescribeRedisCmdPerfTimeSeriesRequest < TencentCloud::Common::AbstractModel
3335
- # @param InstanceId: 实例 ID
3417
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3336
3418
  # @type InstanceId: String
3337
3419
  # @param Product: 服务产品类型,仅仅支持值 "redis" - 云数据库 Redis。
3338
3420
  # @type Product: String
@@ -3342,9 +3424,14 @@ module TencentCloud
3342
3424
  # @type EndTime: String
3343
3425
  # @param CommandList: 需要分析的redis命令
3344
3426
  # @type CommandList: Array
3345
- # @param Metric: 监控指标,以逗号分隔
3427
+ # @param Metric: 监控指标,包括:qps,latency_p99,latency_avg,latency_max,以逗号分隔
3428
+ # 其中:
3429
+ # qps - 每秒查询率
3430
+ # latency_p99 - 99分位延迟
3431
+ # latency_avg - 平均延迟
3432
+ # latency_max - 最大延迟
3346
3433
  # @type Metric: String
3347
- # @param Period: 监控指标时间粒度,单位秒,若不提供则根据开始时间和结束时间取默认值
3434
+ # @param Period: Period,监控指标时间粒度,单位秒,若不提供则根据开始时间和结束时间取默认值
3348
3435
  # @type Period: Integer
3349
3436
 
3350
3437
  attr_accessor :InstanceId, :Product, :StartTime, :EndTime, :CommandList, :Metric, :Period
@@ -3399,7 +3486,7 @@ module TencentCloud
3399
3486
 
3400
3487
  # DescribeRedisCommandCostStatistics请求参数结构体
3401
3488
  class DescribeRedisCommandCostStatisticsRequest < TencentCloud::Common::AbstractModel
3402
- # @param InstanceId: 实例 ID
3489
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3403
3490
  # @type InstanceId: String
3404
3491
  # @param StartTime: 开始时间,如“2025-03-17T00:00:00+00:00”。0天 < 当前服务器时间 - 开始时间 <= 10天。
3405
3492
  # @type StartTime: String
@@ -3454,7 +3541,7 @@ module TencentCloud
3454
3541
 
3455
3542
  # DescribeRedisCommandOverview请求参数结构体
3456
3543
  class DescribeRedisCommandOverviewRequest < TencentCloud::Common::AbstractModel
3457
- # @param InstanceId: 实例 ID
3544
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3458
3545
  # @type InstanceId: String
3459
3546
  # @param StartTime: 开始时间,如“2025-03-17T00:00:00+00:00”。0天 < 当前服务器时间 - 开始时间 <= 10天。
3460
3547
  # @type StartTime: String
@@ -3509,7 +3596,7 @@ module TencentCloud
3509
3596
 
3510
3597
  # DescribeRedisProcessList请求参数结构体
3511
3598
  class DescribeRedisProcessListRequest < TencentCloud::Common::AbstractModel
3512
- # @param InstanceId: Redis 实例ID
3599
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3513
3600
  # @type InstanceId: String
3514
3601
  # @param Product: 服务产品类型,支持值包括 "redis" - 云数据库 Redis。
3515
3602
  # @type Product: String
@@ -3647,7 +3734,7 @@ module TencentCloud
3647
3734
 
3648
3735
  # DescribeRedisTopBigKeys请求参数结构体
3649
3736
  class DescribeRedisTopBigKeysRequest < TencentCloud::Common::AbstractModel
3650
- # @param InstanceId: 实例ID
3737
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3651
3738
  # @type InstanceId: String
3652
3739
  # @param Date: 查询日期,如2021-05-27,最早可为前30天的日期。
3653
3740
  # @type Date: String
@@ -3781,7 +3868,7 @@ module TencentCloud
3781
3868
 
3782
3869
  # DescribeRedisTopHotKeys请求参数结构体
3783
3870
  class DescribeRedisTopHotKeysRequest < TencentCloud::Common::AbstractModel
3784
- # @param InstanceId: 实例 ID
3871
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
3785
3872
  # @type InstanceId: String
3786
3873
  # @param StartTime: 开始时间,如“2024-09-22T00:00:00+00:00”。0天 < 当前服务器时间 - 开始时间 <= 10天。
3787
3874
  # @type StartTime: String
@@ -4018,9 +4105,9 @@ module TencentCloud
4018
4105
 
4019
4106
  # DescribeSlowLogQueryTimeStats请求参数结构体
4020
4107
  class DescribeSlowLogQueryTimeStatsRequest < TencentCloud::Common::AbstractModel
4021
- # @param InstanceId: 实例 ID
4108
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4022
4109
  # @type InstanceId: String
4023
- # @param StartTime: 开始时间,如“2019-09-10 12:13:14”。
4110
+ # @param StartTime: 开始时间,如“2019-09-10 12:13:14”,截止时间与开始时间的间隔小于7天。
4024
4111
  # @type StartTime: String
4025
4112
  # @param EndTime: 截止时间,如“2019-09-11 10:13:14”,截止时间与开始时间的间隔小于7天。
4026
4113
  # @type EndTime: String
@@ -4028,9 +4115,12 @@ module TencentCloud
4028
4115
  # @type Product: String
4029
4116
  # @param InstanceProxyId: Proxy节点ID。
4030
4117
  # @type InstanceProxyId: String
4031
- # @param InstanceNodeId: 实列节点ID。
4118
+ # @param InstanceNodeId: 实例节点ID。
4032
4119
  # @type InstanceNodeId: String
4033
4120
  # @param Type: 查询类型,目前支持值:mongod,mongos。
4121
+ # 其中:
4122
+ # mongod - MongoDB的数据存储节点
4123
+ # mongos - MongoDB的路由节点
4034
4124
  # @type Type: String
4035
4125
 
4036
4126
  attr_accessor :InstanceId, :StartTime, :EndTime, :Product, :InstanceProxyId, :InstanceNodeId, :Type
@@ -4422,7 +4512,7 @@ module TencentCloud
4422
4512
 
4423
4513
  # DescribeSqlFilters请求参数结构体
4424
4514
  class DescribeSqlFiltersRequest < TencentCloud::Common::AbstractModel
4425
- # @param InstanceId: 实例ID
4515
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4426
4516
  # @type InstanceId: String
4427
4517
  # @param FilterIds: 任务ID列表,用于筛选任务列表。
4428
4518
  # @type FilterIds: Array
@@ -4489,7 +4579,7 @@ module TencentCloud
4489
4579
 
4490
4580
  # DescribeSqlTemplate请求参数结构体
4491
4581
  class DescribeSqlTemplateRequest < TencentCloud::Common::AbstractModel
4492
- # @param InstanceId: 实例ID
4582
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4493
4583
  # @type InstanceId: String
4494
4584
  # @param Schema: 数据库名。
4495
4585
  # @type Schema: String
@@ -4523,9 +4613,9 @@ module TencentCloud
4523
4613
  # @type SqlText: String
4524
4614
  # @param SqlType: SQL类型。
4525
4615
  # @type SqlType: String
4526
- # @param SqlTemplate: SQL模版内容。
4616
+ # @param SqlTemplate: SQL模板内容。
4527
4617
  # @type SqlTemplate: String
4528
- # @param SqlId: SQL模版ID。
4618
+ # @param SqlId: SQL模板ID。
4529
4619
  # @type SqlId: Integer
4530
4620
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4531
4621
  # @type RequestId: String
@@ -4616,11 +4706,19 @@ module TencentCloud
4616
4706
 
4617
4707
  # DescribeTopSpaceSchemas请求参数结构体
4618
4708
  class DescribeTopSpaceSchemasRequest < TencentCloud::Common::AbstractModel
4619
- # @param InstanceId: 实例 ID
4709
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4620
4710
  # @type InstanceId: String
4621
4711
  # @param Limit: 返回的Top库数量,最大值为100,默认为20。
4622
4712
  # @type Limit: Integer
4623
4713
  # @param SortBy: 筛选Top库所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。
4714
+ # 其中:
4715
+ # DataLength - 数据长度
4716
+ # IndexLength - 索引长度
4717
+ # TotalLength - 总长度
4718
+ # DataFree - 空闲空间
4719
+ # FragRatio - 碎片率
4720
+ # TableRows - 表行数
4721
+ # PhysicalFileSize - 物理文件大小
4624
4722
  # @type SortBy: String
4625
4723
  # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
4626
4724
  # @type Product: String
@@ -4738,11 +4836,19 @@ module TencentCloud
4738
4836
 
4739
4837
  # DescribeTopSpaceTables请求参数结构体
4740
4838
  class DescribeTopSpaceTablesRequest < TencentCloud::Common::AbstractModel
4741
- # @param InstanceId: 实例 ID
4839
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4742
4840
  # @type InstanceId: String
4743
4841
  # @param Limit: 返回的Top表数量,最大值为100,默认为20。
4744
4842
  # @type Limit: Integer
4745
4843
  # @param SortBy: 筛选Top表所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。
4844
+ # 其中:
4845
+ # DataLength - 数据长度
4846
+ # IndexLength - 索引长度
4847
+ # TotalLength - 总长度
4848
+ # DataFree - 空闲空间
4849
+ # FragRatio - 碎片率
4850
+ # TableRows - 表行数
4851
+ # PhysicalFileSize - 物理文件大小
4746
4852
  # @type SortBy: String
4747
4853
  # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
4748
4854
  # @type Product: String
@@ -4852,7 +4958,7 @@ module TencentCloud
4852
4958
 
4853
4959
  # DescribeUserSqlAdvice请求参数结构体
4854
4960
  class DescribeUserSqlAdviceRequest < TencentCloud::Common::AbstractModel
4855
- # @param InstanceId: 实例ID
4961
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
4856
4962
  # @type InstanceId: String
4857
4963
  # @param SqlText: SQL语句。
4858
4964
  # @type SqlText: String
@@ -5608,11 +5714,12 @@ module TencentCloud
5608
5714
 
5609
5715
  # KillMySqlThreads请求参数结构体
5610
5716
  class KillMySqlThreadsRequest < TencentCloud::Common::AbstractModel
5611
- # @param InstanceId: 实例ID
5717
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
5612
5718
  # @type InstanceId: String
5613
5719
  # @param Stage: kill会话任务的阶段,取值包括:"Prepare"-准备阶段,"Commit"-提交阶段。
5614
5720
  # @type Stage: String
5615
- # @param Threads: 需要kill的sql会话ID列表,此参数用于Prepare阶段。
5721
+ # @param Threads: 需要kill的sql会话ID列表,通过接口[查询实时线程列表](https://cloud.tencent.com/document/product/1130/57824)
5722
+ # 此参数用于Prepare阶段。
5616
5723
  # @type Threads: Array
5617
5724
  # @param SqlExecId: 执行ID,此参数用于Commit阶段。
5618
5725
  # @type SqlExecId: String
@@ -5672,7 +5779,7 @@ module TencentCloud
5672
5779
  # @type SendMail: Integer
5673
5780
  # @param Region: 地域配置, 如["ap-guangzhou", "ap-shanghai"]。巡检的邮件发送模板,配置需要发送巡检邮件的地域;订阅的邮件发送模板,配置当前订阅实例的所属地域。
5674
5781
  # @type Region: Array
5675
- # @param HealthStatus: 发送指定的健康等级的报告, 如["HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"]。
5782
+ # @param HealthStatus: 包含的健康等级,包括值:HEALTH-健康,SUB_HEALTH-亚健康,RISK-风险,HIGH_RISK-高危。
5676
5783
  # @type HealthStatus: Array
5677
5784
  # @param ContactPerson: 联系人id, 联系人/联系组不能都为空。
5678
5785
  # @type ContactPerson: Array
@@ -5724,20 +5831,20 @@ module TencentCloud
5724
5831
 
5725
5832
  # ModifyAlarmPolicy请求参数结构体
5726
5833
  class ModifyAlarmPolicyRequest < TencentCloud::Common::AbstractModel
5727
- # @param ApplyType: 类型
5834
+ # @param ApplyType: 策略类型,固定值:instance, instance-代表实例类型策略
5728
5835
  # @type ApplyType: String
5729
- # @param Enable: 开启策略
5836
+ # @param Enable: 策略是否开启,0-代表开启,1-代表关闭
5730
5837
  # @type Enable: Integer
5731
- # @param InstanceIds: 列表
5838
+ # @param InstanceIds: 实例id列表,可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
5732
5839
  # @type InstanceIds: Array
5733
5840
  # @param NewProfileLevel: User-动态关联该用户所有实例
5734
5841
  # Instance-关联实例列表的实例
5735
5842
  # @type NewProfileLevel: String
5736
- # @param NewProfileName: 新策略名
5843
+ # @param NewProfileName: 新策略名,包含中文英文数字,长度在60个字符以内,不能以“_”开头。
5737
5844
  # @type NewProfileName: String
5738
- # @param ProfileName: 旧策略名
5845
+ # @param ProfileName: 旧策略名,包含中文英文数字,长度在60个字符以内,不能以“_”开头。
5739
5846
  # @type ProfileName: String
5740
- # @param ProfileType: 策略类型
5847
+ # @param ProfileType: 策略类型,固定值:alarm_policy
5741
5848
  # @type ProfileType: String
5742
5849
  # @param Remark: 备注
5743
5850
  # @type Remark: String
@@ -5747,9 +5854,9 @@ module TencentCloud
5747
5854
  # @type TemplateInfo: Array
5748
5855
  # @param QuickRule: 快速规则 支持包括fatal-致命, critical-严重,
5749
5856
  # warning-告警,
5750
- # information-通知
5857
+ # information-通知,与Rules互斥
5751
5858
  # @type QuickRule: String
5752
- # @param Rules: 自定义规则
5859
+ # @param Rules: 自定义规则,与QuickRule互斥。
5753
5860
  # @type Rules: Array
5754
5861
 
5755
5862
  attr_accessor :ApplyType, :Enable, :InstanceIds, :NewProfileLevel, :NewProfileName, :ProfileName, :ProfileType, :Remark, :RuleType, :TemplateInfo, :QuickRule, :Rules
@@ -5878,11 +5985,12 @@ module TencentCloud
5878
5985
  class ModifyDiagDBInstanceConfRequest < TencentCloud::Common::AbstractModel
5879
5986
  # @param InstanceConfs: 实例配置,包括巡检、概览开关等。
5880
5987
  # @type InstanceConfs: :class:`Tencentcloud::Dbbrain.v20210527.models.InstanceConfs`
5881
- # @param Regions: 生效实例地域,取值为"All",代表全地域。
5988
+ # @param Regions: 生效实例地域,固定为"All",代表全地域。
5882
5989
  # @type Regions: String
5883
5990
  # @param Product: 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,"redis" - 云数据库 Redis。
5884
5991
  # @type Product: String
5885
5992
  # @param InstanceIds: 指定更改巡检状态的实例ID。
5993
+ # 可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
5886
5994
  # @type InstanceIds: Array
5887
5995
 
5888
5996
  attr_accessor :InstanceConfs, :Regions, :Product, :InstanceIds
@@ -5923,13 +6031,14 @@ module TencentCloud
5923
6031
 
5924
6032
  # ModifySqlFilters请求参数结构体
5925
6033
  class ModifySqlFiltersRequest < TencentCloud::Common::AbstractModel
5926
- # @param InstanceId: 实例ID
6034
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
5927
6035
  # @type InstanceId: String
5928
- # @param FilterIds: SQL限流任务ID列表。
6036
+ # @param FilterIds: SQL限流任务ID列表。可通过接口[查询实例SQL限流任务列表
6037
+ # ](https://cloud.tencent.com/document/product/1130/72831)获得。
5929
6038
  # @type FilterIds: Array
5930
- # @param Status: 限流任务状态,取值支持TERMINATED - 终止。
6039
+ # @param Status: 限流任务状态,仅支持传参TERMINATED - 终止。
5931
6040
  # @type Status: String
5932
- # @param SessionToken: 通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
6041
+ # @param SessionToken: 通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。
5933
6042
  # @type SessionToken: String
5934
6043
  # @param Product: 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
5935
6044
  # @type Product: String
@@ -5973,7 +6082,7 @@ module TencentCloud
5973
6082
  class ModifyUserAutonomyProfileRequest < TencentCloud::Common::AbstractModel
5974
6083
  # @param ProfileType: 配置类型,为需要配置的功能枚举值,目前包含一下枚举值:AutonomyGlobal(自治功能全局配置)、RedisAutoScaleUp(Redis自治扩容配置)
5975
6084
  # @type ProfileType: String
5976
- # @param InstanceId: 实列ID
6085
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
5977
6086
  # @type InstanceId: String
5978
6087
  # @param Product: 服务产品类型,支持值包括: "redis" - 云数据库 Redis。
5979
6088
  # @type Product: String
@@ -6146,7 +6255,7 @@ module TencentCloud
6146
6255
  class MonitorMetricSeriesData < TencentCloud::Common::AbstractModel
6147
6256
  # @param Series: 监控指标。
6148
6257
  # @type Series: Array
6149
- # @param Timestamp: 监控指标对应的时间戳。
6258
+ # @param Timestamp: 监控指标对应的时间戳。(精度:秒)
6150
6259
  # @type Timestamp: Array
6151
6260
 
6152
6261
  attr_accessor :Series, :Timestamp
@@ -6270,6 +6379,7 @@ module TencentCloud
6270
6379
  # @param Id: 会话 ID。
6271
6380
  # @type Id: Integer
6272
6381
  # @param Address: 访问来源,IP 地址和端口号。
6382
+ # 格式:IP:Port
6273
6383
  # @type Address: String
6274
6384
  # @param FileDescriptor: 文件描述符。
6275
6385
  # @type FileDescriptor: Integer
@@ -6342,7 +6452,7 @@ module TencentCloud
6342
6452
 
6343
6453
  # 用户配置的信息
6344
6454
  class ProfileInfo < TencentCloud::Common::AbstractModel
6345
- # @param Language: 语言, 如"zh"。
6455
+ # @param Language: 语言类型, 包含“zh”-中文,“en”-英文。
6346
6456
  # @type Language: String
6347
6457
  # @param MailConfiguration: 邮件模板的内容。
6348
6458
  # @type MailConfiguration: :class:`Tencentcloud::Dbbrain.v20210527.models.MailConfiguration`
@@ -6367,13 +6477,13 @@ module TencentCloud
6367
6477
  class ReceiveInfo < TencentCloud::Common::AbstractModel
6368
6478
  # @param ReceiveGroup: 接收组
6369
6479
  # @type ReceiveGroup: Array
6370
- # @param EndReceiveTime: 最后接收时间
6480
+ # @param EndReceiveTime: 最后接收时间,格式: "HH:mm:ss"
6371
6481
  # @type EndReceiveTime: String
6372
6482
  # @param ReceiveName: 接收名
6373
6483
  # @type ReceiveName: String
6374
6484
  # @param SendChannel: 推送渠道
6375
6485
  # @type SendChannel: Array
6376
- # @param StartReceiveTime: 开始时间
6486
+ # @param StartReceiveTime: 开始时间,格式: "HH:mm:ss"
6377
6487
  # @type StartReceiveTime: String
6378
6488
  # @param ReceiveUin: 接收用户列表
6379
6489
  # @type ReceiveUin: Array
@@ -6578,6 +6688,55 @@ module TencentCloud
6578
6688
  end
6579
6689
  end
6580
6690
 
6691
+ # Redis DescribeMetricTopProxies 接口返回数据
6692
+ class RedisMetricTopProxiesData < TencentCloud::Common::AbstractModel
6693
+ # @param Host: host
6694
+ # 注意:此字段可能返回 null,表示取不到有效值。
6695
+ # @type Host: String
6696
+ # @param InstanceProxyId: Proxy Id
6697
+ # 注意:此字段可能返回 null,表示取不到有效值。
6698
+ # @type InstanceProxyId: String
6699
+ # @param Port: 端口
6700
+ # 注意:此字段可能返回 null,表示取不到有效值。
6701
+ # @type Port: Integer
6702
+ # @param Value: 最新的值
6703
+ # 注意:此字段可能返回 null,表示取不到有效值。
6704
+ # @type Value: Float
6705
+ # @param Timestamp: 时间(秒)
6706
+ # 注意:此字段可能返回 null,表示取不到有效值。
6707
+ # @type Timestamp: Array
6708
+ # @param Series: 序列数据
6709
+ # 注意:此字段可能返回 null,表示取不到有效值。
6710
+ # @type Series: Array
6711
+
6712
+ attr_accessor :Host, :InstanceProxyId, :Port, :Value, :Timestamp, :Series
6713
+
6714
+ def initialize(host=nil, instanceproxyid=nil, port=nil, value=nil, timestamp=nil, series=nil)
6715
+ @Host = host
6716
+ @InstanceProxyId = instanceproxyid
6717
+ @Port = port
6718
+ @Value = value
6719
+ @Timestamp = timestamp
6720
+ @Series = series
6721
+ end
6722
+
6723
+ def deserialize(params)
6724
+ @Host = params['Host']
6725
+ @InstanceProxyId = params['InstanceProxyId']
6726
+ @Port = params['Port']
6727
+ @Value = params['Value']
6728
+ @Timestamp = params['Timestamp']
6729
+ unless params['Series'].nil?
6730
+ @Series = []
6731
+ params['Series'].each do |i|
6732
+ monitorfloatmetric_tmp = MonitorFloatMetric.new
6733
+ monitorfloatmetric_tmp.deserialize(i)
6734
+ @Series << monitorfloatmetric_tmp
6735
+ end
6736
+ end
6737
+ end
6738
+ end
6739
+
6581
6740
  # redis key前缀空间信息
6582
6741
  class RedisPreKeySpaceData < TencentCloud::Common::AbstractModel
6583
6742
  # @param AveElementSize: 平均元素长度。
@@ -7156,7 +7315,7 @@ module TencentCloud
7156
7315
  # @type From: Float
7157
7316
  # @param To: 分段耗时上边界,单位是秒。
7158
7317
  # @type To: Float
7159
- # @param Ratio: 耗时占比。
7318
+ # @param Ratio: 耗时占比。单位(%)
7160
7319
  # @type Ratio: Float
7161
7320
 
7162
7321
  attr_accessor :Count, :From, :To, :Ratio
@@ -7429,9 +7588,9 @@ module TencentCloud
7429
7588
 
7430
7589
  # 通知模板
7431
7590
  class TemplateInfo < TencentCloud::Common::AbstractModel
7432
- # @param TemplateId: 模板id
7591
+ # @param TemplateId: 模板id,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。
7433
7592
  # @type TemplateId: String
7434
- # @param TemplateName: 模板名
7593
+ # @param TemplateName: 模板名,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。
7435
7594
  # @type TemplateName: String
7436
7595
 
7437
7596
  attr_accessor :TemplateId, :TemplateName
@@ -7501,7 +7660,7 @@ module TencentCloud
7501
7660
 
7502
7661
  # UpdateAgentSwitch请求参数结构体
7503
7662
  class UpdateAgentSwitchRequest < TencentCloud::Common::AbstractModel
7504
- # @param AgentId: Agent标识。
7663
+ # @param AgentId: Agent标识。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
7505
7664
  # @type AgentId: String
7506
7665
  # @param Switch: 停止或重连Agent,支持值包括:"on" - 重连Agent, "off" - 停止Agent。
7507
7666
  # @type Switch: String
@@ -7543,7 +7702,7 @@ module TencentCloud
7543
7702
  class UpdateMonitorSwitchRequest < TencentCloud::Common::AbstractModel
7544
7703
  # @param Switch: 停止或重连Agent实例,支持值包括:"on" - 重连实例, "off" - 停止实例。
7545
7704
  # @type Switch: String
7546
- # @param InstanceId: 实例ID
7705
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
7547
7706
  # @type InstanceId: String
7548
7707
  # @param Product: 服务产品类型,仅支持 "dbbrain-mysql" - 自建MySQL。
7549
7708
  # @type Product: String
@@ -7616,7 +7775,7 @@ module TencentCloud
7616
7775
 
7617
7776
  # VerifyUserAccount请求参数结构体
7618
7777
  class VerifyUserAccountRequest < TencentCloud::Common::AbstractModel
7619
- # @param InstanceId: 实例ID
7778
+ # @param InstanceId: 实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。
7620
7779
  # @type InstanceId: String
7621
7780
  # @param User: 数据库账号名。
7622
7781
  # @type User: String