Contact description.
Used by actions: DescribeAllUserContact.
Name | Type | Description |
---|---|---|
Id | Integer | Contact ID. |
Name | String | Contact name. |
String | The email address of the contact. |
Instance diagnosis event
Used by actions: DescribeDBDiagHistory.
Name | Type | Description |
---|---|---|
DiagType | String | Diagnosis type. |
EndTime | Timestamp | End time. |
StartTime | Timestamp | Start time. |
EventId | Integer | Event ID. |
Severity | Integer | Severity, which can be divided into 5 levels: 1: fatal, 2: severe, 3: warning, 4: notice, 5: healthy. |
Outline | String | Summary. |
DiagItem | String | Diagnosis item. |
InstanceId | String | Instance ID. Note: this field may return null, indicating that no valid values can be obtained. |
Metric | String | Reserved field Note: this field may return null, indicating that no valid values can be obtained. |
Region | String | Region Note: this field may return null, indicating that no valid values can be obtained. |
Describe the group information.
Used by actions: DescribeAllUserGroup.
Name | Type | Description |
---|---|---|
Id | Integer | Group ID. |
Name | String | Group name. |
MemberCount | Integer | Number of group members. |
Instance configuration.
Used by actions: ModifyDiagDBInstanceConf.
Name | Type | Required | Description |
---|---|---|---|
DailyInspection | String | No | Whether to enable database inspection. Valid values: Yes/No. |
Email sending configuration.
Used by actions: CreateMailProfile.
Name | Type | Required | Description |
---|---|---|---|
SendMail | Integer | Yes | Whether to enable email sending. Valid values: 0 (No), 1 (Yes). |
Region | Array of String | Yes | Region configuration, such as "ap-guangzhou", "ap-shanghai". |
HealthStatus | Array of String | Yes | Sending a report with the specified health level, such as "HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK". |
ContactPerson | Array of Integer | No | Contact ID. Either ContactGroup or ContactID should be passed in. |
ContactGroup | Array of Integer | No | Contact group ID. Either ContactGroup or ContactID should be passed in. |
Monitoring data in float type
Used by actions: DescribeTopSpaceTableTimeSeries.
Name | Type | Description |
---|---|---|
Metric | String | Metric name. |
Unit | String | Metric unit. |
Values | Array of Float | Metric value. Note: this field may return null, indicating that no valid values can be obtained. |
Monitoring metric value in float type in a unit of time interval
Used by actions: DescribeTopSpaceTableTimeSeries.
Name | Type | Description |
---|---|---|
Series | Array of MonitorFloatMetric | Monitoring metric. |
Timestamp | Array of Integer | Timestamp corresponding to monitoring metric. |
Monitoring data
Used by actions: DescribeSlowLogTimeSeriesStats.
Name | Type | Description |
---|---|---|
Metric | String | Metric name. |
Unit | String | Metric unit. |
Values | Array of Integer | Metric value. Note: this field may return null, indicating that no valid values can be obtained. |
Monitoring metric data in specified time range
Used by actions: DescribeSlowLogTimeSeriesStats.
Name | Type | Description |
---|---|---|
Series | Array of MonitorMetric | Monitoring metric. |
Timestamp | Array of Integer | Timestamp corresponding to monitoring metric. |
Information configured by user.
Used by actions: CreateMailProfile.
Name | Type | Required | Description |
---|---|---|---|
Language | String | Yes | Language of the email, such as en . |
MailConfiguration | MailConfiguration | Yes | The content of email template. |
SchemaItem
array
Used by actions: DescribeSlowLogTopSqls.
Name | Type | Required | Description |
---|---|---|---|
Schema | String | Yes | Database name |
Top slow SQL statements
Used by actions: DescribeSlowLogTopSqls.
Name | Type | Description |
---|---|---|
LockTime | Float | Total SQL lock wait time |
LockTimeMax | Float | Maximum lock wait time |
LockTimeMin | Float | Minimum lock wait time |
RowsExamined | Integer | Total number of scanned rows |
RowsExaminedMax | Integer | Maximum number of scanned rows |
RowsExaminedMin | Integer | Minimum number of scanned rows |
QueryTime | Float | Total duration |
QueryTimeMax | Float | Maximum execution time |
QueryTimeMin | Float | Minimum execution time |
RowsSent | Integer | Total number of returned rows |
RowsSentMax | Integer | Maximum number of returned rows |
RowsSentMin | Integer | Minimum number of returned rows |
ExecTimes | Integer | Number of executions |
SqlTemplate | String | SQL template |
SqlText | String | SQL with parameter (random) |
Schema | String | Database name |
QueryTimeRatio | Float | Ratio of total duration |
LockTimeRatio | Float | Ratio of total SQL lock wait time |
RowsExaminedRatio | Float | Ratio of total number of scanned rows |
RowsSentRatio | Float | Ratio of total number of returned rows |
Database table space statistics.
Used by actions: DescribeTopSpaceTables.
Name | Type | Description |
---|---|---|
TableName | String | Table name. |
TableSchema | String | Database name. |
Engine | String | Database table storage engine. |
DataLength | Float | Data space in MB. |
IndexLength | Float | Index space in MB. |
DataFree | Float | Fragmented space in MB. |
TotalLength | Float | Total space usage in MB. |
FragRatio | Float | Fragmented rate (%). |
TableRows | Integer | Number of rows. |
PhysicalFileSize | Float | Size in MB of the physical file exclusive to a table. |
Time series of database table space data
Used by actions: DescribeTopSpaceTableTimeSeries.
Name | Type | Description |
---|---|---|
TableName | String | Table name. |
TableSchema | String | Database name. |
Engine | String | Database table storage engine. |
SeriesData | MonitorFloatMetricSeriesData | Monitoring metric data in a unit of time interval. |
Slow log statistics in specified time range
Used by actions: DescribeSlowLogTimeSeriesStats.
Name | Type | Description |
---|---|---|
Count | Integer | Total number |
Timestamp | Integer | Statistics start time |
Was this page helpful?