API Documentation: mysql.total

Synopsis

Retrives mysql usage totals by each month. Totals are broken down into total select statements, update statements, other queries, bin logs, and cpu time for each day.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'mysql.total',
        'api_key' => '##API Public Key##',
        'timestamp' => time(),
        'cdn' => 158,
        'mysql' => 'mysql_username',
    );
        //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '##API Secret Key##', true));
    $request['signature'] = $sig;
    $json_request = json_encode($request);
    
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://api.scaleengine.net/stable/'); // Set the URL
    curl_setopt($ch, CURLOPT_POST, true); // Perform a POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser
    curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream
    curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return
    
    //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification
    //This is dangerous, and should only be done temporarily until a proper certificate bundle can be installed
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
    
    $response = curl_exec($ch); //Execute the API Call
    if (!$response) {
        die('Failed to connect to ScaleEngine API');
    }
    
    //Decode the response as an associative array 
    $arrResponse = json_decode($response, true); 
    if ($arrResponse) {
        //Operation completed successfully
        //TODO Add work here
        print_r($arrResponse);
    } else {
        //Operation failed
        echo 'An error occured processing your request:';
        print_r($response);
    }
        

Request Fields

command [REQUIRED] [string] - API command to execute
cdn_id [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed
mysql [REQUIRED] [int] - unique mysql user id.
[array] - array of mysql users.
[string] - mysql user name.

Example Result (JSON)

    {
    "data":[
        {
        "month" : "2017-01",
        "mysql_user" : "mysql_username",
        "select_total" : 100,
        "update_total" : 10,
        "other_total" : 100,
        "binlog_total" : 0,
        "cputime_total" : 0,
        },
    ]
    "message": "Found MySQL Data",
    "status": "success",
    "handle_time":"0.3795 seconds"
    }
    

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
data [array] - mysql usage totals per month.