com.tencentcloudapi.dbbrain.v20191016

Class DbbrainClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.dbbrain.v20191016.DbbrainClient

public class DbbrainClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
DbbrainClient(Credential credential, String region)
DbbrainClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
AddUserContactResponse	AddUserContact(AddUserContactRequest req) This API is used to add the contact name and email..
CreateDBDiagReportTaskResponse	CreateDBDiagReportTask(CreateDBDiagReportTaskRequest req) This API is used to create a health report and send it via email as configured.
CreateDBDiagReportUrlResponse	CreateDBDiagReportUrl(CreateDBDiagReportUrlRequest req) This API is used to create a URL for a health report.
CreateMailProfileResponse	CreateMailProfile(CreateMailProfileRequest req) This API is used to create the email configuration.
CreateSchedulerMailProfileResponse	CreateSchedulerMailProfile(CreateSchedulerMailProfileRequest req) This API is used to create the regular generation time of the health reports and the regular email sending configuration.
DescribeAllUserContactResponse	DescribeAllUserContact(DescribeAllUserContactRequest req) This API is used to obtain the information of the contact in the email.
DescribeAllUserGroupResponse	DescribeAllUserGroup(DescribeAllUserGroupRequest req) This API is used to obtain the information of the contact group in the email.
DescribeDBDiagEventResponse	DescribeDBDiagEvent(DescribeDBDiagEventRequest req) This API is used to get the details of an instance exception diagnosis event.
DescribeDBDiagHistoryResponse	DescribeDBDiagHistory(DescribeDBDiagHistoryRequest req) This API is used to get the list of instance diagnosis events.
DescribeDBDiagReportTasksResponse	DescribeDBDiagReportTasks(DescribeDBDiagReportTasksRequest req) This API is used to query the list of health report generation tasks.
DescribeDBSpaceStatusResponse	DescribeDBSpaceStatus(DescribeDBSpaceStatusRequest req) This API is used to query the overview of instance space usage during a specified time period, including disk usage growth (MB), available disk space (MB), total disk space (MB), and estimated number of available days.
DescribeDiagDBInstancesResponse	DescribeDiagDBInstances(DescribeDiagDBInstancesRequest req) This API is used to obtain the instance information list.
DescribeHealthScoreResponse	DescribeHealthScore(DescribeHealthScoreRequest req) This API is used to obtain the health score and deduction for exceptions in the specified time period (30 minutes) based on the instance ID.
DescribeMailProfileResponse	DescribeMailProfile(DescribeMailProfileRequest req) This API is used to obtain the email sending configurations, including the email configuration for database inspection and the email sending configuration for regularly generated health reports.
DescribeSlowLogTimeSeriesStatsResponse	DescribeSlowLogTimeSeriesStats(DescribeSlowLogTimeSeriesStatsRequest req) This API is used to get the slow log statistics histogram.
DescribeSlowLogTopSqlsResponse	DescribeSlowLogTopSqls(DescribeSlowLogTopSqlsRequest req) This API is used to get and sort the top slow SQL statements in a specified time period by the aggregation mode of SQL template plus schema.
DescribeSlowLogUserHostStatsResponse	DescribeSlowLogUserHostStats(DescribeSlowLogUserHostStatsRequest req) This API is used to obtain the statistical distribution chart of slow log source addresses.
DescribeTopSpaceSchemasResponse	DescribeTopSpaceSchemas(DescribeTopSpaceSchemasRequest req) This API is used to query real-time space statistics of top databases.
DescribeTopSpaceSchemaTimeSeriesResponse	DescribeTopSpaceSchemaTimeSeries(DescribeTopSpaceSchemaTimeSeriesRequest req) This API is used to query the daily space data of top databases consuming the most instance space.
DescribeTopSpaceTablesResponse	DescribeTopSpaceTables(DescribeTopSpaceTablesRequest req) This API is used to query real-time space statistics of top tables of an instance.
DescribeTopSpaceTableTimeSeriesResponse	DescribeTopSpaceTableTimeSeries(DescribeTopSpaceTableTimeSeriesRequest req) This API is used to query the daily space data of top tables consuming the most instance space.
DescribeUserSqlAdviceResponse	DescribeUserSqlAdvice(DescribeUserSqlAdviceRequest req) This API is used to obtain SQL statement optimization suggestions.
ModifyDiagDBInstanceConfResponse	ModifyDiagDBInstanceConf(ModifyDiagDBInstanceConfRequest req) This API is used to enable/disable instance inspection.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbbrainClient

public DbbrainClient(Credential credential,
                     String region)

DbbrainClient

public DbbrainClient(Credential credential,
                     String region,
                     ClientProfile profile)

Method Detail

AddUserContact

public AddUserContactResponse AddUserContact(AddUserContactRequest req)
                                      throws TencentCloudSDKException

This API is used to add the contact name and email.. The return value is the successfully added contact ID. Select Guangzhou for Region.

Parameters:

req - AddUserContactRequest

Returns:

AddUserContactResponse

Throws:

TencentCloudSDKException

