Page History

...

Purpose: DuraService is the application through which DuraCloud manages services. The DuraService REST API provides the means by which services available in the DuraCloud service repository are deployed, configured, and undeployed.

Resources: XML schema which define the service configuration can be found here

Panel

title	Service REST Methods

Initialize Services

Purpose: Initializes the DuraService application
Request: POST https://host:port/duraservice/services

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)

Initialize Security Users

Purpose: Allows the initialization of authorized users
Request: POST https://host:port/duraservice/security

Request Body: XML similar to:

Code Block

	xml
	xml

<?xml version="1.0" encoding="UTF-8"?>
<dur:security-users schemaVersion="0.2" xmlns:dur="duracloud.org">
  <security-user>
    <username>username-0</username>
    <password>password-0</password>
    <enabled>true</enabled>
    <accountNonExpired>true</accountNonExpired>
    <credentialsNonExpired>true</credentialsNonExpired>
    <accountNonLocked>true</accountNonLocked>
    <grantedAuthorities>ROLE_USER</grantedAuthorities>
  </security-user>
  <security-user>
    <username>username-1</username>
    <password>password-1</password>
    <enabled>false</enabled>
    <accountNonExpired>false</accountNonExpired>
    <credentialsNonExpired>false</credentialsNonExpired>
    <accountNonLocked>false</accountNonLocked>
    <grantedAuthorities>ROLE_USER ROLE_ADMIN</grantedAuthorities>
  </security-user>
</dur:security-users>

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

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)

...

Page tree

Versions Compared

Old Version 1

New Version 2

Key