Recent pages

Edit
page

New
page

Print
page
Page last modified 16:30, 18 Mar 2011 by igor.savchenko
0
Page Notifications Off
Scalr Documentation > API > API Reference > ScriptExecute

ScriptExecute

From $1

    Description

    This API allows you to execute script on specified instance/role/farm 

    Changelog

    API version Changes
     2.0.0 Initial version

    Request Parameters

    Name Description Required
     FarmRoleID Script will be executed on all instances with this farm role ID. You can get this ID by using GetFarmDetails API call.

    Example: 12345    		 No
     ServerID Script will be executed on this server

    Example: e3ff71a6-7cba-432e-97d0-8e398a01498f    		 No
     FarmID Execute script on specified farm

    Example: 123     		Yes
     ScriptID Script ID

    Example: 1     		Yes
     Timeout Script execution timeout (seconds).

    Example: 30     		Yes
     Async Excute script asynchronously (1) or synchronously (0).

    Example: 1     		Yes
     Revision Execute specified revision of script.

    Example: 7     		No
     ConfigVariables Script variables.
         		 No

    Response Elements

    Name Description
     Result Request Result

     

    Sample Request

    https://api.scalr.net/?Action=ScriptExecute
    &FarmID=126
    &ScriptID=100
    &Timeout=30
&Revision=3
&ConfigVariables[var1]=/home/www
&ConfigVariables[var2]=test
    &Async=1
    &Version=2.0.0
&AuthVersion=2
    &KeyID=<Your Scalr API Key ID>
    &TimeStamp=2009-06-19T05:13:00.000Z
    &Signature=<URLEncode(Base64Encode(Signature))>

    String to sign for sample request

    ActionScriptExecuteAsync1AuthVersion2ConfigVariables[var1]/home/wwwConfigVariables[var2]testFarmID126KeyID<Your Scalr API Key ID>Revision3ScriptID100Timeout30Timestamp2009-06-19T05:13:00.000ZVersion2.0.0

    Sample Response

    <?xml version="1.0"?>
<ExecuteScriptResponse>
    <TransactionID>2f2a99b2-1631-4733-aa4a-c43303483ac4</TransactionID>
    <Result>1</Result>
</ExecuteScriptResponse>


     

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

     
    Powered by MindTouch Core