tencentcloud-sdk-nodejs 4.1.9 → 4.1.10

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