tencentcloud-sdk-nodejs-dbbrain 4.0.1054 → 4.1.1

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 (31) hide show
  1. package/README.md +18 -4
  2. package/es/index.js +1 -0
  3. package/es/services/dbbrain/index.js +6 -0
  4. package/es/services/dbbrain/v20191016/dbbrain_client.js +87 -0
  5. package/es/services/dbbrain/v20191016/dbbrain_models.js +0 -0
  6. package/es/services/dbbrain/v20191016/index.js +6 -0
  7. package/es/services/dbbrain/v20210527/dbbrain_client.js +219 -0
  8. package/es/services/dbbrain/v20210527/dbbrain_models.js +0 -0
  9. package/es/services/dbbrain/v20210527/index.js +6 -0
  10. package/es/services/index.js +1 -0
  11. package/package.json +16 -5
  12. package/tencentcloud/services/dbbrain/v20191016/dbbrain_client.js +2 -1
  13. package/tencentcloud/services/dbbrain/v20191016/dbbrain_models.d.ts +14 -32
  14. package/tencentcloud/services/dbbrain/v20191016/index.js +2 -1
  15. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +2 -1
  16. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +17 -70
  17. package/tencentcloud/services/dbbrain/v20210527/index.js +2 -1
  18. package/index.d.ts +0 -2
  19. package/index.js +0 -6
  20. package/prettier.config.js +0 -38
  21. package/src/index.ts +0 -1
  22. package/src/services/dbbrain/index.ts +0 -7
  23. package/src/services/dbbrain/v20191016/dbbrain_client.ts +0 -384
  24. package/src/services/dbbrain/v20191016/dbbrain_models.ts +0 -2108
  25. package/src/services/dbbrain/v20191016/index.ts +0 -6
  26. package/src/services/dbbrain/v20210527/dbbrain_client.ts +0 -946
  27. package/src/services/dbbrain/v20210527/dbbrain_models.ts +0 -5092
  28. package/src/services/dbbrain/v20210527/index.ts +0 -6
  29. package/src/services/index.ts +0 -1
  30. package/tsconfig.json +0 -33
  31. package/typings/index.d.ts +0 -2