CreateDBDiagReportTask

public CreateDBDiagReportTaskResponse CreateDBDiagReportTask(CreateDBDiagReportTaskRequest req)
                                                      throws TencentCloudSDKException

This API is used to create a health report and send it via email as configured.

Parameters:

req - CreateDBDiagReportTaskRequest

Returns:

CreateDBDiagReportTaskResponse

Throws:

TencentCloudSDKException

CreateDBDiagReportUrl

public CreateDBDiagReportUrlResponse CreateDBDiagReportUrl(CreateDBDiagReportUrlRequest req)
                                                    throws TencentCloudSDKException

This API is used to create a URL for a health report.

Parameters:

req - CreateDBDiagReportUrlRequest

Returns:

CreateDBDiagReportUrlResponse

Throws:

TencentCloudSDKException

CreateMailProfile

public CreateMailProfileResponse CreateMailProfile(CreateMailProfileRequest req)
                                            throws TencentCloudSDKException

This API is used to create the email configuration. The input parameter `ProfileType` represents the type of the email configuration. Valid values: `dbScan_mail_configuration` (email configuration of database inspection report) and `scheduler_mail_configuration` (email sending configuration of regularly generated health report). Select Guangzhou for Region, regardless of the region where the instance belongs.

Parameters:

req - CreateMailProfileRequest

Returns:

CreateMailProfileResponse

Throws:

TencentCloudSDKException

CreateSchedulerMailProfile

public CreateSchedulerMailProfileResponse CreateSchedulerMailProfile(CreateSchedulerMailProfileRequest req)
                                                              throws TencentCloudSDKException

This API is used to create the regular generation time of the health reports and the regular email sending configuration. Pass in the regular generation time of the health reports as a parameter (Monday to Sunday) to set the regular generation time of the health reports, and save the corresponding regular email sending configuration.

Parameters:

req - CreateSchedulerMailProfileRequest

Returns:

CreateSchedulerMailProfileResponse

Throws:

TencentCloudSDKException

DescribeAllUserContact

public DescribeAllUserContactResponse DescribeAllUserContact(DescribeAllUserContactRequest req)
                                                      throws TencentCloudSDKException

This API is used to obtain the information of the contact in the email.

Parameters:

req - DescribeAllUserContactRequest

Returns:

DescribeAllUserContactResponse

Throws:

TencentCloudSDKException

DescribeAllUserGroup

public DescribeAllUserGroupResponse DescribeAllUserGroup(DescribeAllUserGroupRequest req)
                                                  throws TencentCloudSDKException

This API is used to obtain the information of the contact group in the email.

Parameters:

req - DescribeAllUserGroupRequest

Returns:

DescribeAllUserGroupResponse

Throws:

TencentCloudSDKException

DescribeDBDiagEvent

public DescribeDBDiagEventResponse DescribeDBDiagEvent(DescribeDBDiagEventRequest req)
                                                throws TencentCloudSDKException

This API is used to get the details of an instance exception diagnosis event.

Parameters:

req - DescribeDBDiagEventRequest

Returns:

DescribeDBDiagEventResponse

Throws:

TencentCloudSDKException

DescribeDBDiagHistory

public DescribeDBDiagHistoryResponse DescribeDBDiagHistory(DescribeDBDiagHistoryRequest req)
                                                    throws TencentCloudSDKException

This API is used to get the list of instance diagnosis events.

Parameters:

req - DescribeDBDiagHistoryRequest

Returns:

DescribeDBDiagHistoryResponse

Throws:

TencentCloudSDKException

DescribeDBDiagReportTasks

public DescribeDBDiagReportTasksResponse DescribeDBDiagReportTasks(DescribeDBDiagReportTasksRequest req)
                                                            throws TencentCloudSDKException

This API is used to query the list of health report generation tasks.

Parameters:

req - DescribeDBDiagReportTasksRequest

Returns:

DescribeDBDiagReportTasksResponse

Throws:

TencentCloudSDKException

DescribeDBSpaceStatus

