tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for DBbrain
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-11-19 21:55:41
    Download PDF

      ContactItem

      Contact description.

      Used by actions: DescribeAllUserContact.

      Name Type Description
      Id Integer Contact ID.
      Name String Contact name.
      Mail String The email address of the contact.

      DiagHistoryEventItem

      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.

      EventInfo

      Exception information

      Used by actions: DescribeHealthScore.

      Name Type Description
      EventId Integer Event ID
      DiagType String Diagnosis type
      StartTime Timestamp ISO8601 Start time
      EndTime Timestamp ISO8601 End time
      Outline String Summary
      Severity Integer Severity, which can be divided into 5 levels: 1: fatal, 2: severe, 3: warning, 4: notice, 5: healthy.
      ScoreLost Integer Deduction
      Metric String Reserved field
      Count Integer The number of alarms

      GroupItem

      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.

      HealthReportTask

      Details of health report tasks.

      Used by actions: DescribeDBDiagReportTasks.

      Name Type Description
      AsyncRequestId Integer Async task request ID.
      Source String Source that triggers the task. Valid values: DAILY_INSPECTION (instance inspection), SCHEDULED (timed generation), and MANUAL (manual trigger).
      Progress Integer Task progress in %.
      CreateTime Timestamp Task creation time.
      StartTime Timestamp Task start time.
      EndTime Timestamp Task end time.
      InstanceInfo InstanceBasicInfo Basic information about the instance to which the task belongs.
      HealthStatus HealthStatus Health information in a health report.

      HealthScoreInfo

      Obtain the details of the health score and deduction.

      Used by actions: DescribeHealthScore.

      Name Type Description
      IssueTypes Array of IssueTypeInfo Exception details
      EventsTotalCount Integer Total number of the exceptions
      HealthScore Integer Health score
      HealthLevel String Health level, such as "HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK".

      HealthStatus

      Instance health status.

      Used by actions: DescribeDBDiagReportTasks.

      Name Type Description
      HealthScore Integer Health score out of 100 points.
      HealthLevel String Health level. Valid values: HEALTH (healthy), SUB_HEALTH (suboptimal), RISK (risky), and HIGH_RISK (critical).
      ScoreLost Integer Total scores deducted.
      ScoreDetails Array of ScoreDetail Deduction details.
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      InstanceBasicInfo

      Basic information of instance.

      Used by actions: DescribeDBDiagReportTasks.

      Name Type Description
      InstanceId String Instance ID.
      InstanceName String Instance name.
      Vip String Private IP of the instance.
      Vport Integer Private network port of the instance.
      Product String Instance product.
      EngineVersion String Instance engine version.

      InstanceConfs

      Instance configuration.

      Used by actions: DescribeDiagDBInstances, ModifyDiagDBInstanceConf.

      Name Type Required Description
      DailyInspection String No Whether to enable database inspection. Valid values: Yes/No.
      OverviewDisplay String No Whether to enable instance overview. Valid values: Yes/No.

      InstanceInfo

      Query the list of instances and return information about the instances.

      Used by actions: DescribeDiagDBInstances.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      Region String The region where the instance belongs
      HealthScore Integer Health score
      Product String Service
      EventCount Integer Number of exceptions
      InstanceType Integer Instance type. Valid values: 1: MASTER, 2: DR, 3: RO, 4: SDR
      Cpu Integer Number of cores
      Memory Integer Memory in MB
      Volume Integer Disk storage in GB
      EngineVersion String Database version
      Vip String Private network address
      Vport Integer Private network port
      Source String Access source
      GroupId String Group ID
      GroupName String Group name
      Status Integer Instance status. Valid values: 0: Delivering, 1: Running, 4: Terminating, 5: Isolated
      UniqSubnetId String Subnet unified ID
      DeployMode String cdb (TencentDB instance) type
      InitFlag Integer cdb (TencentDB instance) initialization flag. Valid values: 0: not initialized, 1: initialized
      TaskStatus Integer Task status
      UniqVpcId String Unified VPC ID
      InstanceConf InstanceConfs Instance inspection/overview status
      DeadlineTime Timestamp Resource expiration time
      IsSupported Boolean Whether it is an instance supported by DBbrain.
      SecAuditStatus String The status of instance security audit log. ON: enabled, OFF: disabled.
      AuditPolicyStatus String The status of instance audit log. ALL_AUDIT: full audit is enabled, RULE_AUDIT: rule audit is enabled, UNBOUND: audit is disabled.
      AuditRunningStatus String The running status of instance audit log. normal: running, paused: suspension due to arrears

      IssueTypeInfo

      Metric information

      Used by actions: DescribeHealthScore.

      Name Type Description
      IssueType String Metric categories: AVAILABILITY, MAINTAINABILITY, PERFORMANCE, and RELIABILITY
      Events Array of EventInfo Exception
      TotalCount Integer Total number of the exceptions

      MailConfiguration

      Email sending configuration.

      Used by actions: CreateMailProfile, CreateSchedulerMailProfile.

      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". For the inspection email sending template, configure the region where you need to send the inspection email. For the subscription email sending template, configure the region to which the current subscribed instance belongs.
      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.

      MonitorFloatMetric

      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.

      MonitorFloatMetricSeriesData

      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.

      MonitorMetric

      Monitoring data

      Used by actions: DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries.

      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.

      MonitorMetricSeriesData

      Monitoring metric data in specified time range

      Used by actions: DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries.

      Name Type Description
      Series Array of MonitorMetric Monitoring metric.
      Timestamp Array of Integer Timestamp corresponding to monitoring metric.

      ProfileInfo

      Information configured by user.

      Used by actions: CreateMailProfile, CreateSchedulerMailProfile, DescribeMailProfile.

      Name Type Required Description
      Language String Yes Language of the email, such as en.
      MailConfiguration MailConfiguration Yes The content of email template.

      SchemaItem

      SchemaItem array

      Used by actions: DescribeSlowLogTopSqls.

      Name Type Required Description
      Schema String Yes Database name

      SchemaSpaceData

      Database space statistics.

      Used by actions: DescribeTopSpaceSchemas.

      Name Type Description
      TableSchema String Database name.
      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 The total size of the independent physical files corresponding to all the database tables (MB).
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      SchemaSpaceTimeSeries

      Time series of database space data

      Used by actions: DescribeTopSpaceSchemaTimeSeries.

      Name Type Description
      TableSchema String Database name
      SeriesData MonitorMetricSeriesData Monitoring metric data in a unit of time interval.

      ScoreDetail

      Deduction details.

      Used by actions: DescribeDBDiagReportTasks.

      Name Type Description
      IssueType String Deduction item types. Valid values: availability, maintainability, performance, and reliability.
      ScoreLost Integer Total scores deducted.
      ScoreLostMax Integer Upper limit of the deducted scores.
      Items Array of ScoreItem Deduction item list.
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      ScoreItem

      Diagnosis deduction item.

      Used by actions: DescribeDBDiagReportTasks.

      Name Type Description
      DiagItem String Exception diagnosis item name.
      IssueType String Diagnosis item types. Valid values: availability, maintainability, performance, and reliability.
      TopSeverity String Health level. Valid values: information, reminder, alarm, serious, fatal.
      Count Integer Number of occurrences of this exception diagnosis item.
      ScoreLost Integer Scores deducted.

      SlowLogHost

      Details of slow log source addresses.

      Used by actions: DescribeSlowLogUserHostStats.

      Name Type Description
      UserHost String Source addresses.
      Ratio Float The proportion (in %) of slow logs from this source address to the total number of slow logs
      Count Integer Number of slow logs from this source address.

      SlowLogTopSqlItem

      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
      QueryTimeAvg Float Average execution time
      RowsSentAvg Float Average number of rows returned
      LockTimeAvg Float Average lock wait time
      RowsExaminedAvg Float Average number of rows scanned

      TableSpaceData

      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.

      TableSpaceTimeSeries

      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.

      TimeSlice

      Slow log statistics in specified time range

      Used by actions: DescribeSlowLogTimeSeriesStats.

      Name Type Description
      Count Integer Total number
      Timestamp Integer Statistics start time

      UserProfile

      Information configured by user, including email configuration.

      Used by actions: DescribeMailProfile.

      Name Type Description
      ProfileId String Configured ID
      Note: this field may return null, indicating that no valid values can be obtained.
      ProfileType String Configuration type
      Note: this field may return null, indicating that no valid values can be obtained.
      ProfileLevel String Configuration level. Valid values: “User” or “Instance”
      Note: this field may return null, indicating that no valid values can be obtained.
      ProfileName String Configuration name
      Note: this field may return null, indicating that no valid values can be obtained.
      ProfileInfo ProfileInfo Configuration details
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy