HP Cloud Service Automation For the Windows ® and Linux operating systems Software Version: 4.
Legal Notices Warranty The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Restricted Rights Legend Confidential computer software.
Documentation Updates The title page of this document contains the following identifying information: l Software Version number, which indicates the software version. l Document Release Date, which changes each time the document is updated. l Software Release Date, which indicates the release date of this version of the software. To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.
Support Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport This web site provides contact information and details about the products, services, and support that HP Software offers. HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your business.
Contents Contents 5 Introduction 5 What is HP Cloud Service Automation? 6 HP Cloud Service Automation API Documentation Overview 6 Consumption API Overview 6 Legacy API Overview 8 Deciding which API to use 8 HP Cloud Service Automation API calls 8 Consumption API 8 Legacy CSA 3.x API 9 Retrieving Information from HP CSA 4.
API Quick Start Contents 2. Have installed and set up HP Cloud Service Automation, following the instructions in theHP Cloud Service Automation Installation Guide and the HP Cloud Service Automation Configuration Guide. What is HP Cloud Service Automation? HP Cloud Service Automation (HP CSA) is a unique platform that orchestrates the deployment of compute and infrastructure resources and of complex multi-tier application architectures.
API Quick Start Contents The API calls found in this interactive content can also be exercised programmatically or through a REST client. Here's an example of content you'll see for a Consumption API call: You can click on any method listed to get detailed content for that call, and an interactive "Try it out!" feature.
API Quick Start Contents Legacy API Overview HP CSA continues to support the RESTful API introduced in the CSA 3.x releases. We'll refer to these calls as the Legacy CSA 3.x API or simply Legacy API. Though there is some overlap between the information available through this API and through the Consumption API, the Legacy API provides access to additional information not available through the Consumption API. The Legacy API calls are documented in the HP Cloud Service Automation API Reference Guide.
API Quick Start Contents API Description constraint View property constraints mpp-approval Manage approvals mpp-category View categories mpp-instance View service instance information mpp-notification View subscriptions and notifications mpp-offering View service offerings mpp-order Manage orders mpp-organization View organization information mpp-property View dynamic property's values mpp-request Manage service requests mpp-subscription Manage subscriptions mpp-user View user info
API Quick Start Contents API Description login Provide credentials for CSA RESTful API calls notification View and send notifications oganization, orgInformation View and modify organization information process instance View execution results from HP Operations Orchestration flows search Find specified information in CSA artifacts user View information related to CSA users utilization View resource utilization information for a subscription Retrieving Information from HP CSA 4.
API Quick Start Contents When exercising an API call from your application's code, you must create the Authorization header. Supply the Base64 encoded value of the : string for the user you will use for authentication. The following example shows how to compute the Authorization header for the Consumption API identity service default credentials. 1. The username:password string for a default identity service integration account is idmTransportUser:idmTransportUser. 2.
API Quick Start Contents Consumption API Consumption API calls require an IdM authentication token This token is then supplied to each API call in the X-Auth-Token parameter. An authentication token is retrieved from the Identity Management component using the following information: URL https://:idm-service/v2.
API Quick Start Contents "name" : "consumer", "roles" : [ { "id" : "100", "name" : "ROLE_USER" }, { "id": "101", "name": "object-store:admin", "tenantId": "t1000" } ] } } Executing RESTful calls CSA RESTful API calls can be exercised through an HTTP client as described in "Retrieving Information from HP CSA 4.00 using RESTful calls" on page 10, or programmatically from an application.
API Quick Start Contents Example configuration of REST Console plug-in: Configure the basic authorization in the Authorization tab using a username and password. See "Authentication with an integration account" on page 10 for more information. This user must have privileges to access CSA's RESTful APIs. Example REST Console authorization: If the plug-in is configured correctly, you will see output in the Response Body tab similar to the following when you issue a request.
API Quick Start Contents Exercising Consumption API calls using the interactive content In addition to being exercised programmatically or through an HTTP client, the Consumption API can be exercised through the “Try it out!” feature in the interactive API content. You will be prompted to login to the CSA Management Console to access this content. Basic authentication and authorization required to make RESTful calls will be configured as part of the login process.
API Quick Start Contents The content provides developers easy access to: l Each call's URI syntax l Whether there are any required or optional query parameters l The data type of each parameter l Model and schema information if applicable l Interactive "Try it out!" dialogs that let you submit calls to your server, see the results, and understand how you need to construct your REST URIs and any request body. Let's try out an API call. 1.
API Quick Start Contents 7. You should now see the request URL that was sent, as well as the response body, response code and response headers for your request as shown here. HP Cloud Service Automation (4.
API Quick Start Contents Not every API call will be this simple to exercise, but this example demonstrates how the interactive API content is presented, and how RESTful calls can easily be made from this interface. In some situations you will need to make other API calls first to get information necessary for parameters or a request body. Making API calls from an application RESTful calls can be made from your custom application code.
We appreciate your feedback! If you have comments about this document, you can contact the documentation team by email. If an email client is configured on this system, click the link above and an email window opens with the following information in the subject line: Feedback on Cloud Service Automation, 4.00 API Quick Start Just add your feedback to the email and click send.