public DescribeDBSpaceStatusResponse DescribeDBSpaceStatus(DescribeDBSpaceStatusRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the overview of instance space usage during a specified time period, including disk usage growth (MB), available disk space (MB), total disk space (MB), and estimated number of available days.

Parameters:

req - DescribeDBSpaceStatusRequest

Returns:

DescribeDBSpaceStatusResponse

Throws:

TencentCloudSDKException

DescribeDiagDBInstances

public DescribeDiagDBInstancesResponse DescribeDiagDBInstances(DescribeDiagDBInstancesRequest req)
                                                        throws TencentCloudSDKException

This API is used to obtain the instance information list. Select Guangzhou for Region.

Parameters:

req - DescribeDiagDBInstancesRequest

Returns:

DescribeDiagDBInstancesResponse

Throws:

TencentCloudSDKException

DescribeHealthScore

public DescribeHealthScoreResponse DescribeHealthScore(DescribeHealthScoreRequest req)
                                                throws TencentCloudSDKException

This API is used to obtain the health score and deduction for exceptions in the specified time period (30 minutes) based on the instance ID.

Parameters:

req - DescribeHealthScoreRequest

Returns:

DescribeHealthScoreResponse

Throws:

TencentCloudSDKException

DescribeMailProfile

public DescribeMailProfileResponse DescribeMailProfile(DescribeMailProfileRequest req)
                                                throws TencentCloudSDKException

This API is used to obtain the email sending configurations, including the email configuration for database inspection and the email sending configuration for regularly generated health reports. Select Guangzhou for Region.

Parameters:

req - DescribeMailProfileRequest

Returns:

DescribeMailProfileResponse

Throws:

TencentCloudSDKException

DescribeSlowLogTimeSeriesStats

public DescribeSlowLogTimeSeriesStatsResponse DescribeSlowLogTimeSeriesStats(DescribeSlowLogTimeSeriesStatsRequest req)
                                                                      throws TencentCloudSDKException

This API is used to get the slow log statistics histogram.

Parameters:

req - DescribeSlowLogTimeSeriesStatsRequest

Returns:

DescribeSlowLogTimeSeriesStatsResponse

Throws:

TencentCloudSDKException

DescribeSlowLogTopSqls

public DescribeSlowLogTopSqlsResponse DescribeSlowLogTopSqls(DescribeSlowLogTopSqlsRequest req)
                                                      throws TencentCloudSDKException

This API is used to get and sort the top slow SQL statements in a specified time period by the aggregation mode of SQL template plus schema.

Parameters:

req - DescribeSlowLogTopSqlsRequest

Returns:

DescribeSlowLogTopSqlsResponse

Throws:

TencentCloudSDKException

DescribeSlowLogUserHostStats

public DescribeSlowLogUserHostStatsResponse DescribeSlowLogUserHostStats(DescribeSlowLogUserHostStatsRequest req)
                                                                  throws TencentCloudSDKException

This API is used to obtain the statistical distribution chart of slow log source addresses.

Parameters:

req - DescribeSlowLogUserHostStatsRequest

Returns:

DescribeSlowLogUserHostStatsResponse

Throws:

TencentCloudSDKException

DescribeTopSpaceSchemaTimeSeries

public DescribeTopSpaceSchemaTimeSeriesResponse DescribeTopSpaceSchemaTimeSeries(DescribeTopSpaceSchemaTimeSeriesRequest req)
                                                                          throws TencentCloudSDKException

This API is used to query the daily space data of top databases consuming the most instance space. The data is daily collected by DBbrain during a specified time period. The return results are sorted by size by default.

Parameters:

req - DescribeTopSpaceSchemaTimeSeriesRequest

Returns:

DescribeTopSpaceSchemaTimeSeriesResponse

Throws:

TencentCloudSDKException

DescribeTopSpaceSchemas

public DescribeTopSpaceSchemasResponse DescribeTopSpaceSchemas(DescribeTopSpaceSchemasRequest req)
                                                        throws TencentCloudSDKException

This API is used to query real-time space statistics of top databases. The return results are sorted by size by default.

Parameters:

req - DescribeTopSpaceSchemasRequest

Returns:

DescribeTopSpaceSchemasResponse

Throws:

TencentCloudSDKException

DescribeTopSpaceTableTimeSeries

public DescribeTopSpaceTableTimeSeriesResponse DescribeTopSpaceTableTimeSeries(DescribeTopSpaceTableTimeSeriesRequest req)
                                                                        throws TencentCloudSDKException

This API is used to query the daily space data of top tables consuming the most instance space. The data is daily collected by DBbrain during a specified time period. The return results are sorted by size by default.

Parameters:

req - DescribeTopSpaceTableTimeSeriesRequest

Returns:

DescribeTopSpaceTableTimeSeriesResponse

Throws:

TencentCloudSDKException

DescribeTopSpaceTables

public DescribeTopSpaceTablesResponse DescribeTopSpaceTables(DescribeTopSpaceTablesRequest req)
                                                      throws TencentCloudSDKException

This API is used to query real-time space statistics of top tables of an instance. The return results are sorted by size by default.

Parameters:

req - DescribeTopSpaceTablesRequest

Returns:

DescribeTopSpaceTablesResponse

Throws:

TencentCloudSDKException

DescribeUserSqlAdvice

public DescribeUserSqlAdviceResponse DescribeUserSqlAdvice(DescribeUserSqlAdviceRequest req)
                                                    throws TencentCloudSDKException

This API is used to obtain SQL statement optimization suggestions.

Parameters:

req - DescribeUserSqlAdviceRequest

Returns:

DescribeUserSqlAdviceResponse

Throws:

TencentCloudSDKException

ModifyDiagDBInstanceConf

public ModifyDiagDBInstanceConfResponse ModifyDiagDBInstanceConf(ModifyDiagDBInstanceConfRequest req)
                                                          throws TencentCloudSDKException

This API is used to enable/disable instance inspection.

Parameters:

req - ModifyDiagDBInstanceConfRequest

Returns:

ModifyDiagDBInstanceConfResponse

Throws:

TencentCloudSDKException