(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

# Connect to the Amazon AWS server.
# such as https://ec2.amazonaws.com/
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "ec2.us-west-2.amazonaws.com" $port $bTls $bAutoReconnect]

# Provide AWS credentials for the REST call.
set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
# the region should match the region part of the domain passed to the REST connect method (above).
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "ec2"

CkRest_SetAuthAws $rest $authAws

CkRest_AddQueryParam $rest "Action" "DescribeInstanceStatus"
CkRest_AddQueryParam $rest "Version" "2016-11-15"

CkRest_AddQueryParam $rest "InstanceId.1" "i-999719995399c9999"
# If you have additional instances to check, then add them with .2, .3, etc.
CkRest_AddQueryParam $rest "InstanceId.2" "i-999719995399c0000"
CkRest_AddQueryParam $rest "InstanceId.3" "i-999719995399c0111"
# ...

# Instead of checking specific instances, you can check all instances by 
# sending the IncludeAllInstances param
CkRest_AddQueryParam $rest "IncludeAllInstances" "true"

set responseXml [CkRest_fullRequestNoBody $rest "GET" "/"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: $responseXml"
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# Examine the successful XML response.
set xml [new_CkXml]

CkXml_LoadXml $xml $responseXml
puts [CkXml_getXml $xml]

# 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>

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkXml $xml