cPanel API 2 Functions - MysqlOptimizer::fetch_slow_queries - Knowledgebase

Description

This function slow MySQL processes on the account.

Warning:

This function is currently not operational. You cannot successfully call this function.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=mysqloptimizer&cpanel_jsonapi_func=fetch_slow_queries

LiveAPI PHP Class

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Return slow MySQL queries on example.com.

my $get_slow_queries = $cpliveapi->api2(

'MysqlOptimizer', 'fetch_slow_queries',

);

LiveAPI Perl Module

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

Command Line

cpapi2 --user=username MysqlOptimizer fetch_slow_queries

Notes:

You must URI-encode values.
username represents your account-level username.

Output (JSON)

This function returns the contents of the /var/cpanel/sqloptimizer/user/.yaml file in JSON format.

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Parameter	Type	Description	Possible values	Example
db	string	The database name.	A valid database name.	example_database
recommendations	array	A list of CREATE INDEX SQL statements to optimize the table.	One or more CREATE INDEX statements.	CREATE INDEX VEGETABLE_GROUP ON DINNER_TBL (FOOD_NAME)
query	string	The slow query.	A MySQL query.	SELECT FOOD_NAME FROM DINNER_TBL
avgtime	integer	The time that they query required to complete, in seconds	A positive integer.	24
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories