tccli 3.0.1397.1__py2.py3-none-any.whl → 3.0.1399.1__py2.py3-none-any.whl

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.
Files changed (41) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/ccc/v20200210/api.json +33 -0
  3. tccli/services/cdb/cdb_client.py +53 -0
  4. tccli/services/cdb/v20170320/api.json +76 -14
  5. tccli/services/cdb/v20170320/examples.json +8 -0
  6. tccli/services/cdwpg/v20201230/api.json +11 -1
  7. tccli/services/cdwpg/v20201230/examples.json +1 -1
  8. tccli/services/cls/v20201016/api.json +3 -3
  9. tccli/services/dbbrain/dbbrain_client.py +114 -61
  10. tccli/services/dbbrain/v20191016/api.json +63 -61
  11. tccli/services/dbbrain/v20210527/api.json +324 -163
  12. tccli/services/dbbrain/v20210527/examples.json +11 -3
  13. tccli/services/dlc/dlc_client.py +53 -0
  14. tccli/services/dlc/v20210125/api.json +206 -24
  15. tccli/services/dlc/v20210125/examples.json +11 -3
  16. tccli/services/dts/v20180330/api.json +4 -4
  17. tccli/services/dts/v20211206/api.json +54 -54
  18. tccli/services/dts/v20211206/examples.json +2 -2
  19. tccli/services/ess/v20201111/api.json +118 -3
  20. tccli/services/essbasic/v20210526/api.json +117 -2
  21. tccli/services/ioa/v20220601/api.json +11 -0
  22. tccli/services/lke/v20231130/api.json +162 -36
  23. tccli/services/lke/v20231130/examples.json +20 -20
  24. tccli/services/mongodb/v20190725/api.json +322 -313
  25. tccli/services/mongodb/v20190725/examples.json +17 -17
  26. tccli/services/monitor/v20180724/api.json +5 -4
  27. tccli/services/monitor/v20180724/examples.json +8 -2
  28. tccli/services/redis/v20180412/api.json +13 -13
  29. tccli/services/rum/v20210622/api.json +4 -4
  30. tccli/services/rum/v20210622/examples.json +2 -2
  31. tccli/services/teo/teo_client.py +166 -7
  32. tccli/services/teo/v20220901/api.json +341 -0
  33. tccli/services/teo/v20220901/examples.json +27 -3
  34. tccli/services/tke/v20180525/api.json +6 -6
  35. tccli/services/tke/v20180525/examples.json +1 -1
  36. tccli/services/waf/v20180125/api.json +19 -0
  37. {tccli-3.0.1397.1.dist-info → tccli-3.0.1399.1.dist-info}/METADATA +2 -2
  38. {tccli-3.0.1397.1.dist-info → tccli-3.0.1399.1.dist-info}/RECORD +41 -41
  39. {tccli-3.0.1397.1.dist-info → tccli-3.0.1399.1.dist-info}/WHEEL +0 -0
  40. {tccli-3.0.1397.1.dist-info → tccli-3.0.1399.1.dist-info}/entry_points.txt +0 -0
  41. {tccli-3.0.1397.1.dist-info → tccli-3.0.1399.1.dist-info}/license_files/LICENSE +0 -0
@@ -301,6 +301,13 @@
301
301
  "output": "DescribeMailProfileResponse",
302
302
  "status": "online"
303
303
  },
