Page History

...

Panel

title	Initialization REST Methods

Initialize Stores

Purpose: Allows the initialization of storage provider accounts
Request: POST https://host:port/durastore/storesinit^{Image Modified}

Request Body: XML similar to:

Code Block

	xml
	xml

<storageProviderAccounts>
  <storageAcct ownerId='0' isPrimary='true'>
    <id>1</id>
    <storageProviderType>AMAZON_S3</storageProviderType>
    <storageProviderCredential>
      <username>username</username>
      <password>password</password>
    </storageProviderCredential>
  </storageAcct>
</storageProviderAccounts>

Response Code: 200 (on success)
Response Body: "Initialization Successful" (on success)

Is Initialized

Purpose: Performs a check to determine if the DuraStore application has been initialized
Request: GET https://host:port/durastore/init^{Image Added}
Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
Response Body: Text indicating whether initialization has occurred.

Panel

title	Store REST Methods

Get Stores

Purpose: Provides a listing of available storage providers accounts (without credentials)
Request: GET https://host:port/durastore/stores
Parameters: None
Response Code: 200 (on success)

Response Body: XML similar to:

Code Block

	xml
	xml

<storageProviderAccounts>
  <storageAcct isPrimary='true'>
    <id>1</id>
    <storageProviderType>AMAZON_S3</storageProviderType>
  </storageAcct>
  <storageAcct isPrimary="false">
    <id>2</id>
    <storageProviderType>RACKSPACE</storageProviderType>
  </storageAcct>
</storageProviderAccounts>

...

Panel

title	Initialization REST Methods

Initialize Services

Purpose: Initializes the DuraService application
Request: POST https://host:port/duraservice/servicesinit^{Image Modified}

Request Body: XML similar to:

Code Block

	xml
	xml

 <servicesConfig>
   <primaryServiceInstance>
      <host>[PRIMARY-SERVICE-INSTANCE-HOST]</host>
      <servicesAdminPort>[PRIMARY-SERVICES-ADMIN-PORT]</servicesAdminPort>
      <servicesAdminContext>[PRIMARY-SERVICES-ADMIN-CONTEXT]</servicesAdminContext>
   </primaryServiceInstance>
   <userStorage>
     <host>[USER-STORAGE-HOST-NAME]</host>
     <port>[USER-STORAGE-PORT]</port>
     <context>[USER-STORAGE-CONTEXT]</context>
     <msgBrokerUrl>[USER-STORAGE-MSG-BROKER-URL]</msgBrokerUrl>
   </userStorage>
   <serviceStorage>
     <host>[SERVICES-STORAGE-HOST-NAME]</host>
     <port>[SERVICES-STORAGE-PORT]</port>
     <context>[SERVICES-STORAGE-CONTEXT]</context>
     <spaceId>[SERVICES-STORAGE-SPACE-ID]</spaceId>
   </serviceStorage>
   <serviceCompute>
     <type>AMAZON_EC2</type>
     <imageId>[MACHINE-IMAGE-ID]</imageId>
     <computeProviderCredential>
       <username>[USERNAME]</username>
       <password>[PASSWORD]</password>
     </computeProviderCredential>
   </serviceCompute>
 </servicesConfig>

Response Code: 200 (on success)
Response Body: "Initialization Successful" (on success)

Is Initialized

Purpose: Performs a check to determine if the DuraService application has been initialized
Request: GET https://host:port/duraservice/init^{Image Added}
Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
Response Body: Text indicating whether initialization has occurred.

Panel

title	Service REST Methods

Get Services

Purpose: Retrieves a listing of services, along with their configuration options
Request: GET https://host:port/duraservice/services ? (show)
- Parameter options for show (optional)
  1. available (default) - Includes only services which have not been deployed but are available for deployment
  2. deployed - Includes only services which have been deployed and started
Response Code: 200 (on success)
Response Body: XML list of services (see service config xsd)

Get Service

Purpose: Retrieves information about a particular service including description, configuration options, and all deployments
Request: GET https://host:port/duraservice/serviceID
Response Code: 200 (on success)
Response Body: XML service (see service config xsd)

Get Deployed Service

Purpose: Retrieves information about a deployed service including description, configuration options, and a single deployment indicating the configuration options in use
Request: GET https://host:port/duraservice/serviceID/deploymentID
Response Code: 200 (on success)
Response Body: XML service (see service config xsd)

Get Deployed Service Properties

Purpose: Retrieves the runtime properties of a deployed service
Request: GET https://host:port/duraservice/serviceID/deploymentID/properties
Response Code: 200 (on success)
Response Body: XML service (simple xml Map serialization)

Deploy Service

Purpose: Deploys and starts an available service
Request: PUT https://host:port/duraservice/serviceID ? (serviceHost)
- Parameter value for serviceHost (optional) should indicate the services host on which the service should be deployed. Default is the primary customer host.
Request Body: XML user configuration indicating the config selections for the service (see user config portion of service config xsd)
Response Code: 201 (on success)
Response Header: Location header indicates the URL at which information about the deployed service can be retrieved (the URL for a get deployed service call) which includes the deploymentID

