(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkXml.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Amazon AWS server.
    ; such as https://ec2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"ec2.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

    ; Provide AWS credentials for the REST call.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    ; the region should match the region part of the domain passed to the REST connect method (above).
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "ec2")

    CkRest::ckSetAuthAws(rest,authAws)

    CkRest::ckAddQueryParam(rest,"Action","DescribeInstanceStatus")
    CkRest::ckAddQueryParam(rest,"Version","2016-11-15")

    CkRest::ckAddQueryParam(rest,"InstanceId.1","i-999719995399c9999")
    ; If you have additional instances to check, then add them with .2, .3, etc.
    CkRest::ckAddQueryParam(rest,"InstanceId.2","i-999719995399c0000")
    CkRest::ckAddQueryParam(rest,"InstanceId.3","i-999719995399c0111")
    ; ...

    ; Instead of checking specific instances, you can check all instances by 
    ; sending the IncludeAllInstances param
    CkRest::ckAddQueryParam(rest,"IncludeAllInstances","true")

    responseXml.s = CkRest::ckFullRequestNoBody(rest,"GET","/")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + responseXml
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; Examine the successful XML response.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,responseXml)
    Debug CkXml::ckGetXml(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>


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure