(PHP Extension) EC2 Check Instance Status

See more Amazon EC2 Examples

Demonstrates how to send a request to check the status of Amazon EC2 instances.

For more information, see https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new CkRest();

// Connect to the Amazon AWS server.
// such as https://ec2.amazonaws.com/
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$success = $rest->Connect('ec2.us-west-2.amazonaws.com',$port,$bTls,$bAutoReconnect);

// Provide AWS credentials for the REST call.
$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');
// the region should match the region part of the domain passed to the REST connect method (above).
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('ec2');

$rest->SetAuthAws($authAws);

$rest->AddQueryParam('Action','DescribeInstanceStatus');
$rest->AddQueryParam('Version','2016-11-15');

$rest->AddQueryParam('InstanceId.1','i-999719995399c9999');
// If you have additional instances to check, then add them with .2, .3, etc.
$rest->AddQueryParam('InstanceId.2','i-999719995399c0000');
$rest->AddQueryParam('InstanceId.3','i-999719995399c0111');
// ...

// Instead of checking specific instances, you can check all instances by 
// sending the IncludeAllInstances param
$rest->AddQueryParam('IncludeAllInstances','true');

$responseXml = $rest->fullRequestNoBody('GET','/');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// A successful response will have a status code equal to 200.
if ($rest->get_ResponseStatusCode() != 200) {
    print 'response status code = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'response status text = ' . $rest->responseStatusText() . "\n";
    print 'response header: ' . $rest->responseHeader() . "\n";
    print 'response body: ' . $responseXml . "\n";
    exit;
}

// Examine the successful XML response.
$xml = new CkXml();
$xml->LoadXml($responseXml);
print $xml->getXml() . "\n";

// Here is a sample response:

// Use this online tool to generate parsing code from sample XML: 
// Generate Parsing Code from XML

// <DescribeInstanceStatusResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
//     <requestId>3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE</requestId>
//     <instanceStatusSet>
//         <item>
//             <instanceId>i-1234567890abcdef0</instanceId>
//             <availabilityZone>us-east-1d</availabilityZone>
//             <instanceState>
//                 <code>16</code>
//                 <name>running</name>
//             </instanceState>
//             <systemStatus>
//                 <status>impaired</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>failed</status>
//                         <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>
//                     </item>
//                 </details>
//             </systemStatus>
//             <instanceStatus>
//                 <status>impaired</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>failed</status>
//                         <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>
//                     </item>
//                 </details>
//             </instanceStatus>
//             <eventsSet>
//               <item>
//                 <code>instance-retirement</code>
//                 <description>The instance is running on degraded hardware</description>
//                 <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>
//                 <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>
//               </item>
//             </eventsSet>
//         </item>
//         <item>
//             <instanceId>i-0598c7d356eba48d7</instanceId>
//             <availabilityZone>us-east-1d</availabilityZone>
//             <instanceState>
//                 <code>16</code>
//                 <name>running</name>
//             </instanceState>
//             <systemStatus>
//                 <status>ok</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>passed</status>
//                     </item>
//                 </details>
//             </systemStatus>
//             <instanceStatus>
//                 <status>ok</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>passed</status>
//                     </item>
//                 </details>
//             </instanceStatus>
//             <eventsSet>
//               <item>
//                 <code>instance-reboot</code>
//                 <description>The instance is scheduled for a reboot</description>
//                 <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>
//                 <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>
//               </item>
//             </eventsSet>
//         </item>
//         <item>
//             <instanceId>i-0987654321abcdef0</instanceId>
//             <availabilityZone>us-east-1d</availabilityZone>
//             <instanceState>
//                 <code>16</code>
//                 <name>running</name>
//             </instanceState>
//             <systemStatus>
//                 <status>ok</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>passed</status>
//                     </item>
//                 </details>
//             </systemStatus>
//             <instanceStatus>
//                 <status>ok</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>passed</status>
//                     </item>
//                 </details>
//             </instanceStatus>
//         </item>
//         <item>
//             <instanceId>i-0598c7d356eba48d8</instanceId>
//             <availabilityZone>us-east-1d</availabilityZone>
//             <instanceState>
//                 <code>16</code>
//                 <name>running</name>
//             </instanceState>
//             <systemStatus>
//                 <status>ok</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>passed</status>
//                     </item>
//                 </details>
//             </systemStatus>
//             <instanceStatus>
//                 <status>insufficient-data</status>
//                 <details>
//                     <item>
//                         <name>reachability</name>
//                         <status>insufficient-data</status>
//                     </item>
//                 </details>
//             </instanceStatus>
//          </item>
//     </instanceStatusSet>
// </DescribeInstanceStatusResponse>

?>