304
+ "DescribeMetricTopProxies": {
305
+ "document": "获取指定时间段内Redis 访问命令 cost top N",
306
+ "input": "DescribeMetricTopProxiesRequest",
307
+ "name": "获取Redis Proxy 指标",
308
+ "output": "DescribeMetricTopProxiesResponse",
309
+ "status": "online"
310
+ },
304
311
  "DescribeMySqlProcessList": {
305
312
  "document": "查询关系型数据库的实时线程列表。",
306
313
  "input": "DescribeMySqlProcessListRequest",
@@ -759,7 +766,7 @@
759
766
  {
760
767
  "disabled": false,
761
768
  "document": "更新用户的uin",
762
- "example": "000001",
769
+ "example": "100000",
763
770
  "member": "int64",
764
771
  "name": "UpdateUin",
765
772
  "output_required": false,
@@ -788,7 +795,7 @@
788
795
  },
789
796
  {
790
797
  "disabled": false,
791
- "document": "更新时间",
798
+ "document": "更新时间,格式: \"yyyy-MM-dd HH:mm:ss\"",
792
799
  "example": "2024-12-04 17:16:35",
793
800
  "member": "string",
794
801
  "name": "UpdateTime",
@@ -1161,7 +1168,7 @@
1161
1168
  {
1162
1169
  "disabled": false,
1163
1170
  "document": "文件大小,单位为 KB。",
1164
- "example": "233",
1171
+ "example": "233.0",
1165
1172
  "member": "float",
1166
1173
  "name": "FileSize",
1167
1174
  "output_required": true,
@@ -1190,8 +1197,8 @@
1190
1197
  },
1191
1198
  {
1192
1199
  "disabled": false,
1193
- "document": "文件生成进度。",
1194
- "example": "20",
1200
+ "document": "文件生成进度。(单位:%)",
1201
+ "example": "20.0",
1195
1202
  "member": "float",
1196
1203
  "name": "Progress",
1197
1204
  "output_required": true,
@@ -1200,7 +1207,7 @@
1200
1207
  },
1201
1208
  {
1202
1209
  "disabled": false,
1203
- "document": "文件生成成功时间。",
1210
+ "document": "文件生成成功时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
1204
1211
  "example": "2019-03-20 17:09:13",
1205
1212
  "member": "string",
1206
1213
  "name": "FinishTime",
@@ -1306,7 +1313,7 @@
1306
1313
  },
1307
1314
  {
1308
1315
  "disabled": false,
1309
- "document": "自治任务触发时间。",
1316
+ "document": "自治任务触发时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
1310
1317
  "example": "2025-03-12 00:00:00",
1311
1318
  "member": "string",
1312
1319
  "name": "TriggerTime",
@@ -1316,7 +1323,7 @@
1316
1323
  },
1317
1324
  {
1318
1325
  "disabled": false,
1319
- "document": "自治任务创建时间。",
1326
+ "document": "自治任务创建时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
1320
1327
  "example": "2025-03-12 00:00:00",
1321
1328
  "member": "string",
1322
1329
  "name": "CreateTime",
@@ -1326,7 +1333,7 @@
1326
1333
  },
1327
1334
  {
1328
1335
  "disabled": false,
1329
- "document": "自治任务更新时间",
1336
+ "document": "自治任务更新时间,格式: \"yyyy-MM-dd HH:mm:ss\"",
1330
1337
  "example": "2025-03-12 00:00:00",
1331
1338
  "member": "string",
1332
1339
  "name": "UpdateTime",
@@ -1336,7 +1343,7 @@
1336
1343
  },
1337
1344
  {
1338
1345
  "disabled": false,
1339
- "document": "自治任务完成时间。",
1346
+ "document": "自治任务完成时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
1340
1347
  "example": "2025-03-12 00:00:00",
1341
1348
  "member": "string",
1342
1349
  "name": "FinishTime",
@@ -1366,7 +1373,7 @@
1366
1373
  },
1367
1374
  {
1368
1375
  "disabled": false,
1369
- "document": "自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED",
1376
+ "document": "自治任务状态:RUNNING,FINISHED,TERMINATED,CANCELLED\n其中:\nRUNNING - 运行中 \nFINISHED - 已完成 \nTERMINATED - 已终止 \nCANCELLED - 已取消 \n",
1370
1377
  "example": "RUNNING",
1371
1378
  "member": "string",
1372
1379
  "name": "Status",
@@ -1478,7 +1485,7 @@
1478
1485
  "members": [
1479
1486
  {
1480
1487
  "disabled": false,
1481
- "document": "是否开启自治。",
1488
+ "document": "是否开启自治。枚举值:true,false。\n其中:\ntrue - 开启\nfalse - 关闭",
1482
1489
  "example": "true",
1483
1490
  "member": "bool",
1484
1491
  "name": "Enabled",
@@ -1519,7 +1526,7 @@
1519
1526
  {
1520
1527
  "disabled": false,
1521
1528
  "document": "自治功能类型。",
1522
- "example": "RedisAutoScaleUp",
1529
+ "example": "[\"RedisAutoScaleUp\"]",
1523
1530
  "member": "string",
1524
1531
  "name": "EnabledItems",
1525
1532
  "output_required": false,
@@ -1734,7 +1741,7 @@
1734
1741
  },
1735
1742
  {
1736
1743
  "disabled": false,
1737
- "document": "Product保持一致。如:\"dcdb\" ,\"mariadb\"。",
1744
+ "document": "NodeRequestType主要标识数据库产品类型,与Product保持一致。如:\"dcdb\" ,\"mariadb\"。",
1738
1745
  "example": "dcdb",
1739
1746
  "member": "string",
1740
1747
  "name": "NodeRequestType",
@@ -1743,7 +1750,7 @@
1743
1750
  },
1744
1751
  {
1745
1752
  "disabled": false,
1746
- "document": "实例Id。",
1753
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
1747
1754
  "example": "tdsql-shartsdf",
1748
1755
  "member": "string",
1749
1756
  "name": "InstanceId",
@@ -1906,7 +1913,7 @@
1906
1913
  },
1907
1914
  {
1908
1915
  "disabled": false,
1909
- "document": "实例 ID ",
1916
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
1910
1917
  "example": "tdsqlshard-eg8b01gr",
1911
1918
  "member": "string",
1912
1919
  "name": "InstanceId",
@@ -1915,8 +1922,8 @@
1915
1922
  },
1916
1923
  {
1917
1924
  "disabled": false,
1918
- "document": "开始时间,如“2019-09-10 12:13:14”。\t",
1919
- "example": "2019-01-01 00:00:00",
1925
+ "document": "开始时间,如“2025-03-17T00:00:00+00:00”。",
1926
+ "example": "2025-03-17T01:00:00+00:00",
1920
1927
  "member": "datetime_iso",
1921
1928
  "name": "StartTime",
1922
1929
  "required": true,
@@ -1924,8 +1931,8 @@
1924
1931
  },
1925
1932
  {
1926
1933
  "disabled": false,
1927
- "document": "截止时间,如“2019-09-11 10:13:14”。",
1928
- "example": "2019-01-01 01:00:00",
1934
+ "document": "结束时间,如“2025-03-17T01:00:00+00:00”。",
1935
+ "example": "2025-03-17T01:00:00+00:00",
1929
1936
  "member": "datetime_iso",
1930
1937
  "name": "EndTime",
1931
1938
  "required": true,
@@ -1970,7 +1977,7 @@
1970
1977
  "members": [
1971
1978
  {
1972
1979
  "disabled": false,
1973
- "document": "实例ID",
1980
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
1974
1981
  "example": "cdb-6396zzr5",
1975
1982
  "member": "string",
1976
1983
  "name": "InstanceId",
@@ -2007,7 +2014,7 @@
2007
2014
  {
2008
2015
  "disabled": false,
2009
2016
  "document": "接收邮件的联系人ID数组。",
2010
- "example": "[\"1\\n\"]",
2017
+ "example": "[1]",
2011
2018
  "member": "int64",
2012
2019
  "name": "ContactPerson",
2013
2020
  "required": false,
@@ -2016,7 +2023,7 @@
2016
2023
  {
2017
2024
  "disabled": false,
2018
2025
  "document": "接收邮件的联系组ID数组。",
2019
- "example": "[\"1\\n\"]",
2026
+ "example": "[1]",
2020
2027
  "member": "int64",
2021
2028
  "name": "ContactGroup",
2022
2029
  "required": false,
@@ -2024,7 +2031,7 @@
2024
2031
  },
2025
2032
  {
2026
2033
  "disabled": false,
2027
- "document": "服务产品类型,支持值包括: \"mysql\" - 云数据库 MySQL, \"cynosdb\" - 云数据库 CynosDB for MySQL,\"redis\" - 云数据库 Redis,默认值为\"mysql\"。",
2034
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"redis\" - 云数据库 Redis,\"mongodb\" - 云数据库 MongoDB,\"mariadb\" - 云数据库 MariaDB,\"dcdb\" - 云数据库 TDSQL MySQL,默认为\"mysql\"。",
2028
2035
  "example": "mysql",
2029
2036
  "member": "string",
2030
2037
  "name": "Product",
@@ -2061,7 +2068,7 @@
2061
2068
  "members": [
2062
2069
  {
2063
2070
  "disabled": false,
2064
- "document": "实例ID",
2071
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。\n示例值:cdb-dctw4edd",
2065
2072
  "example": "cdb-c1nl9rpv",
2066
2073
  "member": "string",
2067
2074
  "name": "InstanceId",
@@ -2070,7 +2077,7 @@
2070
2077
  },
2071
2078
  {
2072
2079
  "disabled": false,
2073
- "document": "健康报告相应的任务ID,可通过DescribeDBDiagReportTasks查询。",
2080
+ "document": "健康报告相应的任务ID,可通过[DescribeDBDiagReportTasks](https://cloud.tencent.com/document/product/1130/54873)查询。",
2074
2081
  "example": "63452",
2075
2082
  "member": "int64",
2076
2083
  "name": "AsyncRequestId",
@@ -2079,7 +2086,7 @@
2079
2086
  },
2080
2087
  {
2081
2088
  "disabled": false,
2082
- "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"redis\" - 云数据库 Redis,默认为\"mysql\"。",
2089
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"redis\" - 云数据库 Redis,\"mongodb\" - 云数据库 MongoDB,\"mariadb\" - 云数据库 MariaDB,\"dcdb\" - 云数据库 TDSQL MySQL,默认为\"mysql\"。",
2083
2090
  "example": "mysql",
2084
2091
  "member": "string",
2085
2092
  "name": "Product",
@@ -2245,7 +2252,7 @@
2245
2252
  {
2246
2253
  "disabled": false,
2247
2254
  "document": "邮件配置内容。",
2248
- "example": "{\"Language\":\"zh\",\"MailConfiguration\":{\"Region\":[\"ap-guangzhou\"],\"SendMail\":1,\"ContactPerson\":[24332],\"ContactGroup\":[],\"HealthStatus\":[\"HIGH_RISK\"],\"SendTime\":\"10:00-12:00\"}}",
2255
+ "example": "",
2249
2256
  "member": "ProfileInfo",
2250
2257
  "name": "ProfileInfo",
2251
2258
  "required": true,
@@ -2262,8 +2269,8 @@
2262
2269
  },
2263
2270
  {
2264
2271
  "disabled": false,
2265
- "document": "配置名称,需要保持唯一性,数据库巡检邮件配置名称自拟;定期生成邮件配置命名格式:\"scheduler_\" + {instanceId},如\"schduler_cdb-test\"。",
2266
- "example": "schduler_cdb-test1234",
2272
+ "document": "配置名称,需要保持唯一性,数据库巡检邮件配置名称自拟;定期生成邮件配置命名格式:\"scheduler_\" + {instanceId},如\"scheduler_cdb-test\"。",
2273
+ "example": "scheduler_cdb-test1234",
2267
2274
  "member": "string",
2268
2275
  "name": "ProfileName",
2269
2276
  "required": true,
@@ -2280,7 +2287,7 @@
2280
2287
  },
2281
2288
  {
2282
2289
  "disabled": false,
2283
- "document": "服务产品类型,支持值包括: \"mysql\" - 云数据库 MySQL, \"cynosdb\" - 云数据库 CynosDB for MySQL。",
2290
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"redis\" - 云数据库 Redis,\"mongodb\" - 云数据库 MongoDB,\"mariadb\" - 云数据库 MariaDB,\"dcdb\" - 云数据库 TDSQL MySQL,默认为\"mysql\"。",
2284
2291
  "example": "mysql",
2285
2292
  "member": "string",
2286
2293
  "name": "Product",
@@ -2289,7 +2296,7 @@
2289
2296
  },
2290
2297
  {
2291
2298
  "disabled": false,
2292
- "document": "配置绑定的实例ID,当配置级别为\"Instance\"时需要传入且只能为一个实例;当配置级别为“User”时,此参数不填。",
2299
+ "document": "配置绑定的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。当配置级别为\"Instance\"时需要传入且只能为一个实例;当配置级别为“User”时,此参数不填。",
2293
2300
  "example": "[\"cdb-test\"]",
2294
2301
  "member": "string",
2295
2302
  "name": "BindInstanceIds",
@@ -2371,7 +2378,7 @@
2371
2378
  "members": [
2372
2379
  {
2373
2380
  "disabled": false,
2374
- "document": "实例ID",
2381
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2375
2382
  "example": "cdb-c1nl9rpv",
2376
2383
  "member": "string",
2377
2384
  "name": "InstanceId",
@@ -2445,7 +2452,7 @@
2445
2452
  {
2446
2453
  "disabled": false,
2447
2454
  "document": "邮件配置内容。",
2448
- "example": "-",
2455
+ "example": "",
2449
2456
  "member": "ProfileInfo",
2450
2457
  "name": "ProfileInfo",
2451
2458
  "required": true,
@@ -2453,7 +2460,7 @@
2453
2460
  },
2454
2461
  {
2455
2462
  "disabled": false,
2456
- "document": "配置名称,需要保持唯一性,定期生成邮件配置命名格式:\"scheduler_\" + {instanceId},如\"schduler_cdb-test\"。",
2463
+ "document": "配置名称,需要保持唯一性,定期生成邮件配置命名格式:\"scheduler_\" + {instanceId},如\"scheduler_cdb-test\"。",
2457
2464
  "example": "scheduler_cdb-test",
2458
2465
  "member": "string",
2459
2466
  "name": "ProfileName",
@@ -2462,8 +2469,8 @@
2462
2469
  },
2463
2470
  {
2464
2471
  "disabled": false,
2465
- "document": "配置订阅的实例ID",
2466
- "example": "cdb-123456",
2472
+ "document": "配置订阅的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2473
+ "example": "cdb-12156",
2467
2474
  "member": "string",
2468
2475
  "name": "BindInstanceId",
2469
2476
  "required": true,
@@ -2471,7 +2478,7 @@
2471
2478
  },
2472
2479
  {
2473
2480
  "disabled": false,
2474
- "document": "服务产品类型,支持值包括: \"mysql\" - 云数据库 MySQL, \"cynosdb\" - 云数据库 TDSQL-C for MySQL,默认为\"mysql\"。",
2481
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"redis\" - 云数据库 Redis,\"mongodb\" - 云数据库 MongoDB,\"mariadb\" - 云数据库 MariaDB,\"dcdb\" - 云数据库 TDSQL MySQL,默认为\"mysql\"。",
2475
2482
  "example": "mysql",
2476
2483
  "member": "string",
2477
2484
  "name": "Product",
@@ -2571,7 +2578,7 @@
2571
2578
  "members": [
2572
2579
  {
2573
2580
  "disabled": false,
2574
- "document": "实例ID",
2581
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2575
2582
  "example": "cdb-c1nl9rpv",
2576
2583
  "member": "string",
2577
2584
  "name": "InstanceId",
@@ -2580,7 +2587,7 @@
2580
2587
  },
2581
2588
  {
2582
2589
  "disabled": false,
2583
- "document": "SQL类型,取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE",
2590
+ "document": "SQL语句的类型,取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE。\n其中:\nSELECT - 查询 \nUPDATE - 更新 \nDELETE - 删除 \nINSERT - 插入 \nREPLACE - 替换",
2584
2591
  "example": "SELECT",
2585
2592
  "member": "string",
2586
2593
  "name": "SqlType",
@@ -2616,7 +2623,7 @@
2616
2623
  },
2617
2624
  {
2618
2625
  "disabled": false,
2619
- "document": "通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
2626
+ "document": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
2620
2627
  "example": "cAuth",
2621
2628
  "member": "string",
2622
2629
  "name": "SessionToken",
@@ -2662,7 +2669,7 @@
2662
2669
  "members": [
2663
2670
  {
2664
2671
  "disabled": false,
2665
- "document": "配置类型,为需要配置的功能枚举值,目前包含一下枚举值:AutonomyGlobal(自治功能全局配置)、RedisAutoScaleUp(Redis自治扩容配置)",
2672
+ "document": "配置类型,为需要配置的功能枚举值,目前包含以下枚举值:AutonomyGlobal(自治功能全局配置)、RedisAutoScaleUp(Redis自治扩容配置)",
2666
2673
  "example": "RedisAutoScaleUp",
2667
2674
  "member": "string",
2668
2675
  "name": "ProfileType",
@@ -2671,7 +2678,7 @@
2671
2678
  },
2672
2679
  {
2673
2680
  "disabled": false,
2674
- "document": "实列ID",
2681
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2675
2682
  "example": "crs-qtmkik3e",
2676
2683
  "member": "string",
2677
2684
  "name": "InstanceId",
@@ -2716,7 +2723,7 @@
2716
2723
  "members": [
2717
2724
  {
2718
2725
  "disabled": false,
2719
- "document": "服务产品类型,支持值包括: \"dcdb\" - 云数据库 Tdsql, \"mariadb\" - 云数据库 MariaDB for MariaDB。",
2726
+ "document": "服务产品类型,支持值包括: \"dcdb\" - 云数据库 Tdsql, \"mariadb\" - 云数据库 MariaDB for MariaDB, \"mysql\" - 云数据库 MySQL, \"cynosdb\" - 云数据库 CynosDB for MySQL, \"postgres\" - 云数据库 PostgreSQL。",
2720
2727
  "example": "dcdb",
2721
2728
  "member": "string",
2722
2729
  "name": "Product",
@@ -2725,7 +2732,7 @@
2725
2732
  },
2726
2733
  {
2727
2734
  "disabled": false,
2728
- "document": "Product保持一致。如:\"dcdb\" ,\"mariadb\"\t",
2735
+ "document": "NodeRequestType主要标识数据库产品类型,与Product保持一致。该字段规则如下: 当product为\"dcdb\"则输入\"dcdb\", 当product为\"mariadb\"则输入\"mariadb\", 当product为\"mysql\"则输入\"mysql\", 当product为\"cynosdb\"则输入\"mysql\", 当product为\"postgres\"则输入\"postgres\"。",
2729
2736
  "example": "dcdb",
2730
2737
  "member": "string",
2731
2738
  "name": "NodeRequestType",
@@ -2734,7 +2741,7 @@
2734
2741
  },
2735
2742
  {
2736
2743
  "disabled": false,
2737
- "document": "实例 ID ",
2744
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2738
2745
  "example": "tdsqlshard-eg8b01gr",
2739
2746
  "member": "string",
2740
2747
  "name": "InstanceId",
@@ -2743,7 +2750,7 @@
2743
2750
  },
2744
2751
  {
2745
2752
  "disabled": false,
2746
- "document": "审计日志文件生成异步任务ID",
2753
+ "document": "审计日志文件生成异步任务ID。可通过[查询审计日志文件](https://cloud.tencent.com/document/product/1130/90371)获得。",
2747
2754
  "example": "12",
2748
2755
  "member": "int64",
2749
2756
  "name": "AsyncRequestId",
@@ -2770,7 +2777,7 @@
2770
2777
  "members": [
2771
2778
  {
2772
2779
  "disabled": false,
2773
- "document": "需要删除的任务id列表",
2780
+ "document": "需要删除的任务id列表。可通过[查询健康报告生成任务列表](https://cloud.tencent.com/document/product/1130/57805)获取",
2774
2781
  "example": "[123,12]",
2775
2782
  "member": "int64",
2776
2783
  "name": "AsyncRequestIds",
@@ -2779,7 +2786,7 @@
2779
2786
  },
2780
2787
  {
2781
2788
  "disabled": false,
2782
- "document": "实例ID",
2789
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2783
2790
  "example": "crs-hor87q50",
2784
2791
  "member": "string",
2785
2792
  "name": "InstanceId",
@@ -2788,7 +2795,7 @@
2788
2795
  },
2789
2796
  {
2790
2797
  "disabled": false,
2791
- "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,默认为\"mysql\"。",
2798
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL,\"dbbrain-mysql\" - 自建 MySQL,\"redis\" - 云数据库 Redis,默认为\"mysql\"。",
2792
2799
  "example": "mysql",
2793
2800
  "member": "string",
2794
2801
  "name": "Product",
@@ -2807,6 +2814,7 @@
2807
2814
  "example": "0",
2808
2815
  "member": "int64",
2809
2816
  "name": "Status",
2817
+ "output_required": true,
2810
2818
  "type": "int",
2811
2819
  "value_allowed_null": false
2812
2820
  },
@@ -2924,7 +2932,7 @@
2924
2932
  "members": [
2925
2933
  {
2926
2934
  "disabled": false,
2927
- "document": "实例ID",
2935
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
2928
2936
  "example": "cdb-c1nl9rpv",
2929
2937
  "member": "string",
2930
2938
  "name": "InstanceId",
@@ -2933,8 +2941,8 @@
2933
2941
  },
2934
2942
  {
2935
2943
  "disabled": false,
2936
- "document": "限流任务ID列表。",
2937
- "example": "1432970",
2944
+ "document": "限流任务ID列表。通过接口[创建实例SQL限流任务](https://cloud.tencent.com/document/product/1130/72835)获得。",
2945
+ "example": "[1432970]",
2938
2946
  "member": "int64",
2939
2947
  "name": "FilterIds",
2940
2948
  "required": true,
@@ -2942,7 +2950,7 @@
2942
2950
  },
2943
2951
  {
2944
2952
  "disabled": false,
2945
- "document": "通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
2953
+ "document": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
2946
2954
  "example": "aOqcrCnPLZgCh41VqZVHda2Y+HI=:26872060",
2947
2955
  "member": "string",
2948
2956
  "name": "SessionToken",
@@ -2987,7 +2995,7 @@
2987
2995
  },
2988
2996
  {
2989
2997
  "disabled": false,
2990
- "document": "返回限制长度",
2998
+ "document": "返回限制长度,最大值: 50,默认值: 50",
2991
2999
  "example": "50",
2992
3000
  "member": "int64",
2993
3001
  "name": "Limit",
@@ -2996,7 +3004,7 @@
2996
3004
  },
2997
3005
  {
2998
3006
  "disabled": false,
2999
- "document": "偏置",
3007
+ "document": "偏置,最大值: 无限制,默认值: 0",
3000
3008
  "example": "0",
3001
3009
  "member": "int64",
3002
3010
  "name": "Offset",
@@ -3005,7 +3013,7 @@
3005
3013
  },
3006
3014
  {
3007
3015
  "disabled": false,
3008
- "document": "mysql - mysql\ncynosdb - tdsql-c",
3016
+ "document": "服务产品类型,支持值:\"mysql\" - 云数据库 MySQL;\"cynosdb\" - 云数据库 TDSQL-C for MySQL",
3009
3017
  "example": "mysql",
3010
3018
  "member": "string",
3011
3019
  "name": "Product",
@@ -3031,7 +3039,7 @@
3031
3039
  {
3032
3040
  "disabled": false,
3033
3041
  "document": "模板总数",
3034
- "example": "总数",
3042
+ "example": "1",
3035
3043
  "member": "int64",
3036
3044
  "name": "TotalCount",
3037
3045
  "output_required": false,
@@ -3173,7 +3181,7 @@
3173
3181
  },
3174
3182
  {
3175
3183
  "disabled": false,
3176
- "document": "Product保持一致。如:\"dcdb\" ,\"mariadb\"。",
3184
+ "document": "NodeRequestType主要标识数据库产品类型,与Product保持一致。如:\"dcdb\" ,\"mariadb\"。",
3177
3185
  "example": "dcdb",
3178
3186
  "member": "string",
3179
3187
  "name": "NodeRequestType",
@@ -3209,7 +3217,7 @@
3209
3217
  },
3210
3218
  {
3211
3219
  "disabled": false,
3212
- "document": "查询实例的搜索条件。",
3220
+ "document": "查询实例的搜索条件。Name包括:InstanceId, InstanceName。",
3213
3221
  "example": "无",
3214
3222
  "member": "AuditInstanceFilter",
3215
3223
  "name": "Filters",
@@ -3274,7 +3282,7 @@
3274
3282
  },
3275
3283
  {
3276
3284
  "disabled": false,
3277
- "document": "实例 ID ",
3285
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
3278
3286
  "example": "tdsqlshard-eg8b01gr",
3279
3287
  "member": "string",
3280
3288
  "name": "InstanceId",
@@ -3339,7 +3347,7 @@
3339
3347
  "members": [
3340
3348
  {
3341
3349
  "disabled": false,
3342
- "document": "自治任务ID",
3350
+ "document": "自治任务ID。可通过 [DescribeDBAutonomyActions](https://cloud.tencent.com/document/product/1130/116974) 接口获取。",
3343
3351
  "example": "12",
3344
3352
  "member": "int64",
3345
3353
  "name": "ActionId",
@@ -3348,7 +3356,7 @@
3348
3356
  },
3349
3357
  {
3350
3358
  "disabled": false,
3351
- "document": "实列ID",
3359
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
3352
3360
  "example": "crs-qtmkik3e",
3353
3361
  "member": "string",
3354
3362
  "name": "InstanceId",
@@ -3412,7 +3420,7 @@
3412
3420
  },
3413
3421
  {
3414
3422
  "disabled": false,
3415
- "document": "自治任务触发时间。",
3423
+ "document": "自治任务触发时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3416
3424
  "example": "2025-03-12 00:00:00",
3417
3425
  "member": "string",
3418
3426
  "name": "TriggerTime",
@@ -3422,7 +3430,7 @@
3422
3430
  },
3423
3431
  {
3424
3432
  "disabled": false,
3425
- "document": "自治任务创建时间。",
3433
+ "document": "自治任务创建时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3426
3434
  "example": "2025-03-12 00:00:00",
3427
3435
  "member": "string",
3428
3436
  "name": "CreateTime",
@@ -3432,7 +3440,7 @@
3432
3440
  },
3433
3441
  {
3434
3442
  "disabled": false,
3435
- "document": "自治任务更新时间。",
3443
+ "document": "自治任务更新时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3436
3444
  "example": "2025-03-12 00:00:00",
3437
3445
  "member": "string",
3438
3446
  "name": "UpdateTime",
@@ -3442,7 +3450,7 @@
3442
3450
  },
3443
3451
  {
3444
3452
  "disabled": false,
3445
- "document": "自治任务完成时间。",
3453
+ "document": "自治任务完成时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3446
3454
  "example": "2025-03-12 00:00:00",
3447
3455
  "member": "string",
3448
3456
  "name": "FinishTime",
@@ -3472,7 +3480,7 @@
3472
3480
  },
3473
3481
  {
3474
3482
  "disabled": false,
3475
- "document": "自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED",
3483
+ "document": "自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED\n其中:\nRUNNING - 运行中 \nFINISHED - 已完成 \nTERMINATED - 已终止 \nCANCELLED - 已取消 \n",
3476
3484
  "example": "RUNNING",
3477
3485
  "member": "string",
3478
3486
  "name": "Status",
@@ -3504,7 +3512,7 @@
3504
3512
  "members": [
3505
3513
  {
3506
3514
  "disabled": false,
3507
- "document": "事件ID",
3515
+ "document": "事件ID。可通过 [DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) 接口获取。",
3508
3516
  "example": "12",
3509
3517
  "member": "int64",
3510
3518
  "name": "EventId",
@@ -3513,7 +3521,7 @@
3513
3521
  },
3514
3522
  {
3515
3523
  "disabled": false,
3516
- "document": "实列ID",
3524
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
3517
3525
  "example": "crs-qtmkik3e",
3518
3526
  "member": "string",
3519
3527
  "name": "InstanceId",
@@ -3661,8 +3669,8 @@
3661
3669
  "members": [
3662
3670
  {
3663
3671
  "disabled": false,
3664
- "document": "实例 ID ",
3665
- "example": "cdb-test1234",
3672
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
3673
+ "example": "cdb-test156",
3666
3674
  "member": "string",
3667
3675
  "name": "InstanceId",
3668
3676
  "required": true,
@@ -3670,7 +3678,7 @@
3670
3678
  },
3671
3679
  {
3672
3680
  "disabled": false,
3673
- "document": "事件 ID 。通过“获取实例诊断历史DescribeDBDiagHistory”获取。",
3681
+ "document": "事件 ID 。通过“获取实例诊断历史[DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) ”获取。",
3674
3682
  "example": "5",
3675
3683
  "member": "int64",
3676
3684
  "name": "EventId",
@@ -3704,7 +3712,7 @@
3704
3712
  },
3705
3713
  {
3706
3714
  "disabled": false,
3707
- "document": "诊断类型。",
3715
+ "document": "诊断类型。支持值包括\"高危账号\",\"自增键耗尽\",\"连接性检查\",\"CPU利用率\",\"死锁\",\"全表扫描\",\"高并发/压力请求\",\"预编译语句过多\",\"内存利用率\",\"Metadata lock\",\"磁盘超限\",\"内存超限\",\"只读锁\",\"只读实例剔除\",\"行锁\",\"活跃会话\",\"慢SQL\",\"数据库快照\",\"磁盘空间利用率\",\"执行计划变化\",\"主从切换\",\"Table open cache命中率低\",\"大表\",\"事务未提交\",\"事务导致复制延迟\"等。",
3708
3716
  "example": "数据库快照",
3709
3717
  "member": "string",
3710
3718
  "name": "DiagType",
@@ -3764,7 +3772,7 @@
3764
3772
  },
3765
3773
  {
3766
3774
  "disabled": false,
3767
- "document": "开始时间",
3775
+ "document": "开始时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3768
3776
  "example": "2019-11-06 12:05:40",
3769
3777
  "member": "datetime",
3770
3778
  "name": "StartTime",
@@ -3794,7 +3802,7 @@
3794
3802
  },
3795
3803
  {
3796
3804
  "disabled": false,
3797
- "document": "结束时间。",
3805
+ "document": "结束时间。格式: \"yyyy-MM-dd HH:mm:ss\"",
3798
3806
  "example": "2019-11-06 12:05:50",
3799
3807
  "member": "datetime",
3800
3808
  "name": "EndTime",
@@ -3917,7 +3925,7 @@
3917
3925
  "members": [
3918
3926
  {
3919
3927
  "disabled": false,
3920
- "document": "实例 ID ",
3928
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
3921
3929
  "example": "cdb-test",
3922
3930
  "member": "string",
3923
3931
  "name": "InstanceId",
@@ -3926,7 +3934,7 @@
3926
3934
  },
3927
3935
  {
3928
3936
  "disabled": false,
3929
- "document": "开始时间,如“2019-09-10 12:13:14”。",
3937
+ "document": "开始时间,如“2019-09-10 12:13:14”。结束时间与开始时间的间隔最大可为2天。",
3930
3938
  "example": "2019-01-01 00:00:00",
3931
3939
  "member": "datetime",
3932
3940
  "name": "StartTime",
@@ -3963,7 +3971,7 @@
3963
3971
  "example": "无",
3964
3972
  "member": "DiagHistoryEventItem",
3965
3973
  "name": "Events",
3966
- "required": true,
3974
+ "output_required": true,
3967
3975
  "type": "list",
3968
3976
  "value_allowed_null": false
3969
3977
  },
@@ -4597,7 +4605,7 @@
4597
4605
  },
4598
4606
  {
4599
4607
  "disabled": false,
4600
- "document": "实例ID",
4608
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
4601
4609
  "example": "cmgo-2jrxxlx",
4602
4610
  "member": "string",
4603
4611
  "name": "InstanceId",
@@ -4624,8 +4632,8 @@
4624
4632
  },
4625
4633
  {
4626
4634
  "disabled": false,
4627
- "document": "签名。这个值是DescribelndexRecommendInfo接口返回",
4628
- "example": "d6e6fe0025c258592dd6f442312f26ww",
4635
+ "document": "签名。这个值是 [DescribeIndexRecommendInfo](https://cloud.tencent.com/document/product/1130/98911) 接口返回",
4636
+ "example": "[\"d6e6fe0025c258592dd6f442312f26ww\"]",
4629
4637
  "member": "string",
4630
4638
  "name": "Signs",
4631
4639
  "required": true,
@@ -4640,7 +4648,7 @@
4640
4648
  {
4641
4649
  "disabled": false,
4642
4650
  "document": "查询实例慢查询聚合结果。",
4643
- "example": "{\"AvgExecTime\":1208,\"AvgDocsExamined\":12660,\"SlowLogCount\":3,\"SlowLogs\":[],\"SortCount\":0}",
4651
+ "example": "",
4644
4652
  "member": "Aggregation",
4645
4653
  "name": "Aggregation",
4646
4654
  "output_required": true,
@@ -4670,7 +4678,7 @@
4670
4678
  },
4671
4679
  {
4672
4680
  "disabled": false,
4673
- "document": "实例ID",
4681
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
4674
4682
  "example": "cmgo-2jrxxlx",
4675
4683
  "member": "string",
4676
4684
  "name": "InstanceId",
@@ -4706,7 +4714,7 @@
4706
4714
  {
4707
4715
  "disabled": false,
4708
4716
  "document": "索引项。",
4709
- "example": " ",
4717
+ "example": "",
4710
4718
  "member": "MongoDBIndex",
4711
4719
  "name": "Items",
4712
4720
  "output_required": true,
@@ -4835,12 +4843,94 @@
4835
4843
  ],
4836
4844
  "type": "object"
4837
4845
  },
4846
+ "DescribeMetricTopProxiesRequest": {
4847
+ "document": "DescribeMetricTopProxies请求参数结构体",
4848
+ "members": [
4849
+ {
4850
+ "disabled": false,
4851
+ "document": "开始时间,如“2021-05-27 00:00:00”,支持的最早查询时间为当前时间的前30天。",
4852
+ "example": "2025-09-03T10:41:59+08:00",
4853
+ "member": "datetime_iso",
4854
+ "name": "StartTime",
4855
+ "required": true,
4856
+ "type": "string"
4857
+ },
4858
+ {
4859
+ "disabled": false,
4860
+ "document": "结束时间,如“2021-05-27 01:00:00”,支持的最早查询时间为当前时间的前30天。",
4861
+ "example": "2025-09-03T10:41:59+08:00",
4862
+ "member": "datetime_iso",
4863
+ "name": "EndTime",
4864
+ "required": true,
4865
+ "type": "string"
4866
+ },
4867
+ {
4868
+ "disabled": false,
4869
+ "document": "实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
4870
+ "example": "crs-qjdkzsat",
4871
+ "member": "string",
4872
+ "name": "InstanceId",
4873
+ "required": true,
4874
+ "type": "string"
4875
+ },
4876
+ {
4877
+ "disabled": false,
4878
+ "document": "服务产品类型,支持值包括:\"mysql\" - 云数据库 MySQL,\"redis\" - 云数据库 Redis,\"mariadb\"-数据库mariadb 默认为\"mysql\"。",
4879
+ "example": "redis",
4880
+ "member": "string",
4881
+ "name": "Product",
4882
+ "required": true,
4883
+ "type": "string"
4884
+ },
4885
+ {
4886
+ "disabled": false,
4887
+ "document": "指标 eg: cpu_util, connections",
4888
+ "example": "connections",
4889
+ "member": "string",
4890
+ "name": "Metric",
4891
+ "required": true,
4892
+ "type": "string"
4893
+ },
4894
+ {
4895
+ "disabled": false,
4896
+ "document": "默认前20条",
4897
+ "example": "10",
4898
+ "member": "uint64",
4899
+ "name": "Limit",
4900
+ "required": false,
4901
+ "type": "int"
4902
+ }
4903
+ ],
4904
+ "type": "object"
4905
+ },
4906
+ "DescribeMetricTopProxiesResponse": {
4907
+ "document": "DescribeMetricTopProxies返回参数结构体",
4908
+ "members": [
4909
+ {
4910
+ "disabled": false,
4911
+ "document": "命令列表",
4912
+ "example": "无",
4913
+ "member": "RedisMetricTopProxiesData",
4914
+ "name": "Data",
4915
+ "output_required": true,
4916
+ "type": "list",
4917
+ "value_allowed_null": false
4918
+ },
4919
+ {
4920
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4921
+ "member": "string",
4922
+ "name": "RequestId",
4923
+ "type": "string"
4924
+ }
4925
+ ],
4926
+ "type": "object"
4927
+ },
4838
4928
  "DescribeMySqlProcessListRequest": {
4839
4929
  "document": "DescribeMySqlProcessList请求参数结构体",
4840
4930
  "members": [
4841
4931
  {
4842
4932
  "disabled": false,
4843
- "document": "实例ID",
4933
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
4844
4934
  "example": "cdb-c1nl9rpv",
4845
4935
  "member": "string",
4846
4936
  "name": "InstanceId",
@@ -4885,7 +4975,7 @@
4885
4975
  },
4886
4976
  {
4887
4977
  "disabled": false,
4888
- "document": "线程的操作状态,用于筛选线程列表。",
4978
+ "document": "线程的操作状态,用于筛选线程列表。包含以下值:Sending data,Updating, Opening tables 等",
4889
4979
  "example": "updating",
4890
4980
  "member": "string",
4891
4981
  "name": "State",
@@ -4894,7 +4984,7 @@
4894
4984
  },
4895
4985
  {
4896
4986
  "disabled": false,
4897
- "document": "线程的执行类型,用于筛选线程列表。",
4987
+ "document": "线程的操作状态,用于筛选线程列表。包含以下值:Sending data,Updating, Opening tables 等",
4898
4988
  "example": "Execute",
4899
4989
  "member": "string",
4900
4990
  "name": "Command",
@@ -4986,7 +5076,7 @@
4986
5076
  "members": [
4987
5077
  {
4988
5078
  "disabled": false,
4989
- "document": "实例ID",
5079
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
4990
5080
  "example": "cdb-c1nl9rpv",
4991
5081
  "member": "string",
4992
5082
  "name": "InstanceId",
@@ -5329,8 +5419,8 @@
5329
5419
  "members": [
5330
5420
  {
5331
5421
  "disabled": false,
5332
- "document": "实例 ID",
5333
- "example": "crs-test1234",
5422
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
5423
+ "example": "crs-test1214",
5334
5424
  "member": "string",
5335
5425
  "name": "InstanceId",
5336
5426
  "required": true,
@@ -5374,7 +5464,7 @@
5374
5464
  },
5375
5465
  {
5376
5466
  "disabled": false,
5377
- "document": "监控指标,以逗号分隔",
5467
+ "document": "监控指标,包括:qps,latency_p99,latency_avg,latency_max,以逗号分隔\n其中:\nqps - 每秒查询率 \nlatency_p99 - 99分位延迟 \nlatency_avg - 平均延迟 \nlatency_max - 最大延迟 \n",
5378
5468
  "example": "\"qps,latency_p99,latency_avg,latency_max\"",
5379
5469
  "member": "string",
5380
5470
  "name": "Metric",
@@ -5383,7 +5473,7 @@
5383
5473
  },
5384
5474
  {
5385
5475
  "disabled": false,
5386
- "document": "监控指标时间粒度,单位秒,若不提供则根据开始时间和结束时间取默认值",
5476
+ "document": "Period,监控指标时间粒度,单位秒,若不提供则根据开始时间和结束时间取默认值",
5387
5477
  "example": "60",
5388
5478
  "member": "int64",
5389
5479
  "name": "Period",
@@ -5420,8 +5510,8 @@
5420
5510
  "members": [
5421
5511
  {
5422
5512
  "disabled": false,
5423
- "document": "实例 ID",
5424
- "example": "crs-test1234",
5513
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
5514
+ "example": "crs-test1214",
5425
5515
  "member": "string",
5426
5516
  "name": "InstanceId",
5427
5517
  "required": true,
@@ -5484,8 +5574,8 @@
5484
5574
  "members": [
5485
5575
  {
5486
5576
  "disabled": false,
5487
- "document": "实例 ID",
5488
- "example": "crs-test1234",
5577
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
5578
+ "example": "crs-test1214",
5489
5579
  "member": "string",
5490
5580
  "name": "InstanceId",
5491
5581
  "required": true,
@@ -5548,7 +5638,7 @@
5548
5638
  "members": [
5549
5639
  {
5550
5640
  "disabled": false,
5551
- "document": "Redis 实例ID",
5641
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
5552
5642
  "example": "crs-qylqkl4f",
5553
5643
  "member": "string",
5554
5644
  "name": "InstanceId",
@@ -5741,8 +5831,8 @@
5741
5831
  "members": [
5742
5832
  {
5743
5833
  "disabled": false,
5744
- "document": "实例ID",
5745
- "example": "cdb-c1nl9rpv",
5834
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
5835
+ "example": "crs-occia4d6",
5746
5836
  "member": "string",
5747
5837
  "name": "InstanceId",
5748
5838
  "required": true,
@@ -5924,8 +6014,8 @@
5924
6014
  "members": [
5925
6015
  {
5926
6016
  "disabled": false,
5927
- "document": "实例 ID ",
5928
- "example": "crs-test1234",
6017
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
6018
+ "example": "crs-test1214",
5929
6019
  "member": "string",
5930
6020
  "name": "InstanceId",
5931
6021
  "required": true,
@@ -6236,8 +6326,8 @@
6236
6326
  "members": [
6237
6327
  {
6238
6328
  "disabled": false,
6239
- "document": "实例 ID ",
6240
- "example": "cdb-test1234",
6329
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
6330
+ "example": "cdb-test1254",
6241
6331
  "member": "string",
6242
6332
  "name": "InstanceId",
6243
6333
  "required": true,
@@ -6245,7 +6335,7 @@
6245
6335
  },
6246
6336
  {
6247
6337
  "disabled": false,
6248
- "document": "开始时间,如“2019-09-10 12:13:14”。",
6338
+ "document": "开始时间,如“2019-09-10 12:13:14”,截止时间与开始时间的间隔小于7天。",
6249
6339
  "example": "2019-01-01 00:00:00",
6250
6340
  "member": "datetime",
6251
6341
  "name": "StartTime",
@@ -6281,7 +6371,7 @@
6281
6371
  },
6282
6372
  {
6283
6373
  "disabled": false,
6284
- "document": "实列节点ID。",
6374
+ "document": "实例节点ID。",
6285
6375
  "example": "cmgo-8d8e5c87_0-node-slave0",
6286
6376
  "member": "string",
6287
6377
  "name": "InstanceNodeId",
@@ -6290,7 +6380,7 @@
6290
6380
  },
6291
6381
  {
6292
6382
  "disabled": false,
6293
- "document": "查询类型,目前支持值:mongod,mongos",
6383
+ "document": "查询类型,目前支持值:mongod,mongos。\n其中:\nmongod - MongoDB的数据存储节点\nmongos - MongoDB的路由节点",
6294
6384
  "example": "mongod",
6295
6385
  "member": "string",
6296
6386
  "name": "Type",
@@ -6698,7 +6788,7 @@
6698
6788
  {
6699
6789
  "disabled": false,
6700
6790
  "document": "开始时间,如“2019-09-10 12:13:14”。",
6701
- "example": "2019-01-01 00:00:00",
6791
+ "example": "2025-09-02T01:14:01+08:00",
6702
6792
  "member": "datetime_iso",
6703
6793
  "name": "StartTime",
6704
6794
  "required": true,
@@ -6707,7 +6797,7 @@
6707
6797
  {
6708
6798
  "disabled": false,
6709
6799
  "document": "截止时间,如“2019-09-11 10:13:14”,截止时间与开始时间的间隔小于7天。",
6710
- "example": "2019-01-01 01:00:00",
6800
+ "example": "2025-09-02T01:15:01+08:00",
6711
6801
  "member": "datetime_iso",
6712
6802
  "name": "EndTime",
6713
6803
  "required": true,
@@ -6734,7 +6824,7 @@
6734
6824
  {
6735
6825
  "disabled": false,
6736
6826
  "document": "数据库列表",
6737
- "example": "[\"test\"]",
6827
+ "example": "[\"db\"]",
6738
6828
  "member": "string",
6739
6829
  "name": "DB",
6740
6830
  "required": false,
@@ -6752,7 +6842,7 @@
6752
6842
  {
6753
6843
  "disabled": false,
6754
6844
  "document": "用户",
6755
- "example": "[\"root\",\"test\"]",
6845
+ "example": "[\"user1\",\"user2\"]",
6756
6846
  "member": "string",
6757
6847
  "name": "User",
6758
6848
  "required": false,
@@ -6795,7 +6885,7 @@
6795
6885
  {
6796
6886
  "disabled": false,
6797
6887
  "document": "慢日志明细",
6798
- "example": "[{\"LockTime\":0,\"UserHost\":\"169.254.128.9\",\"RowsSent\":1,\"UserName\":\"root\",\"Database\":\"information_schema\",\"SqlText\":\"/* dbbrain user mark */select SLEEP(10)\",\"QueryTime\":10,\"RowsExamined\":0,\"Timestamp\":\"2023-03-31 10:47:35\"}]",
6888
+ "example": "",
6799
6889
  "member": "SlowLogInfoItem",
6800
6890
  "name": "Rows",
6801
6891
  "output_required": true,
@@ -6816,7 +6906,7 @@
6816
6906
  "members": [
6817
6907
  {
6818
6908
  "disabled": false,
6819
- "document": "实例ID",
6909
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
6820
6910
  "example": "cdb-c1nl9rpv",
6821
6911
  "member": "string",
6822
6912
  "name": "InstanceId",
@@ -6835,7 +6925,7 @@
6835
6925
  {
6836
6926
  "disabled": false,
6837
6927
  "document": "任务状态列表,用于筛选任务列表,取值包括RUNNING - 运行中, FINISHED - 已完成, TERMINATED - 已终止。",
6838
- "example": "RUNNING",
6928
+ "example": "[\"RUNNING\"]",
6839
6929
  "member": "string",
6840
6930
  "name": "Statuses",
6841
6931
  "required": false,
@@ -6908,8 +6998,8 @@
6908
6998
  "members": [
6909
6999
  {
6910
7000
  "disabled": false,
6911
- "document": "实例ID",
6912
- "example": "cdb-test1234",
7001
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
7002
+ "example": "cdb-test1214",
6913
7003
  "member": "string",
6914
7004
  "name": "InstanceId",
6915
7005
  "required": true,
@@ -6980,7 +7070,7 @@
6980
7070
  },
6981
7071
  {
6982
7072
  "disabled": false,
6983
- "document": "SQL模版内容。",
7073
+ "document": "SQL模板内容。",
6984
7074
  "example": "select * from test limit ?",
6985
7075
  "member": "string",
6986
7076
  "name": "SqlTemplate",
@@ -6990,7 +7080,7 @@
6990
7080
  },
6991
7081
  {
6992
7082
  "disabled": false,
6993
- "document": "SQL模版ID。",
7083
+ "document": "SQL模板ID。",
6994
7084
  "example": "-5602209514906915428",
6995
7085
  "member": "int64",
6996
7086
  "name": "SqlId",
@@ -7094,7 +7184,7 @@
7094
7184
  "members": [
7095
7185
  {
7096
7186
  "disabled": false,
7097
- "document": "实例 ID ",
7187
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
7098
7188
  "example": "cdb-c1nl9rpv",
7099
7189
  "member": "string",
7100
7190
  "name": "InstanceId",
@@ -7112,7 +7202,7 @@
7112
7202
  },
7113
7203
  {
7114
7204
  "disabled": false,
7115
- "document": "筛选Top库所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength",
7205
+ "document": "筛选Top库所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。\n其中:\nDataLength - 数据长度 \nIndexLength - 索引长度 \nTotalLength - 总长度 \nDataFree - 空闲空间 \nFragRatio - 碎片率 \nTableRows - 表行数 \nPhysicalFileSize - 物理文件大小",
7116
7206
  "example": "TableRows",
7117
7207
  "member": "string",
7118
7208
  "name": "SortBy",
@@ -7140,7 +7230,7 @@
7140
7230
  "example": "无",
7141
7231
  "member": "SchemaSpaceData",
7142
7232
  "name": "TopSpaceSchemas",
7143
- "required": true,
7233
+ "output_required": true,
7144
7234
  "type": "list",
7145
7235
  "value_allowed_null": false
7146
7236
  },
@@ -7150,7 +7240,7 @@
7150
7240
  "example": "1603819881",
7151
7241
  "member": "int64",
7152
7242
  "name": "Timestamp",
7153
- "required": true,
7243
+ "output_required": true,
7154
7244
  "type": "int",
7155
7245
  "value_allowed_null": false
7156
7246
  },
@@ -7250,8 +7340,8 @@
7250
7340
  "members": [
7251
7341
  {
7252
7342
  "disabled": false,
7253
- "document": "实例 ID ",
7254
- "example": "cdb-test1234",
7343
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
7344
+ "example": "cdb-test1214",
7255
7345
  "member": "string",
7256
7346
  "name": "InstanceId",
7257
7347
  "required": true,
@@ -7268,7 +7358,7 @@
7268
7358
  },
7269
7359
  {
7270
7360
  "disabled": false,
7271
- "document": "筛选Top表所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength",
7361
+ "document": "筛选Top表所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。\n其中:\nDataLength - 数据长度 \nIndexLength - 索引长度 \nTotalLength - 总长度 \nDataFree - 空闲空间 \nFragRatio - 碎片率 \nTableRows - 表行数 \nPhysicalFileSize - 物理文件大小",
7272
7362
  "example": "TableRows",
7273
7363
  "member": "string",
7274
7364
  "name": "SortBy",
@@ -7399,7 +7489,7 @@
7399
7489
  "members": [
7400
7490
  {
7401
7491
  "disabled": false,
7402
- "document": "实例ID",
7492
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
7403
7493
  "example": "cdb-c1nl9rpv",
7404
7494
  "member": "string",
7405
7495
  "name": "InstanceId",
@@ -8811,7 +8901,7 @@
8811
8901
  "members": [
8812
8902
  {
8813
8903
  "disabled": false,
8814
- "document": "实例ID",
8904
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
8815
8905
  "example": "cdb-test1",
8816
8906
  "member": "string",
8817
8907
  "name": "InstanceId",
@@ -8829,8 +8919,8 @@
8829
8919
  },
8830
8920
  {
8831
8921
  "disabled": false,
8832
- "document": "需要kill的sql会话ID列表,此参数用于Prepare阶段。",
8833
- "example": "[\"4714056\"]",
8922
+ "document": "需要kill的sql会话ID列表,通过接口[查询实时线程列表](https://cloud.tencent.com/document/product/1130/57824)\n此参数用于Prepare阶段。",
8923
+ "example": "[4714056]",
8834
8924
  "member": "int64",
8835
8925
  "name": "Threads",
8836
8926
  "required": false,
@@ -8907,6 +8997,7 @@
8907
8997
  "example": "1",
8908
8998
  "member": "int64",
8909
8999
  "name": "SendMail",
9000
+ "output_required": true,
8910
9001
  "required": true,
8911
9002
  "type": "int",
8912
9003
  "value_allowed_null": false
@@ -8917,16 +9008,18 @@
8917
9008
  "example": "[\"ap-guangzhou\"]",
8918
9009
  "member": "string",
8919
9010
  "name": "Region",
9011
+ "output_required": true,
8920
9012
  "required": true,
8921
9013
  "type": "list",
8922
9014
  "value_allowed_null": false
8923
9015
  },
8924
9016
  {
8925
9017
  "disabled": false,
8926
- "document": "发送指定的健康等级的报告, 如[\"HEALTH\", \"SUB_HEALTH\", \"RISK\", \"HIGH_RISK\"]。",
9018
+ "document": "包含的健康等级,包括值:HEALTH-健康,SUB_HEALTH-亚健康,RISK-风险,HIGH_RISK-高危。",
8927
9019
  "example": "[\"HEALTH\"]",
8928
9020
  "member": "string",
8929
9021
  "name": "HealthStatus",
9022
+ "output_required": true,
8930
9023
  "required": true,
8931
9024
  "type": "list",
8932
9025
  "value_allowed_null": false
@@ -8937,6 +9030,7 @@
8937
9030
  "example": "[1,2]",
8938
9031
  "member": "int64",
8939
9032
  "name": "ContactPerson",
9033
+ "output_required": true,
8940
9034
  "required": false,
8941
9035
  "type": "list",
8942
9036
  "value_allowed_null": false
@@ -8947,6 +9041,7 @@
8947
9041
  "example": "[1,2]",
8948
9042
  "member": "int64",
8949
9043
  "name": "ContactGroup",
9044
+ "output_required": true,
8950
9045
  "required": false,
8951
9046
  "type": "list",
8952
9047
  "value_allowed_null": false
@@ -8995,7 +9090,7 @@
8995
9090
  "members": [
8996
9091
  {
8997
9092
  "disabled": false,
8998
- "document": "类型",
9093
+ "document": "策略类型,固定值:instance, instance-代表实例类型策略",
8999
9094
  "example": "instance",
9000
9095
  "member": "string",
9001
9096
  "name": "ApplyType",
@@ -9004,7 +9099,7 @@
9004
9099
  },
9005
9100
  {
9006
9101
  "disabled": false,
9007
- "document": "开启策略",
9102
+ "document": "策略是否开启,0-代表开启,1-代表关闭",
9008
9103
  "example": "1",
9009
9104
  "member": "int64",
9010
9105
  "name": "Enable",
@@ -9013,8 +9108,8 @@
9013
9108
  },
9014
9109
  {
9015
9110
  "disabled": false,
9016
- "document": "列表",
9017
- "example": "[{InstanceId: \"cdb-k9p7z9l9\"}]",
9111
+ "document": "实例id列表,可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
9112
+ "example": "",
9018
9113
  "member": "InstanceID",
9019
9114
  "name": "InstanceIds",
9020
9115
  "required": true,
@@ -9031,7 +9126,7 @@
9031
9126
  },
9032
9127
  {
9033
9128
  "disabled": false,
9034
- "document": "新策略名",
9129
+ "document": "新策略名,包含中文英文数字,长度在60个字符以内,不能以“_”开头。",
9035
9130
  "example": "demoProfileName",
9036
9131
  "member": "string",
9037
9132
  "name": "NewProfileName",
@@ -9040,7 +9135,7 @@
9040
9135
  },
9041
9136
  {
9042
9137
  "disabled": false,
9043
- "document": "旧策略名",
9138
+ "document": "旧策略名,包含中文英文数字,长度在60个字符以内,不能以“_”开头。",
9044
9139
  "example": "oldProfileName",
9045
9140
  "member": "string",
9046
9141
  "name": "ProfileName",
@@ -9049,7 +9144,7 @@
9049
9144
  },
9050
9145
  {
9051
9146
  "disabled": false,
9052
- "document": "策略类型",
9147
+ "document": "策略类型,固定值:alarm_policy",
9053
9148
  "example": "alarm_policy",
9054
9149
  "member": "string",
9055
9150
  "name": "ProfileType",
@@ -9085,7 +9180,7 @@
9085
9180
  },
9086
9181
  {
9087
9182
  "disabled": false,
9088
- "document": "快速规则 支持包括fatal-致命, critical-严重,\nwarning-告警,\ninformation-通知",
9183
+ "document": "快速规则 支持包括fatal-致命, critical-严重,\nwarning-告警,\ninformation-通知,与Rules互斥",
9089
9184
  "example": "fatal",
9090
9185
  "member": "string",
9091
9186
  "name": "QuickRule",
@@ -9094,7 +9189,7 @@
9094
9189
  },
9095
9190
  {
9096
9191
  "disabled": false,
9097
- "document": "自定义规则",
9192
+ "document": "自定义规则,与QuickRule互斥。",
9098
9193
  "example": "无",
9099
9194
  "member": "AlarmsRules",
9100
9195
  "name": "Rules",
@@ -9203,7 +9298,7 @@
9203
9298
  },
9204
9299
  {
9205
9300
  "disabled": false,
9206
- "document": "生效实例地域,取值为\"All\",代表全地域。",
9301
+ "document": "生效实例地域,固定为\"All\",代表全地域。",
9207
9302
  "example": "All",
9208
9303
  "member": "string",
9209
9304
  "name": "Regions",
@@ -9221,8 +9316,8 @@
9221
9316
  },
9222
9317
  {
9223
9318
  "disabled": false,
9224
- "document": "指定更改巡检状态的实例ID",
9225
- "example": "[\"cdb-fyclrp7r\\n\"]",
9319
+ "document": "指定更改巡检状态的实例ID。\n可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。\n",
9320
+ "example": "[\"cdb-fyclrp7rn\"]",
9226
9321
  "member": "string",
9227
9322
  "name": "InstanceIds",
9228
9323
  "required": false,
@@ -9248,7 +9343,7 @@
9248
9343
  "members": [
9249
9344
  {
9250
9345
  "disabled": false,
9251
- "document": "实例ID",
9346
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
9252
9347
  "example": "cdb-c1nl9rpv",
9253
9348
  "member": "string",
9254
9349
  "name": "InstanceId",
@@ -9257,7 +9352,7 @@
9257
9352
  },
9258
9353
  {
9259
9354
  "disabled": false,
9260
- "document": "SQL限流任务ID列表。",
9355
+ "document": "SQL限流任务ID列表。可通过接口[查询实例SQL限流任务列表\n](https://cloud.tencent.com/document/product/1130/72831)获得。",
9261
9356
  "example": "[1433288]",
9262
9357
  "member": "int64",
9263
9358
  "name": "FilterIds",
@@ -9266,7 +9361,7 @@
9266
9361
  },
9267
9362
  {
9268
9363
  "disabled": false,
9269
- "document": "限流任务状态,取值支持TERMINATED - 终止。",
9364
+ "document": "限流任务状态,仅支持传参TERMINATED - 终止。",
9270
9365
  "example": "TERMINATED",
9271
9366
  "member": "string",
9272
9367
  "name": "Status",
@@ -9275,7 +9370,7 @@
9275
9370
  },
9276
9371
  {
9277
9372
  "disabled": false,
9278
- "document": "通过VerifyUserAccount获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
9373
+ "document": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token,使用后会自动延长token有效期至五分钟后。",
9279
9374
  "example": "cauth",
9280
9375
  "member": "string",
9281
9376
  "name": "SessionToken",
@@ -9320,7 +9415,7 @@
9320
9415
  },
9321
9416
  {
9322
9417
  "disabled": false,
9323
- "document": "实列ID",
9418
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
9324
9419
  "example": "crs-qtmkik3e",
9325
9420
  "member": "string",
9326
9421
  "name": "InstanceId",
@@ -9540,7 +9635,7 @@
9540
9635
  {
9541
9636
  "disabled": false,
9542
9637
  "document": "监控指标。",
9543
- "example": "[{\"Values\":[1.0,1.0],\"Metric\":\"cpu_use_rate\",\"Unit\":\"%\"}]",
9638
+ "example": "",
9544
9639
  "member": "MonitorMetric",
9545
9640
  "name": "Series",
9546
9641
  "output_required": true,
@@ -9549,7 +9644,7 @@
9549
9644
  },
9550
9645
  {
9551
9646
  "disabled": false,
9552
- "document": "监控指标对应的时间戳。",
9647
+ "document": "监控指标对应的时间戳。(精度:秒)",
9553
9648
  "example": "[1622087750,1622087760]",
9554
9649
  "member": "int64",
9555
9650
  "name": "Timestamp",
@@ -9734,7 +9829,7 @@
9734
9829
  },
9735
9830
  {
9736
9831
  "disabled": false,
9737
- "document": "访问来源,IP 地址和端口号。",
9832
+ "document": "访问来源,IP 地址和端口号。\n格式:IP:Port",
9738
9833
  "example": "100.1.232.215:3006",
9739
9834
  "member": "string",
9740
9835
  "name": "Address",
@@ -9846,7 +9941,7 @@
9846
9941
  "members": [
9847
9942
  {
9848
9943
  "disabled": false,
9849
- "document": "语言, 如\"zh\"。",
9944
+ "document": "语言类型, 包含“zh”-中文,“en”-英文。",
9850
9945
  "example": "zh",
9851
9946
  "member": "string",
9852
9947
  "name": "Language",
@@ -9884,7 +9979,7 @@
9884
9979
  },
9885
9980
  {
9886
9981
  "disabled": false,
9887
- "document": "最后接收时间",
9982
+ "document": "最后接收时间,格式: \"HH:mm:ss\"",
9888
9983
  "example": "23:59:59",
9889
9984
  "member": "string",
9890
9985
  "name": "EndReceiveTime",
@@ -9914,7 +10009,7 @@
9914
10009
  },
9915
10010
  {
9916
10011
  "disabled": false,
9917
- "document": "开始时间",
10012
+ "document": "开始时间,格式: \"HH:mm:ss\"",
9918
10013
  "example": "00:00:00",
9919
10014
  "member": "string",
9920
10015
  "name": "StartReceiveTime",
@@ -9925,7 +10020,7 @@
9925
10020
  {
9926
10021
  "disabled": false,
9927
10022
  "document": "接收用户列表",
9928
- "example": "[{\"UinName\":\"zhangsan\",\"Uin\":\"100020880953\"}]",
10023
+ "example": "",
9929
10024
  "member": "ReceiveUin",
9930
10025
  "name": "ReceiveUin",
9931
10026
  "output_required": false,
@@ -10221,6 +10316,72 @@
10221
10316
  ],
10222
10317
  "usage": "out"
10223
10318
  },
10319
+ "RedisMetricTopProxiesData": {
10320
+ "document": "Redis DescribeMetricTopProxies 接口返回数据",
10321
+ "members": [
10322
+ {
10323
+ "disabled": false,
10324
+ "document": "host\n注意:此字段可能返回 null,表示取不到有效值。",
10325
+ "example": "30.86.245.14",
10326
+ "member": "string",
10327
+ "name": "Host",
10328
+ "output_required": true,
10329
+ "type": "string",
10330
+ "value_allowed_null": true
10331
+ },
10332
+ {
10333
+ "disabled": false,
10334
+ "document": "Proxy Id\n注意:此字段可能返回 null,表示取不到有效值。",
10335
+ "example": "149c8a81e5321ebab810a5da07c298c764311c43",
10336
+ "member": "string",
10337
+ "name": "InstanceProxyId",
10338
+ "output_required": true,
10339
+ "type": "string",
10340
+ "value_allowed_null": true
10341
+ },
10342
+ {
10343
+ "disabled": false,
10344
+ "document": "端口\n注意:此字段可能返回 null,表示取不到有效值。",
10345
+ "example": "8461",
10346
+ "member": "uint64",
10347
+ "name": "Port",
10348
+ "output_required": true,
10349
+ "type": "int",
10350
+ "value_allowed_null": true
10351
+ },
10352
+ {
10353
+ "disabled": false,
10354
+ "document": "最新的值\n注意:此字段可能返回 null,表示取不到有效值。",
10355
+ "example": "1.33",
10356
+ "member": "float",
10357
+ "name": "Value",
10358
+ "output_required": true,
10359
+ "type": "float",
10360
+ "value_allowed_null": true
10361
+ },
10362
+ {
10363
+ "disabled": false,
10364
+ "document": "时间(秒)\n注意:此字段可能返回 null,表示取不到有效值。",
10365
+ "example": "[1758183175]",
10366
+ "member": "uint64",
10367
+ "name": "Timestamp",
10368
+ "output_required": true,
10369
+ "type": "list",
10370
+ "value_allowed_null": true
10371
+ },
10372
+ {
10373
+ "disabled": false,
10374
+ "document": "序列数据\n注意:此字段可能返回 null,表示取不到有效值。",
10375
+ "example": "无",
10376
+ "member": "MonitorFloatMetric",
10377
+ "name": "Series",
10378
+ "output_required": true,
10379
+ "type": "list",
10380
+ "value_allowed_null": true
10381
+ }
10382
+ ],
10383
+ "usage": "out"
10384
+ },
10224
10385
  "RedisPreKeySpaceData": {
10225
10386
  "document": "redis key前缀空间信息",
10226
10387
  "members": [
@@ -11319,8 +11480,8 @@
11319
11480
  },
11320
11481
  {
11321
11482
  "disabled": false,
11322
- "document": "耗时占比。",
11323
- "example": "100",
11483
+ "document": "耗时占比。单位(%)",
11484
+ "example": "100.0",
11324
11485
  "member": "float",
11325
11486
  "name": "Ratio",
11326
11487
  "output_required": true,
@@ -11755,7 +11916,7 @@
11755
11916
  "members": [
11756
11917
  {
11757
11918
  "disabled": false,
11758
- "document": "模板id",
11919
+ "document": "模板id,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。",
11759
11920
  "example": "23002",
11760
11921
  "member": "string",
11761
11922
  "name": "TemplateId",
@@ -11764,7 +11925,7 @@
11764
11925
  },
11765
11926
  {
11766
11927
  "disabled": false,
11767
- "document": "模板名",
11928
+ "document": "模板名,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。",
11768
11929
  "example": "demoTemplate",
11769
11930
  "member": "string",
11770
11931
  "name": "TemplateName",
@@ -11861,7 +12022,7 @@
11861
12022
  "members": [
11862
12023
  {
11863
12024
  "disabled": false,
11864
- "document": "Agent标识。",
12025
+ "document": "Agent标识。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
11865
12026
  "example": "a6a7fccd-3cca-4310-b31e-2a60598d3414",
11866
12027
  "member": "string",
11867
12028
  "name": "AgentId",
@@ -11915,7 +12076,7 @@
11915
12076
  },
11916
12077
  {
11917
12078
  "disabled": false,
11918
- "document": "实例ID",
12079
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
11919
12080
  "example": "mysql-069yc1dda",
11920
12081
  "member": "string",
11921
12082
  "name": "InstanceId",
@@ -12007,7 +12168,7 @@
12007
12168
  "members": [
12008
12169
  {
12009
12170
  "disabled": false,
12010
- "document": "实例ID",
12171
+ "document": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。",
12011
12172
  "example": "cdb-c1nl9rpv",
12012
12173
  "member": "string",
12013
12174
  "name": "InstanceId",
@@ -12026,7 +12187,7 @@
12026
12187
  {
12027
12188
  "disabled": false,
12028
12189
  "document": "数据库账号密码。",
12029
- "example": "t123456",
12190
+ "example": "t121416",
12030
12191
  "member": "string",
12031
12192
  "name": "Password",
12032
12193
  "required": true,
@@ -12053,7 +12214,7 @@
12053
12214
  "example": "QCth",
12054
12215
  "member": "string",
12055
12216
  "name": "SessionToken",
12056
- "required": true,
12217
+ "output_required": true,
12057
12218
  "type": "string",
12058
12219
  "value_allowed_null": false
12059
12220
  },