@@ -1,2108 +0,0 @@
1
- /*
2
- * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing,
11
- * software distributed under the License is distributed on an
12
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
- * KIND, either express or implied. See the License for the
14
- * specific language governing permissions and limitations
15
- * under the License.
16
- */
17
-
18
- /**
19
- * 库空间时序数据
20
- */
21
- export interface SchemaSpaceTimeSeries {
22
- /**
23
- * 库名
24
- */
25
- TableSchema?: string
26
- /**
27
- * 单位时间间隔内的空间指标数据。
28
- */
29
- SeriesData?: MonitorMetricSeriesData
30
- }
31
-
32
- /**
33
- * 慢日志来源用户详情。
34
- */
35
- export interface SlowLogUser {
36
- /**
37
- * 来源用户名。
38
- */
39
- UserName?: string
40
- /**
41
- * 该来源用户名的慢日志数目占总数目的比例,单位%。
42
- */
43
- Ratio?: number
44
- /**
45
- * 该来源用户名的慢日志数目。
46
- */
47
- Count?: number
48
- }
49
-
50
- /**
51
- * DescribeSlowLogUserHostStats请求参数结构体
52
- */
53
- export interface DescribeSlowLogUserHostStatsRequest {
54
- /**
55
- * 实例ID。
56
- */
57
- InstanceId: string
58
- /**
59
- * 查询范围的开始时间,时间格式如:2019-09-10 12:13:14。
60
- */
61
- StartTime: string
62
- /**
63
- * 查询范围的结束时间,时间格式如:2019-09-10 12:13:14。
64
- */
65
- EndTime: string
66
- /**
67
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
68
- */
69
- Product?: string
70
- }
71
-
72
- /**
73
- * DescribeSlowLogTimeSeriesStats请求参数结构体
74
- */
75
- export interface DescribeSlowLogTimeSeriesStatsRequest {
76
- /**
77
- * 实例 ID 。
78
- */
79
- InstanceId: string
80
- /**
81
- * 开始时间,如“2019-09-10 12:13:14”。
82
- */
83
- StartTime: string
84
- /**
85
- * 结束时间,如“2019-09-10 12:13:14”,结束时间与开始时间的间隔最大可为7天。
86
- */
87
- EndTime: string
88
- /**
89
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
90
- */
91
- Product?: string
92
- }
93
-
94
- /**
95
- * DescribeTopSpaceSchemas返回参数结构体
96
- */
97
- export interface DescribeTopSpaceSchemasResponse {
98
- /**
99
- * 返回的Top库空间统计信息列表。
100
- */
101
- TopSpaceSchemas?: Array<SchemaSpaceData>
102
- /**
103
- * 采集库空间数据的时间戳(秒)。
104
- */
105
- Timestamp?: number
106
- /**
107
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
108
- */
109
- RequestId?: string
110
- }
111
-
112
- /**
113
- * 单位时间间隔内的慢日志统计
114
- */
115
- export interface TimeSlice {
116
- /**
117
- * 总数
118
- */
119
- Count?: number
120
- /**
121
- * 统计开始时间
122
- */
123
- Timestamp?: number
124
- }
125
-
126
- /**
127
- * 获取健康得分返回的详情。
128
- */
129
- export interface HealthScoreInfo {
130
- /**
131
- * 异常详情。
132
- */
133
- IssueTypes: Array<IssueTypeInfo>
134
- /**
135
- * 异常事件总数。
136
- */
137
- EventsTotalCount: number
138
- /**
139
- * 健康得分。
140
- */
141
- HealthScore: number
142
- /**
143
- * 健康等级, 如:"HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"。
144
- */
145
- HealthLevel: string
146
- }
147
-
148
- /**
149
- * DescribeTopSpaceTableTimeSeries返回参数结构体
150
- */
151
- export interface DescribeTopSpaceTableTimeSeriesResponse {
152
- /**
153
- * 返回的Top表空间统计信息的时序数据列表。
154
- */
155
- TopSpaceTableTimeSeries?: Array<TableSpaceTimeSeries>
156
- /**
157
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
158
- */
159
- RequestId?: string
160
- }
161
-
162
- /**
163
- * CreateSchedulerMailProfile请求参数结构体
164
- */
165
- export interface CreateSchedulerMailProfileRequest {
166
- /**
167
- * 取值范围1-7,分别代表周一至周日。
168
- */
169
- WeekConfiguration: Array<number | bigint>
170
- /**
171
- * 邮件配置内容。
172
- */
173
- ProfileInfo: ProfileInfo
174
- /**
175
- * 配置名称,需要保持唯一性,定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"schduler_cdb-test"。
176
- */
177
- ProfileName: string
178
- /**
179
- * 配置订阅的实例ID。
180
- */
181
- BindInstanceId: string
182
- /**
183
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
184
- */
185
- Product: string
186
- }
187
-
188
- /**
189
- * 联系人contact描述。
190
- */
191
- export interface ContactItem {
192
- /**
193
- * 联系人id。
194
- */
195
- Id?: number
196
- /**
197
- * 联系人姓名。
198
- */
199
- Name?: string
200
- /**
201
- * 联系人绑定的邮箱。
202
- */
203
- Mail?: string
204
- }
205
-
206
- /**
207
- * DescribeHealthScore返回参数结构体
208
- */
209
- export interface DescribeHealthScoreResponse {
210
- /**
211
- * 健康得分以及异常扣分项。
212
- */
213
- Data?: HealthScoreInfo
214
- /**
215
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
216
- */
217
- RequestId?: string
218
- }
219
-
220
- /**
221
- * DescribeDBDiagHistory返回参数结构体
222
- */
223
- export interface DescribeDBDiagHistoryResponse {
224
- /**
225
- * 事件描述。
226
- */
227
- Events?: Array<DiagHistoryEventItem>
228
- /**
229
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
230
- */
231
- RequestId?: string
232
- }
233
-
234
- /**
235
- * 诊断扣分项。
236
- */
237
- export interface ScoreItem {
238
- /**
239
- * 异常诊断项名称。
240
- */
241
- DiagItem: string
242
- /**
243
- * 诊断项分类,取值包括:可用性、可维护性、性能及可靠性。
244
- */
245
- IssueType: string
246
- /**
247
- * 健康等级,取值包括:信息、提示、告警、严重、致命。
248
- */
249
- TopSeverity: string
250
- /**
251
- * 该异常诊断项出现次数。
252
- */
253
- Count: number
254
- /**
255
- * 扣分分数。
256
- */
257
- ScoreLost: number
258
- }
259
-
260
- /**
261
- * DescribeDiagDBInstances请求参数结构体
262
- */
263
- export interface DescribeDiagDBInstancesRequest {
264
- /**
265
- * 是否是DBbrain支持的实例,固定传 true。
266
- */
267
- IsSupported: boolean
268
- /**
269
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
270
- */
271
- Product: string
272
- /**
273
- * 分页参数,偏移量。
274
- */
275
- Offset: number
276
- /**
277
- * 分页参数,分页值。
278
- */
279
- Limit: number
280
- /**
281
- * 根据实例名称条件查询。
282
- */
283
- InstanceNames?: Array<string>
284
- /**
285
- * 根据实例ID条件查询。
286
- */
287
- InstanceIds?: Array<string>
288
- /**
289
- * 根据地域条件查询。
290
- */
291
- Regions?: Array<string>
292
- }
293
-
294
- /**
295
- * DescribeDBSpaceStatus请求参数结构体
296
- */
297
- export interface DescribeDBSpaceStatusRequest {
298
- /**
299
- * 实例 ID 。
300
- */
301
- InstanceId: string
302
- /**
303
- * 时间段天数,截止日期为当日,默认为7天。
304
- */
305
- RangeDays?: number
306
- /**
307
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
308
- */
309
- Product?: string
310
- }
311
-
312
- /**
313
- * DescribeAllUserContact返回参数结构体
314
- */
315
- export interface DescribeAllUserContactResponse {
316
- /**
317
- * 联系人的总数量。
318
- */
319
- TotalCount?: number
320
- /**
321
- * 联系人的信息。
322
- */
323
- Contacts?: Array<ContactItem>
324
- /**
325
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
326
- */
327
- RequestId?: string
328
- }
329
-
330
- /**
331
- * DescribeUserSqlAdvice返回参数结构体
332
- */
333
- export interface DescribeUserSqlAdviceResponse {
334
- /**
335
- * SQL优化建议,可解析为JSON数组。
336
- */
337
- Advices?: string
338
- /**
339
- * SQL优化建议备注,可解析为String数组。
340
- */
341
- Comments?: string
342
- /**
343
- * SQL语句。
344
- */
345
- SqlText?: string
346
- /**
347
- * 库名。
348
- */
349
- Schema?: string
350
- /**
351
- * 相关表的DDL信息,可解析为JSON数组。
352
- */
353
- Tables?: string
354
- /**
355
- * SQL执行计划,可解析为JSON。
356
- */
357
- SqlPlan?: string
358
- /**
359
- * SQL优化后的成本节约详情,可解析为JSON。
360
- */
361
- Cost?: string
362
- /**
363
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
364
- */
365
- RequestId?: string
366
- }
367
-
368
- /**
369
- * DescribeTopSpaceSchemas请求参数结构体
370
- */
371
- export interface DescribeTopSpaceSchemasRequest {
372
- /**
373
- * 实例 ID 。
374
- */
375
- InstanceId: string
376
- /**
377
- * 返回的Top库数量,最大值为100,默认为20。
378
- */
379
- Limit?: number
380
- /**
381
- * 筛选Top库所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。
382
- */
383
- SortBy?: string
384
- /**
385
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
386
- */
387
- Product?: string
388
- }
389
-
390
- /**
391
- * ModifyDiagDBInstanceConf请求参数结构体
392
- */
393
- export interface ModifyDiagDBInstanceConfRequest {
394
- /**
395
- * 巡检开关。
396
- */
397
- InstanceConfs: InstanceConfs
398
- /**
399
- * 生效实例地域,取值为"All",代表全地域。
400
- */
401
- Regions: string
402
- /**
403
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL。
404
- */
405
- Product: string
406
- /**
407
- * 指定更改巡检状态的实例ID。
408
- */
409
- InstanceIds?: Array<string>
410
- }
411
-
412
- /**
413
- * 监控数据
414
- */
415
- export interface MonitorMetric {
416
- /**
417
- * 指标名称。
418
- */
419
- Metric?: string
420
- /**
421
- * 指标单位。
422
- */
423
- Unit?: string
424
- /**
425
- * 指标值。
426
- 注意:此字段可能返回 null,表示取不到有效值。
427
- */
428
- Values?: Array<number | bigint>
429
- }
430
-
431
- /**
432
- * CreateDBDiagReportTask请求参数结构体
433
- */
434
- export interface CreateDBDiagReportTaskRequest {
435
- /**
436
- * 实例ID。
437
- */
438
- InstanceId: string
439
- /**
440
- * 开始时间,如“2020-11-08T14:00:00+08:00”。
441
- */
442
- StartTime: string
443
- /**
444
- * 结束时间,如“2020-11-09T14:00:00+08:00”。
445
- */
446
- EndTime: string
447
- /**
448
- * 是否发送邮件: 0 - 否,1 - 是。
449
- */
450
- SendMailFlag: number
451
- /**
452
- * 接收邮件的联系人ID数组。
453
- */
454
- ContactPerson?: Array<number | bigint>
455
- /**
456
- * 接收邮件的联系组ID数组。
457
- */
458
- ContactGroup?: Array<number | bigint>
459
- /**
460
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认值为"mysql"。
461
- */
462
- Product?: string
463
- }
464
-
465
- /**
466
- * 监控数据(浮点型)
467
- */
468
- export interface MonitorFloatMetric {
469
- /**
470
- * 指标名称。
471
- */
472
- Metric?: string
473
- /**
474
- * 指标单位。
475
- */
476
- Unit?: string
477
- /**
478
- * 指标值。
479
- 注意:此字段可能返回 null,表示取不到有效值。
480
- */
481
- Values?: Array<number>
482
- }
483
-
484
- /**
485
- * DescribeSecurityAuditLogDownloadUrls请求参数结构体
486
- */
487
- export interface DescribeSecurityAuditLogDownloadUrlsRequest {
488
- /**
489
- * 安全审计组Id。
490
- */
491
- SecAuditGroupId: string
492
- /**
493
- * 异步任务Id。
494
- */
495
- AsyncRequestId: number
496
- /**
497
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL。
498
- */
499
- Product: string
500
- }
501
-
502
- /**
503
- * DescribeSecurityAuditLogExportTasks请求参数结构体
504
- */
505
- export interface DescribeSecurityAuditLogExportTasksRequest {
506
- /**
507
- * 安全审计组Id。
508
- */
509
- SecAuditGroupId: string
510
- /**
511
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL。
512
- */
513
- Product: string
514
- /**
515
- * 日志导出任务Id列表。
516
- */
517
- AsyncRequestIds?: Array<number | bigint>
518
- /**
519
- * 偏移量,默认0。
520
- */
521
- Offset?: number
522
- /**
523
- * 返回数量,默认20。
524
- */
525
- Limit?: number
526
- }
527
-
528
- /**
529
- * AddUserContact请求参数结构体
530
- */
531
- export interface AddUserContactRequest {
532
- /**
533
- * 联系人姓名,大小写字母+数字+下划线,最小 2 位最大 60 位的长度, 不能以"_"开头,且联系人名保持唯一。
534
- */
535
- Name: string
536
- /**
537
- * 邮箱地址,大小写字母、数字及下划线组成, 不能以"_"开头。
538
- */
539
- ContactInfo: string
540
- /**
541
- * 服务产品类型,固定值:"mysql"。
542
- */
543
- Product: string
544
- }
545
-
546
- /**
547
- * DescribeAllUserGroup返回参数结构体
548
- */
549
- export interface DescribeAllUserGroupResponse {
550
- /**
551
- * 组总数。
552
- */
553
- TotalCount?: number
554
- /**
555
- * 组信息。
556
- */
557
- Groups?: Array<GroupItem>
558
- /**
559
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
560
- */
561
- RequestId?: string
562
- }
563
-
564
- /**
565
- * 实例基础信息。
566
- */
567
- export interface InstanceBasicInfo {
568
- /**
569
- * 实例ID。
570
- */
571
- InstanceId?: string
572
- /**
573
- * 实例名称。
574
- */
575
- InstanceName?: string
576
- /**
577
- * 实例内网IP。
578
- */
579
- Vip?: string
580
- /**
581
- * 实例内网Port。
582
- */
583
- Vport?: number
584
- /**
585
- * 实例产品。
586
- */
587
- Product?: string
588
- /**
589
- * 实例引擎版本。
590
- */
591
- EngineVersion?: string
592
- }
593
-
594
- /**
595
- * SchemaItem数组
596
- */
597
- export interface SchemaItem {
598
- /**
599
- * 数据库名称
600
- */
601
- Schema: string
602
- }
603
-
604
- /**
605
- * CreateMailProfile返回参数结构体
606
- */
607
- export interface CreateMailProfileResponse {
608
- /**
609
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
610
- */
611
- RequestId?: string
612
- }
613
-
614
- /**
615
- * DescribeTopSpaceTables请求参数结构体
616
- */
617
- export interface DescribeTopSpaceTablesRequest {
618
- /**
619
- * 实例 ID 。
620
- */
621
- InstanceId: string
622
- /**
623
- * 返回的Top表数量,最大值为100,默认为20。
624
- */
625
- Limit?: number
626
- /**
627
- * 筛选Top表所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。
628
- */
629
- SortBy?: string
630
- /**
631
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
632
- */
633
- Product?: string
634
- }
635
-
636
- /**
637
- * 用户配置的信息
638
- */
639
- export interface ProfileInfo {
640
- /**
641
- * 语言, 如"zh"。
642
- */
643
- Language: string
644
- /**
645
- * 邮件模板的内容。
646
- */
647
- MailConfiguration: MailConfiguration
648
- }
649
-
650
- /**
651
- * DescribeAllUserContact请求参数结构体
652
- */
653
- export interface DescribeAllUserContactRequest {
654
- /**
655
- * 服务产品类型,固定值:mysql。
656
- */
657
- Product: string
658
- /**
659
- * 联系人名数组,支持模糊搜索。
660
- */
661
- Names?: Array<string>
662
- }
663
-
664
- /**
665
- * DescribeDBDiagEvent请求参数结构体
666
- */
667
- export interface DescribeDBDiagEventRequest {
668
- /**
669
- * 实例 ID 。
670
- */
671
- InstanceId: string
672
- /**
673
- * 事件 ID 。通过“获取实例诊断历史DescribeDBDiagHistory”获取。
674
- */
675
- EventId?: number
676
- /**
677
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
678
- */
679
- Product?: string
680
- }
681
-
682
- /**
683
- * CreateSecurityAuditLogExportTask请求参数结构体
684
- */
685
- export interface CreateSecurityAuditLogExportTaskRequest {
686
- /**
687
- * 安全审计组Id。
688
- */
689
- SecAuditGroupId: string
690
- /**
691
- * 导出日志开始时间,例如2020-12-28 00:00:00。
692
- */
693
- StartTime: string
694
- /**
695
- * 导出日志结束时间,例如2020-12-28 01:00:00。
696
- */
697
- EndTime: string
698
- /**
699
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL。
700
- */
701
- Product: string
702
- /**
703
- * 日志风险等级列表,支持值包括:0 无风险;1 低风险;2 中风险;3 高风险。
704
- */
705
- DangerLevels?: Array<number | bigint>
706
- }
707
-
708
- /**
709
- * DescribeDBSpaceStatus返回参数结构体
710
- */
711
- export interface DescribeDBSpaceStatusResponse {
712
- /**
713
- * 磁盘增长量(MB)。
714
- */
715
- Growth?: number
716
- /**
717
- * 磁盘剩余(MB)。
718
- */
719
- Remain?: number
720
- /**
721
- * 磁盘总量(MB)。
722
- */
723
- Total?: number
724
- /**
725
- * 预计可用天数。
726
- */
727
- AvailableDays?: number
728
- /**
729
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
730
- */
731
- RequestId?: string
732
- }
733
-
734
- /**
735
- * 实例诊断历史事件
736
- */
737
- export interface DiagHistoryEventItem {
738
- /**
739
- * 诊断类型。
740
- */
741
- DiagType?: string
742
- /**
743
- * 结束时间。
744
- */
745
- EndTime?: string
746
- /**
747
- * 开始时间。
748
- */
749
- StartTime?: string
750
- /**
751
- * 事件 ID 。
752
- */
753
- EventId?: number
754
- /**
755
- * 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
756
- */
757
- Severity?: number
758
- /**
759
- * 概要。
760
- */
761
- Outline?: string
762
- /**
763
- * 诊断项。
764
- */
765
- DiagItem?: string
766
- /**
767
- * 实例 ID 。
768
- 注意:此字段可能返回 null,表示取不到有效值。
769
- */
770
- InstanceId?: string
771
- /**
772
- * 保留字段
773
- 注意:此字段可能返回 null,表示取不到有效值。
774
- */
775
- Metric?: string
776
- /**
777
- * 地域
778
- 注意:此字段可能返回 null,表示取不到有效值。
779
- */
780
- Region?: string
781
- }
782
-
783
- /**
784
- * DescribeDBDiagEvent返回参数结构体
785
- */
786
- export interface DescribeDBDiagEventResponse {
787
- /**
788
- * 诊断项。
789
- */
790
- DiagItem?: string
791
- /**
792
- * 诊断类型。
793
- */
794
- DiagType?: string
795
- /**
796
- * 事件 ID 。
797
- */
798
- EventId?: number
799
- /**
800
- * 事件详情。
801
- */
802
- Explanation?: string
803
- /**
804
- * 概要。
805
- */
806
- Outline?: string
807
- /**
808
- * 诊断出的问题。
809
- */
810
- Problem?: string
811
- /**
812
- * 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
813
- */
814
- Severity?: number
815
- /**
816
- * 开始时间
817
- */
818
- StartTime?: string
819
- /**
820
- * 建议。
821
- */
822
- Suggestions?: string
823
- /**
824
- * 保留字段。
825
- */
826
- Metric?: string
827
- /**
828
- * 结束时间。
829
- */
830
- EndTime?: string
831
- /**
832
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
833
- */
834
- RequestId?: string
835
- }
836
-
837
- /**
838
- * DescribeDBDiagHistory请求参数结构体
839
- */
840
- export interface DescribeDBDiagHistoryRequest {
841
- /**
842
- * 实例 ID 。
843
- */
844
- InstanceId: string
845
- /**
846
- * 开始时间,如“2019-09-10 12:13:14”。
847
- */
848
- StartTime: string
849
- /**
850
- * 结束时间,如“2019-09-11 12:13:14”,结束时间与开始时间的间隔最大可为2天。
851
- */
852
- EndTime: string
853
- /**
854
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
855
- */
856
- Product?: string
857
- }
858
-
859
- /**
860
- * 库表空间时序数据
861
- */
862
- export interface TableSpaceTimeSeries {
863
- /**
864
- * 表名。
865
- */
866
- TableName?: string
867
- /**
868
- * 库名。
869
- */
870
- TableSchema?: string
871
- /**
872
- * 库表的存储引擎。
873
- */
874
- Engine?: string
875
- /**
876
- * 单位时间间隔内的空间指标数据。
877
- */
878
- SeriesData?: MonitorFloatMetricSeriesData
879
- }
880
-
881
- /**
882
- * 描述组信息。
883
- */
884
- export interface GroupItem {
885
- /**
886
- * 组id。
887
- */
888
- Id?: number
889
- /**
890
- * 组名称。
891
- */
892
- Name?: string
893
- /**
894
- * 组成员数量。
895
- */
896
- MemberCount?: number
897
- }
898
-
899
- /**
900
- * 查询实例列表,返回实例的相关信息的对象。
901
- */
902
- export interface InstanceInfo {
903
- /**
904
- * 实例ID。
905
- */
906
- InstanceId?: string
907
- /**
908
- * 实例名称。
909
- */
910
- InstanceName?: string
911
- /**
912
- * 实例所属地域。
913
- */
914
- Region?: string
915
- /**
916
- * 健康得分。
917
- */
918
- HealthScore?: number
919
- /**
920
- * 所属产品。
921
- */
922
- Product?: string
923
- /**
924
- * 异常事件数量。
925
- */
926
- EventCount?: number
927
- /**
928
- * 实例类型:1:MASTER;2:DR,3:RO,4:SDR。
929
- */
930
- InstanceType?: number
931
- /**
932
- * 核心数。
933
- */
934
- Cpu?: number
935
- /**
936
- * 内存,单位MB。
937
- */
938
- Memory?: number
939
- /**
940
- * 硬盘存储,单位GB。
941
- */
942
- Volume?: number
943
- /**
944
- * 数据库版本。
945
- */
946
- EngineVersion?: string
947
- /**
948
- * 内网地址。
949
- */
950
- Vip?: string
951
- /**
952
- * 内网端口。
953
- */
954
- Vport?: number
955
- /**
956
- * 接入来源。
957
- */
958
- Source?: string
959
- /**
960
- * 分组ID。
961
- */
962
- GroupId?: string
963
- /**
964
- * 分组组名。
965
- */
966
- GroupName?: string
967
- /**
968
- * 实例状态:0:发货中;1:运行正常;4:销毁中;5:隔离中。
969
- */
970
- Status?: number
971
- /**
972
- * 子网统一ID。
973
- */
974
- UniqSubnetId?: string
975
- /**
976
- * cdb类型。
977
- */
978
- DeployMode?: string
979
- /**
980
- * cdb实例初始化标志:0:未初始化;1:已初始化。
981
- */
982
- InitFlag?: number
983
- /**
984
- * 任务状态。
985
- */
986
- TaskStatus?: number
987
- /**
988
- * 私有网络统一ID。
989
- */
990
- UniqVpcId?: string
991
- /**
992
- * 实例巡检/概览的状态。
993
- */
994
- InstanceConf?: InstanceConfs
995
- /**
996
- * 资源到期时间。
997
- */
998
- DeadlineTime?: string
999
- /**
1000
- * 是否是DBbrain支持的实例。
1001
- */
1002
- IsSupported?: boolean
1003
- /**
1004
- * 实例安全审计日志开启状态:ON: 安全审计开启;OFF: 未开启安全审计。
1005
- */
1006
- SecAuditStatus?: string
1007
- /**
1008
- * 实例审计日志开启状态,ALL_AUDIT: 开启全审计;RULE_AUDIT: 开启规则审计;UNBOUND: 未开启审计。
1009
- */
1010
- AuditPolicyStatus?: string
1011
- /**
1012
- * 实例审计日志运行状态:normal: 运行中; paused: 欠费暂停。
1013
- */
1014
- AuditRunningStatus?: string
1015
- /**
1016
- * 内网vip。
1017
- */
1018
- InternalVip?: string
1019
- /**
1020
- * 内网port。
1021
- */
1022
- InternalVport?: number
1023
- /**
1024
- * 创建时间。
1025
- */
1026
- CreateTime?: string
1027
- /**
1028
- * 所属集群ID(仅对集群数据库产品该字段非空,如TDSQL-C)。
1029
- */
1030
- ClusterId?: string
1031
- /**
1032
- * 所属集群名称(仅对集群数据库产品该字段非空,如TDSQL-C)。
1033
- */
1034
- ClusterName?: string
1035
- }
1036
-
1037
- /**
1038
- * DescribeSlowLogUserHostStats返回参数结构体
1039
- */
1040
- export interface DescribeSlowLogUserHostStatsResponse {
1041
- /**
1042
- * 来源地址数目。
1043
- */
1044
- TotalCount?: number
1045
- /**
1046
- * 各来源地址的慢日志占比详情列表。
1047
- */
1048
- Items?: Array<SlowLogHost>
1049
- /**
1050
- * 各来源用户名的慢日志占比详情列表。
1051
- */
1052
- UserNameItems?: Array<SlowLogUser>
1053
- /**
1054
- * 来源用户数目。
1055
- */
1056
- UserTotalCount?: number
1057
- /**
1058
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1059
- */
1060
- RequestId?: string
1061
- }
1062
-
1063
- /**
1064
- * DescribeDBDiagReportTasks返回参数结构体
1065
- */
1066
- export interface DescribeDBDiagReportTasksResponse {
1067
- /**
1068
- * 任务总数目。
1069
- */
1070
- TotalCount?: number
1071
- /**
1072
- * 任务列表。
1073
- */
1074
- Tasks?: Array<HealthReportTask>
1075
- /**
1076
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1077
- */
1078
- RequestId?: string
1079
- }
1080
-
1081
- /**
1082
- * AddUserContact返回参数结构体
1083
- */
1084
- export interface AddUserContactResponse {
1085
- /**
1086
- * 添加成功的联系人id。
1087
- */
1088
- Id?: number
1089
- /**
1090
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1091
- */
1092
- RequestId?: string
1093
- }
1094
-
1095
- /**
1096
- * 健康报告任务详情。
1097
- */
1098
- export interface HealthReportTask {
1099
- /**
1100
- * 异步任务请求 ID。
1101
- */
1102
- AsyncRequestId: number
1103
- /**
1104
- * 任务的触发来源,支持的取值包括:"DAILY_INSPECTION" - 实例巡检;"SCHEDULED" - 定时生成;"MANUAL" - 手动触发。
1105
- */
1106
- Source: string
1107
- /**
1108
- * 任务完成进度,单位%。
1109
- */
1110
- Progress: number
1111
- /**
1112
- * 任务创建时间。
1113
- */
1114
- CreateTime: string
1115
- /**
1116
- * 任务开始执行时间。
1117
- */
1118
- StartTime: string
1119
- /**
1120
- * 任务完成执行时间。
1121
- */
1122
- EndTime: string
1123
- /**
1124
- * 任务所属实例的基础信息。
1125
- */
1126
- InstanceInfo: InstanceBasicInfo
1127
- /**
1128
- * 健康报告中的健康信息。
1129
- */
1130
- HealthStatus: HealthStatus
1131
- }
1132
-
1133
- /**
1134
- * DescribeDBDiagReportTasks请求参数结构体
1135
- */
1136
- export interface DescribeDBDiagReportTasksRequest {
1137
- /**
1138
- * 第一个任务的开始时间,用于范围查询,时间格式如:2019-09-10 12:13:14。
1139
- */
1140
- StartTime?: string
1141
- /**
1142
- * 最后一个任务的开始时间,用于范围查询,时间格式如:2019-09-10 12:13:14。
1143
- */
1144
- EndTime?: string
1145
- /**
1146
- * 实例ID数组,用于筛选指定实例的任务列表。
1147
- */
1148
- InstanceIds?: Array<string>
1149
- /**
1150
- * 任务的触发来源,支持的取值包括:"DAILY_INSPECTION" - 实例巡检;"SCHEDULED" - 定时生成;"MANUAL" - 手动触发。
1151
- */
1152
- Sources?: Array<string>
1153
- /**
1154
- * 报告的健康等级,支持的取值包括:"HEALTH" - 健康;"SUB_HEALTH" - 亚健康;"RISK" - 危险;"HIGH_RISK" - 高危。
1155
- */
1156
- HealthLevels?: string
1157
- /**
1158
- * 任务的状态,支持的取值包括:"created" - 新建;"chosen" - 待执行; "running" - 执行中;"failed" - 失败;"finished" - 已完成。
1159
- */
1160
- TaskStatuses?: string
1161
- /**
1162
- * 偏移量,默认0。
1163
- */
1164
- Offset?: number
1165
- /**
1166
- * 返回数量,默认20。
1167
- */
1168
- Limit?: number
1169
- /**
1170
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1171
- */
1172
- Product?: string
1173
- }
1174
-
1175
- /**
1176
- * CreateDBDiagReportTask返回参数结构体
1177
- */
1178
- export interface CreateDBDiagReportTaskResponse {
1179
- /**
1180
- * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
1181
- */
1182
- AsyncRequestId?: number
1183
- /**
1184
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1185
- */
1186
- RequestId?: string
1187
- }
1188
-
1189
- /**
1190
- * 单位时间间隔内的监控指标数据
1191
- */
1192
- export interface MonitorMetricSeriesData {
1193
- /**
1194
- * 监控指标。
1195
- */
1196
- Series?: Array<MonitorMetric>
1197
- /**
1198
- * 监控指标对应的时间戳。
1199
- */
1200
- Timestamp?: Array<number | bigint>
1201
- }
1202
-
1203
- /**
1204
- * ModifyDiagDBInstanceConf返回参数结构体
1205
- */
1206
- export interface ModifyDiagDBInstanceConfResponse {
1207
- /**
1208
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1209
- */
1210
- RequestId?: string
1211
- }
1212
-
1213
- /**
1214
- * CreateDBDiagReportUrl返回参数结构体
1215
- */
1216
- export interface CreateDBDiagReportUrlResponse {
1217
- /**
1218
- * 健康报告浏览地址。
1219
- */
1220
- ReportUrl?: string
1221
- /**
1222
- * 健康报告浏览地址到期时间戳(秒)。
1223
- */
1224
- ExpireTime?: number
1225
- /**
1226
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1227
- */
1228
- RequestId?: string
1229
- }
1230
-
1231
- /**
1232
- * 扣分详情。
1233
- */
1234
- export interface ScoreDetail {
1235
- /**
1236
- * 扣分项分类,取值包括:可用性、可维护性、性能及可靠性。
1237
- */
1238
- IssueType: string
1239
- /**
1240
- * 扣分总分。
1241
- */
1242
- ScoreLost: number
1243
- /**
1244
- * 扣分总分上限。
1245
- */
1246
- ScoreLostMax: number
1247
- /**
1248
- * 扣分项列表。
1249
- 注意:此字段可能返回 null,表示取不到有效值。
1250
- */
1251
- Items: Array<ScoreItem>
1252
- }
1253
-
1254
- /**
1255
- * DescribeTopSpaceSchemaTimeSeries返回参数结构体
1256
- */
1257
- export interface DescribeTopSpaceSchemaTimeSeriesResponse {
1258
- /**
1259
- * 返回的Top库空间统计信息的时序数据列表。
1260
- */
1261
- TopSpaceSchemaTimeSeries?: Array<SchemaSpaceTimeSeries>
1262
- /**
1263
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1264
- */
1265
- RequestId?: string
1266
- }
1267
-
1268
- /**
1269
- * DeleteSecurityAuditLogExportTasks请求参数结构体
1270
- */
1271
- export interface DeleteSecurityAuditLogExportTasksRequest {
1272
- /**
1273
- * 安全审计组Id。
1274
- */
1275
- SecAuditGroupId: string
1276
- /**
1277
- * 日志导出任务Id列表,接口会忽略不存在或已删除的任务Id。
1278
- */
1279
- AsyncRequestIds: Array<number | bigint>
1280
- /**
1281
- * 服务产品类型,支持值: "mysql" - 云数据库 MySQL。
1282
- */
1283
- Product: string
1284
- }
1285
-
1286
- /**
1287
- * CreateSchedulerMailProfile返回参数结构体
1288
- */
1289
- export interface CreateSchedulerMailProfileResponse {
1290
- /**
1291
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1292
- */
1293
- RequestId?: string
1294
- }
1295
-
1296
- /**
1297
- * 慢日志TopSql
1298
- */
1299
- export interface SlowLogTopSqlItem {
1300
- /**
1301
- * sql总锁等待时间
1302
- */
1303
- LockTime?: number
1304
- /**
1305
- * 最大锁等待时间
1306
- */
1307
- LockTimeMax?: number
1308
- /**
1309
- * 最小锁等待时间
1310
- */
1311
- LockTimeMin?: number
1312
- /**
1313
- * 总扫描行数
1314
- */
1315
- RowsExamined?: number
1316
- /**
1317
- * 最大扫描行数
1318
- */
1319
- RowsExaminedMax?: number
1320
- /**
1321
- * 最小扫描行数
1322
- */
1323
- RowsExaminedMin?: number
1324
- /**
1325
- * 总耗时
1326
- */
1327
- QueryTime?: number
1328
- /**
1329
- * 最大执行时间
1330
- */
1331
- QueryTimeMax?: number
1332
- /**
1333
- * 最小执行时间
1334
- */
1335
- QueryTimeMin?: number
1336
- /**
1337
- * 总返回行数
1338
- */
1339
- RowsSent?: number
1340
- /**
1341
- * 最大返回行数
1342
- */
1343
- RowsSentMax?: number
1344
- /**
1345
- * 最小返回行数
1346
- */
1347
- RowsSentMin?: number
1348
- /**
1349
- * 执行次数
1350
- */
1351
- ExecTimes?: number
1352
- /**
1353
- * sql模板
1354
- */
1355
- SqlTemplate?: string
1356
- /**
1357
- * 带参数SQL(随机)
1358
- */
1359
- SqlText?: string
1360
- /**
1361
- * 数据库名
1362
- */
1363
- Schema?: string
1364
- /**
1365
- * 总耗时占比
1366
- */
1367
- QueryTimeRatio?: number
1368
- /**
1369
- * sql总锁等待时间占比
1370
- */
1371
- LockTimeRatio?: number
1372
- /**
1373
- * 总扫描行数占比
1374
- */
1375
- RowsExaminedRatio?: number
1376
- /**
1377
- * 总返回行数占比
1378
- */
1379
- RowsSentRatio?: number
1380
- /**
1381
- * 平均执行时间
1382
- */
1383
- QueryTimeAvg?: number
1384
- /**
1385
- * 平均返回行数
1386
- */
1387
- RowsSentAvg?: number
1388
- /**
1389
- * 平均锁等待时间
1390
- */
1391
- LockTimeAvg?: number
1392
- /**
1393
- * 平均扫描行数
1394
- */
1395
- RowsExaminedAvg?: number
1396
- /**
1397
- * SQL模板的MD5值
1398
- */
1399
- Md5?: string
1400
- }
1401
-
1402
- /**
1403
- * 慢日志来源地址详情。
1404
- */
1405
- export interface SlowLogHost {
1406
- /**
1407
- * 来源地址。
1408
- */
1409
- UserHost: string
1410
- /**
1411
- * 该来源地址的慢日志数目占总数目的比例,单位%。
1412
- */
1413
- Ratio: number
1414
- /**
1415
- * 该来源地址的慢日志数目。
1416
- */
1417
- Count: number
1418
- }
1419
-
1420
- /**
1421
- * DescribeSlowLogTopSqls返回参数结构体
1422
- */
1423
- export interface DescribeSlowLogTopSqlsResponse {
1424
- /**
1425
- * 符合条件的记录总数。
1426
- */
1427
- TotalCount?: number
1428
- /**
1429
- * 慢日志 top sql 列表
1430
- */
1431
- Rows?: Array<SlowLogTopSqlItem>
1432
- /**
1433
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1434
- */
1435
- RequestId?: string
1436
- }
1437
-
1438
- /**
1439
- * 安全审计日志导出任务信息
1440
- */
1441
- export interface SecLogExportTaskInfo {
1442
- /**
1443
- * 异步任务Id。
1444
- */
1445
- AsyncRequestId: number
1446
- /**
1447
- * 任务开始时间。
1448
- 注意:此字段可能返回 null,表示取不到有效值。
1449
- */
1450
- StartTime: string
1451
- /**
1452
- * 任务结束时间。
1453
- 注意:此字段可能返回 null,表示取不到有效值。
1454
- */
1455
- EndTime: string
1456
- /**
1457
- * 任务创建时间。
1458
- */
1459
- CreateTime: string
1460
- /**
1461
- * 任务状态。
1462
- */
1463
- Status: string
1464
- /**
1465
- * 任务执行进度。
1466
- */
1467
- Progress: number
1468
- /**
1469
- * 导出日志开始时间。
1470
- 注意:此字段可能返回 null,表示取不到有效值。
1471
- */
1472
- LogStartTime: string
1473
- /**
1474
- * 导出日志结束时间。
1475
- 注意:此字段可能返回 null,表示取不到有效值。
1476
- */
1477
- LogEndTime: string
1478
- /**
1479
- * 日志文件总大小,单位KB。
1480
- 注意:此字段可能返回 null,表示取不到有效值。
1481
- */
1482
- TotalSize: number
1483
- /**
1484
- * 风险等级列表。0 无风险;1 低风险;2 中风险;3 高风险。
1485
- 注意:此字段可能返回 null,表示取不到有效值。
1486
- */
1487
- DangerLevels: Array<number | bigint>
1488
- }
1489
-
1490
- /**
1491
- * CreateMailProfile请求参数结构体
1492
- */
1493
- export interface CreateMailProfileRequest {
1494
- /**
1495
- * 邮件配置内容。
1496
- */
1497
- ProfileInfo: ProfileInfo
1498
- /**
1499
- * 配置级别,支持值包括:"User" - 用户级别,"Instance" - 实例级别,其中数据库巡检邮件配置为用户级别,定期生成邮件配置为实例级别。
1500
- */
1501
- ProfileLevel: string
1502
- /**
1503
- * 配置名称,需要保持唯一性,数据库巡检邮件配置名称自拟;定期生成邮件配置命名格式:"scheduler_" + {instanceId},如"schduler_cdb-test"。
1504
- */
1505
- ProfileName: string
1506
- /**
1507
- * 配置类型,支持值包括:"dbScan_mail_configuration" - 数据库巡检邮件配置,"scheduler_mail_configuration" - 定期生成邮件配置。
1508
- */
1509
- ProfileType: string
1510
- /**
1511
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL。
1512
- */
1513
- Product: string
1514
- /**
1515
- * 配置绑定的实例ID,当配置级别为"Instance"时需要传入且只能为一个实例;当配置级别为“User”时,此参数不填。
1516
- */
1517
- BindInstanceIds?: Array<string>
1518
- }
1519
-
1520
- /**
1521
- * DescribeTopSpaceSchemaTimeSeries请求参数结构体
1522
- */
1523
- export interface DescribeTopSpaceSchemaTimeSeriesRequest {
1524
- /**
1525
- * 实例ID。
1526
- */
1527
- InstanceId: string
1528
- /**
1529
- * 返回的Top库数量,最大值为100,默认为20。
1530
- */
1531
- Limit?: number
1532
- /**
1533
- * 筛选Top库所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize(仅云数据库 MySQL实例支持),云数据库 MySQL实例默认为 PhysicalFileSize,其他产品实例默认为TotalLength。
1534
- */
1535
- SortBy?: string
1536
- /**
1537
- * 开始日期,如“2021-01-01”,最早为当日的前第29天,默认为截止日期的前第6天。
1538
- */
1539
- StartDate?: string
1540
- /**
1541
- * 截止日期,如“2021-01-01”,最早为当日的前第29天,默认为当日。
1542
- */
1543
- EndDate?: string
1544
- /**
1545
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
1546
- */
1547
- Product?: string
1548
- }
1549
-
1550
- /**
1551
- * 单位时间间隔内的监控指标数据(浮点型)
1552
- */
1553
- export interface MonitorFloatMetricSeriesData {
1554
- /**
1555
- * 监控指标。
1556
- */
1557
- Series?: Array<MonitorFloatMetric>
1558
- /**
1559
- * 监控指标对应的时间戳。
1560
- */
1561
- Timestamp?: Array<number | bigint>
1562
- }
1563
-
1564
- /**
1565
- * 邮件发送配置
1566
- */
1567
- export interface MailConfiguration {
1568
- /**
1569
- * 是否开启邮件发送: 0, 否; 1, 是。
1570
- */
1571
- SendMail: number
1572
- /**
1573
- * 地域配置, 如["ap-guangzhou", "ap-shanghai"]。巡检的邮件发送模板,配置需要发送巡检邮件的地域;订阅的邮件发送模板,配置当前订阅实例的所属地域。
1574
- */
1575
- Region: Array<string>
1576
- /**
1577
- * 发送指定的健康等级的报告, 如["HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"]。
1578
- */
1579
- HealthStatus: Array<string>
1580
- /**
1581
- * 联系人id, 联系人/联系组不能都为空。
1582
- */
1583
- ContactPerson?: Array<number | bigint>
1584
- /**
1585
- * 联系组id, 联系人/联系组不能都为空。
1586
- */
1587
- ContactGroup?: Array<number | bigint>
1588
- }
1589
-
1590
- /**
1591
- * DescribeTopSpaceTableTimeSeries请求参数结构体
1592
- */
1593
- export interface DescribeTopSpaceTableTimeSeriesRequest {
1594
- /**
1595
- * 实例 ID 。
1596
- */
1597
- InstanceId: string
1598
- /**
1599
- * 返回的Top表数量,最大值为100,默认为20。
1600
- */
1601
- Limit?: number
1602
- /**
1603
- * 筛选Top表所用的排序字段,可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize,默认为 PhysicalFileSize。
1604
- */
1605
- SortBy?: string
1606
- /**
1607
- * 开始日期,如“2021-01-01”,最早为当日的前第29天,默认为截止日期的前第6天。
1608
- */
1609
- StartDate?: string
1610
- /**
1611
- * 截止日期,如“2021-01-01”,最早为当日的前第29天,默认为当日。
1612
- */
1613
- EndDate?: string
1614
- /**
1615
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
1616
- */
1617
- Product?: string
1618
- }
1619
-
1620
- /**
1621
- * DescribeSlowLogTopSqls请求参数结构体
1622
- */
1623
- export interface DescribeSlowLogTopSqlsRequest {
1624
- /**
1625
- * 实例 ID 。
1626
- */
1627
- InstanceId: string
1628
- /**
1629
- * 开始时间,如“2019-09-10 12:13:14”。
1630
- */
1631
- StartTime: string
1632
- /**
1633
- * 截止时间,如“2019-09-10 12:13:14”,截止时间与开始时间的间隔最大可为7天。
1634
- */
1635
- EndTime: string
1636
- /**
1637
- * 排序键,目前支持 QueryTime,ExecTimes,RowsSent,LockTime以及RowsExamined 等排序键。
1638
- */
1639
- SortBy?: string
1640
- /**
1641
- * 排序方式,支持ASC(升序)以及DESC(降序)。
1642
- */
1643
- OrderBy?: string
1644
- /**
1645
- * 返回数量,默认为20,最大值为100。
1646
- */
1647
- Limit?: number
1648
- /**
1649
- * 偏移量,默认为0。
1650
- */
1651
- Offset?: number
1652
- /**
1653
- * 数据库名称数组。
1654
- */
1655
- SchemaList?: Array<SchemaItem>
1656
- /**
1657
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
1658
- */
1659
- Product?: string
1660
- }
1661
-
1662
- /**
1663
- * DescribeMailProfile返回参数结构体
1664
- */
1665
- export interface DescribeMailProfileResponse {
1666
- /**
1667
- * 邮件配置详情。
1668
- 注意:此字段可能返回 null,表示取不到有效值。
1669
- */
1670
- ProfileList?: Array<UserProfile>
1671
- /**
1672
- * 邮件模板总数。
1673
- 注意:此字段可能返回 null,表示取不到有效值。
1674
- */
1675
- TotalCount?: number
1676
- /**
1677
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1678
- */
1679
- RequestId?: string
1680
- }
1681
-
1682
- /**
1683
- * 库表空间统计数据。
1684
- */
1685
- export interface TableSpaceData {
1686
- /**
1687
- * 表名。
1688
- */
1689
- TableName?: string
1690
- /**
1691
- * 库名。
1692
- */
1693
- TableSchema?: string
1694
- /**
1695
- * 库表的存储引擎。
1696
- */
1697
- Engine?: string
1698
- /**
1699
- * 数据空间(MB)。
1700
- */
1701
- DataLength?: number
1702
- /**
1703
- * 索引空间(MB)。
1704
- */
1705
- IndexLength?: number
1706
- /**
1707
- * 碎片空间(MB)。
1708
- */
1709
- DataFree?: number
1710
- /**
1711
- * 总使用空间(MB)。
1712
- */
1713
- TotalLength?: number
1714
- /**
1715
- * 碎片率(%)。
1716
- */
1717
- FragRatio?: number
1718
- /**
1719
- * 行数。
1720
- */
1721
- TableRows?: number
1722
- /**
1723
- * 表对应的独立物理文件大小(MB)。
1724
- */
1725
- PhysicalFileSize?: number
1726
- }
1727
-
1728
- /**
1729
- * DescribeSecurityAuditLogDownloadUrls返回参数结构体
1730
- */
1731
- export interface DescribeSecurityAuditLogDownloadUrlsResponse {
1732
- /**
1733
- * 导出结果的COS链接列表。当结果集很大时,可能会切分为多个url下载。
1734
- */
1735
- Urls?: Array<string>
1736
- /**
1737
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1738
- */
1739
- RequestId?: string
1740
- }
1741
-
1742
- /**
1743
- * 异常事件信息。
1744
- */
1745
- export interface EventInfo {
1746
- /**
1747
- * 事件 ID 。
1748
- */
1749
- EventId?: number
1750
- /**
1751
- * 诊断类型。
1752
- */
1753
- DiagType?: string
1754
- /**
1755
- * 开始时间。
1756
- */
1757
- StartTime?: string
1758
- /**
1759
- * 结束时间。
1760
- */
1761
- EndTime?: string
1762
- /**
1763
- * 概要。
1764
- */
1765
- Outline?: string
1766
- /**
1767
- * 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
1768
- */
1769
- Severity?: number
1770
- /**
1771
- * 扣分。
1772
- */
1773
- ScoreLost?: number
1774
- /**
1775
- * 保留字段。
1776
- */
1777
- Metric?: string
1778
- /**
1779
- * 告警数目。
1780
- */
1781
- Count?: number
1782
- }
1783
-
1784
- /**
1785
- * DescribeMailProfile请求参数结构体
1786
- */
1787
- export interface DescribeMailProfileRequest {
1788
- /**
1789
- * 配置类型,支持值包括:"dbScan_mail_configuration" - 数据库巡检邮件配置,"scheduler_mail_configuration" - 定期生成邮件配置。
1790
- */
1791
- ProfileType: string
1792
- /**
1793
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1794
- */
1795
- Product: string
1796
- /**
1797
- * 分页偏移量。
1798
- */
1799
- Offset: number
1800
- /**
1801
- * 分页单位,最大支持50。
1802
- */
1803
- Limit: number
1804
- /**
1805
- * 根据邮件配置名称查询,定期发送的邮件配置名称遵循:"scheduler_"+{instanceId}的规则。
1806
- */
1807
- ProfileName?: string
1808
- }
1809
-
1810
- /**
1811
- * DescribeHealthScore请求参数结构体
1812
- */
1813
- export interface DescribeHealthScoreRequest {
1814
- /**
1815
- * 需要获取健康得分的实例ID。
1816
- */
1817
- InstanceId: string
1818
- /**
1819
- * 获取健康得分的时间。
1820
- */
1821
- Time: string
1822
- /**
1823
- * 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1824
- */
1825
- Product: string
1826
- }
1827
-
1828
- /**
1829
- * DeleteSecurityAuditLogExportTasks返回参数结构体
1830
- */
1831
- export interface DeleteSecurityAuditLogExportTasksResponse {
1832
- /**
1833
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1834
- */
1835
- RequestId?: string
1836
- }
1837
-
1838
- /**
1839
- * 指标信息。
1840
- */
1841
- export interface IssueTypeInfo {
1842
- /**
1843
- * 指标分类:AVAILABILITY:可用性,MAINTAINABILITY:可维护性,PERFORMANCE,性能,RELIABILITY可靠性。
1844
- */
1845
- IssueType: string
1846
- /**
1847
- * 异常事件。
1848
- */
1849
- Events: Array<EventInfo>
1850
- /**
1851
- * 异常事件总数。
1852
- */
1853
- TotalCount: number
1854
- }
1855
-
1856
- /**
1857
- * 实例配置。
1858
- */
1859
- export interface InstanceConfs {
1860
- /**
1861
- * 数据库巡检开关, Yes/No。
1862
- */
1863
- DailyInspection?: string
1864
- /**
1865
- * 实例概览开关,Yes/No。
1866
- */
1867
- OverviewDisplay?: string
1868
- /**
1869
- * redis大key分析的自定义分割符,仅redis使用
1870
- 注意:此字段可能返回 null,表示取不到有效值。
1871
- */
1872
- KeyDelimiters?: Array<string>
1873
- }
1874
-
1875
- /**
1876
- * DescribeDiagDBInstances返回参数结构体
1877
- */
1878
- export interface DescribeDiagDBInstancesResponse {
1879
- /**
1880
- * 实例总数。
1881
- */
1882
- TotalCount?: number
1883
- /**
1884
- * 全实例巡检状态:0:开启全实例巡检;1:未开启全实例巡检。
1885
- */
1886
- DbScanStatus?: number
1887
- /**
1888
- * 实例相关信息。
1889
- */
1890
- Items?: Array<InstanceInfo>
1891
- /**
1892
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1893
- */
1894
- RequestId?: string
1895
- }
1896
-
1897
- /**
1898
- * 实例健康详情。
1899
- */
1900
- export interface HealthStatus {
1901
- /**
1902
- * 健康分数,满分100。
1903
- */
1904
- HealthScore?: number
1905
- /**
1906
- * 健康等级,取值包括:"HEALTH" - 健康;"SUB_HEALTH" - 亚健康;"RISK"- 危险;"HIGH_RISK" - 高危。
1907
- */
1908
- HealthLevel?: string
1909
- /**
1910
- * 总扣分分数。
1911
- */
1912
- ScoreLost?: number
1913
- /**
1914
- * 扣分详情。
1915
- */
1916
- ScoreDetails?: Array<ScoreDetail>
1917
- }
1918
-
1919
- /**
1920
- * DescribeUserSqlAdvice请求参数结构体
1921
- */
1922
- export interface DescribeUserSqlAdviceRequest {
1923
- /**
1924
- * 实例ID。
1925
- */
1926
- InstanceId: string
1927
- /**
1928
- * SQL语句。
1929
- */
1930
- SqlText: string
1931
- /**
1932
- * 库名。
1933
- */
1934
- Schema?: string
1935
- }
1936
-
1937
- /**
1938
- * DescribeAllUserGroup请求参数结构体
1939
- */
1940
- export interface DescribeAllUserGroupRequest {
1941
- /**
1942
- * 服务产品类型,固定值:mysql。
1943
- */
1944
- Product: string
1945
- /**
1946
- * 联系组名称数组,支持模糊搜索。
1947
- */
1948
- Names?: Array<string>
1949
- }
1950
-
1951
- /**
1952
- * CreateDBDiagReportUrl请求参数结构体
1953
- */
1954
- export interface CreateDBDiagReportUrlRequest {
1955
- /**
1956
- * 实例ID。
1957
- */
1958
- InstanceId: string
1959
- /**
1960
- * 健康报告相应的任务ID,可通过DescribeDBDiagReportTasks查询。
1961
- */
1962
- AsyncRequestId: number
1963
- /**
1964
- * 服务产品类型,支持值:"mysql" - 云数据库 MySQL;"cynosdb" - 云数据库 TDSQL-C for MySQL,默认为"mysql"。
1965
- */
1966
- Product?: string
1967
- }
1968
-
1969
- /**
1970
- * DescribeSlowLogTimeSeriesStats返回参数结构体
1971
- */
1972
- export interface DescribeSlowLogTimeSeriesStatsResponse {
1973
- /**
1974
- * 柱间单位时间间隔,单位为秒。
1975
- */
1976
- Period?: number
1977
- /**
1978
- * 单位时间间隔内慢日志数量统计。
1979
- */
1980
- TimeSeries?: Array<TimeSlice>
1981
- /**
1982
- * 单位时间间隔内的实例 cpu 利用率监控数据。
1983
- */
1984
- SeriesData?: MonitorMetricSeriesData
1985
- /**
1986
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1987
- */
1988
- RequestId?: string
1989
- }
1990
-
1991
- /**
1992
- * DescribeSecurityAuditLogExportTasks返回参数结构体
1993
- */
1994
- export interface DescribeSecurityAuditLogExportTasksResponse {
1995
- /**
1996
- * 安全审计日志导出任务列表。
1997
- */
1998
- Tasks?: Array<SecLogExportTaskInfo>
1999
- /**
2000
- * 安全审计日志导出任务总数。
2001
- */
2002
- TotalCount?: number
2003
- /**
2004
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2005
- */
2006
- RequestId?: string
2007
- }
2008
-
2009
- /**
2010
- * CreateSecurityAuditLogExportTask返回参数结构体
2011
- */
2012
- export interface CreateSecurityAuditLogExportTaskResponse {
2013
- /**
2014
- * 日志导出任务Id。
2015
- */
2016
- AsyncRequestId?: number
2017
- /**
2018
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2019
- */
2020
- RequestId?: string
2021
- }
2022
-
2023
- /**
2024
- * 用户配置的相关信息,包括邮件配置。
2025
- */
2026
- export interface UserProfile {
2027
- /**
2028
- * 配置的id。
2029
- 注意:此字段可能返回 null,表示取不到有效值。
2030
- */
2031
- ProfileId?: string
2032
- /**
2033
- * 配置类型。
2034
- 注意:此字段可能返回 null,表示取不到有效值。
2035
- */
2036
- ProfileType?: string
2037
- /**
2038
- * 配置级别,"User"或"Instance"。
2039
- 注意:此字段可能返回 null,表示取不到有效值。
2040
- */
2041
- ProfileLevel?: string
2042
- /**
2043
- * 配置名称。
2044
- 注意:此字段可能返回 null,表示取不到有效值。
2045
- */
2046
- ProfileName?: string
2047
- /**
2048
- * 配置详情。
2049
- */
2050
- ProfileInfo?: ProfileInfo
2051
- }
2052
-
2053
- /**
2054
- * 库空间统计数据。
2055
- */
2056
- export interface SchemaSpaceData {
2057
- /**
2058
- * 库名。
2059
- */
2060
- TableSchema?: string
2061
- /**
2062
- * 数据空间(MB)。
2063
- */
2064
- DataLength?: number
2065
- /**
2066
- * 索引空间(MB)。
2067
- */
2068
- IndexLength?: number
2069
- /**
2070
- * 碎片空间(MB)。
2071
- */
2072
- DataFree?: number
2073
- /**
2074
- * 总使用空间(MB)。
2075
- */
2076
- TotalLength?: number
2077
- /**
2078
- * 碎片率(%)。
2079
- */
2080
- FragRatio?: number
2081
- /**
2082
- * 行数。
2083
- */
2084
- TableRows?: number
2085
- /**
2086
- * 库中所有表对应的独立物理文件大小加和(MB)。
2087
- 注意:此字段可能返回 null,表示取不到有效值。
2088
- */
2089
- PhysicalFileSize?: number
2090
- }
2091
-
2092
- /**
2093
- * DescribeTopSpaceTables返回参数结构体
2094
- */
2095
- export interface DescribeTopSpaceTablesResponse {
2096
- /**
2097
- * 返回的Top表空间统计信息列表。
2098
- */
2099
- TopSpaceTables?: Array<TableSpaceData>
2100
- /**
2101
- * 采集表空间数据的时间戳(秒)。
2102
- */
2103
- Timestamp?: number
2104
- /**
2105
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2106
- */
2107
- RequestId?: string
2108
- }