Recent pages

Edit
page

New
page

Print
page
Page last modified 12:59, 27 Jul 2010 by igor.savchenko
0
Page Notifications Off
Scalr Documentation > API > API Reference > EventsList

EventsList

From $1

    Description

    This API returns events for specified farm.
     

    Changelog

    API version Changes
     2.0.0 Initial version

     

    Request Parameters

    Name Description Required
     FarmID Farm ID

    Example: 123    		 Yes
     StartFrom Start from specified event number (Can be used for paging)

    Example: 120    		 No
     RecordsLimit Limit number of returned events (Can be used for paging)

    Example: 20    		 No

     

    Response Elements

    Name Description
     TotalRecords Total events for specified farm
     StartFrom Started from this position
     RecordsLimit Records limit
     EventSet->ID Event ID
     EventSet->Type Event type
     EventSet->TimeStamp Timestamp
     EventSet->Message Event details (message)

     

    Sample Request

    https://api.scalr.net/?Action=EventsList
    &FarmID=126
    &Version=2.0.0
&StartFrom=120
&RecordsLimit=50
&KeyID=<Your Scalr API Key ID>
    &TimeStamp=2009-06-19T05%3A13%3A00.000Z
    &Signature=<URLEncode(Base64Encode(Signature))>

    Sample Response

    <?xml version="1.0"?>
<EventsListResponse>
    <TransactionID>dcb4faa2-c96a-4084-8846-a32e0e5592aa</TransactionID>   
    <TotalRecords>419</TotalRecords>
    <StartFrom>0</StartFrom>
    <RecordsLimit>20</RecordsLimit>
    <EventSet>
        <Item>
            <ID>5bc8ce7a-d0d0-4dd0-8374-e058d0d00e28</ID>
            <Type>FarmTerminated</Type>
            <Timestamp>1251459781</Timestamp>
            <Message>Farm terminated</Message>
        </Item>
        <Item>
            <ID>3293b179-ee09-477f-94f4-24c6a85d3879</ID>
            <Type>FarmLaunched</Type>
            <Timestamp>1251307448</Timestamp>
            <Message>Farm launched</Message>
        </Item>
    </EventSet>
</EventsListResponse>


     

    Tags: (Edit tags)
    • No tags
    Attach file or image
    Files (0)
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch Core