Update Service Configuration

Purpose: Updates the configuration of a deployed service
Request: POST https://host:port/duraservice/serviceID/deploymentID
Request Body: Updated XML user configuration indicating the config selections for the service (see user config portion of service config xsd)
Response Code: 200 (on success)

UnDeploy Service

Purpose: Stops and Undeploys a deployed service
Request: DELETE https://host:port/duraservice/serviceID/deploymentID
Response Code: 200 (on success)

...

Panel

title	Initialization REST Methods

Initialize Application

Purpose: Allows the initialization of duradmin
Request: POST https://host:port/duradmin/init

Request Body: XML similar to:

Code Block

	xml
	xml

<duradminConfig>
  <durastoreHost>[host]</durastoreHost>
  <durastorePort>[port]</durastorePort>
  <durastoreContext>durastore</durastoreContext>
  <duraserviceHost>[host]</duraserviceHost>
  <duraservicePort>[port]</duraservicePort>
  <duraserviceContext>duraservice</duraserviceContext>
</duradminConfig>

Response Code: 200 (on success)
Response Body: "Initialization Successful" (on success)

DuraReport

Is Initialized

Purpose: Performs a check to determine if the DurAdmin application has been initialized
Request: GET https://host:port/duradmin/init^{Image Added}
Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
Response Body: Text indicating whether initialization has occurred.

DuraReport

Purpose: DuraReport generates reports relating to the status of your DuraCloud instance, and provides a simple interface for accessing those reports.

...

Panel

title	Initialization REST Methods

Initialize Application

Purpose: Allows the initialization of durareport
Request: POST https://host:port/durareport/reportsinit^{Image Modified}

Request Body: XML similar to:

Code Block

	xml
	xml

<durareportConfig>
  <durastoreHost>[host]</durastoreHost>
  <durastorePort>[port]</durastorePort>
  <durastoreContext>durastore</durastoreContext>
  <duraserviceHost>[host]</duraserviceHost>
  <duraservicePort>[port]</duraservicePort>
  <duraserviceContext>duraservice</duraserviceContext>
</durareportConfig>

Response Code: 200 (on success)
Response Body: "Initialization Successful" (on success)

Is Initialized

Purpose: Performs a check to determine if the DuraReport application has been initialized
Request: GET https://host:port/durareport/init^{Image Added}
Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
Response Body: Text indicating whether initialization has occurred.

Panel

title	Storage Report REST Methods

Get Latest Storage Report

Purpose: Provides the most current storage report in XML format
Request: GET https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: XML, defined by the storage report XSD

Get Storage Report List

Purpose: Provides a list of all storage report IDs
Request: GET https://host:port/durareport/storagereport/list
Response Code: 200 (on success)
Response Body: XML, defined by the storage report XSD

Get Storage Report

Purpose: Provides a specific storage report based on the provided report ID
Request: GET https://host:port/durareport/storagereport/reportID
Response Code: 200 (on success)
Response Body: XML, defined by the storage report XSD

Get Storage Report Info

Purpose: Provides a information about the current status of the storage reporting system
Request: GET https://host:port/durareport/storagereport/info
Response Code: 200 (on success)
Response Body: XML, defined by the storage report XSD

Start Storage Report

Purpose: Starts a storage report if one is not already running
Request: POST https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: "Report Started" (on success), or ""Report Already In Progress" (if a report is already in progress)

Cancel Storage Report

Purpose: Cancels a running storage report
Request: DELETE https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: "Storage report cancelled"

Schedule Storage Report

Purpose: Schedules a time for a storage report to be run
Request: POST https://host:port/durareport/storagereport/schedule ? (startTime) (frequency)
- startTime: time (in milliseconds since the epoch) to begin the next storage report
- frequency: time (in milliseconds) to wait between running reports (minimum value is 600000)
Response Code: 200 (on success)
Response Body: "Storage reports scheduled" (on success)

Cancel Storage Report Schedule

Purpose: Cancels all entries on the storage report schedule
Request: DELETE https://host:port/durareport/storagereport/schedule
Response Code: 200 (on success)
Response Body: "Storage Reports schedule cancelled"

...

Page tree

Versions Compared

Old Version 21

New Version 22

Key

Initialize Stores

Is Initialized

Get Stores

Initialize Services

Is Initialized

Get Services

Get Service

Get Deployed Service

Get Deployed Service Properties

Deploy Service

Update Service Configuration

UnDeploy Service

Initialize Application

DuraReport

Is Initialized

DuraReport

Initialize Application

Is Initialized

Get Latest Storage Report

Get Storage Report List

Get Storage Report

Get Storage Report Info

Start Storage Report

Cancel Storage Report

Schedule Storage Report

Cancel Storage Report Schedule