#Licensed to the Apache Software Foundation (ASF) under one #or more contributor license agreements. See the NOTICE file #distributed with this work for additional information #regarding copyright ownership. The ASF licenses this file #to you under the Apache License, Version 2.0 (the #"License"); you may not use this file except in compliance #with the License. You may obtain a copy of the License at #http://www.apache.org/licenses/LICENSE-2.0 #Unless required by applicable law or agreed to in writing, #software distributed under the License is distributed on an #"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY #KIND, either express or implied. See the License for the #specific language governing permissions and limitations #under the License. msgid "" msgstr "" "Project-Id-Version: 0\n" "POT-Creation-Date: 2013-02-02T20:11:58\n" "PO-Revision-Date: 2013-02-02T20:11:58\n" "Last-Translator: Automatically generated\n" "Language-Team: None\n" "MIME-Version: 1.0\n" "Content-Type: application/x-publican; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. Tag: title #, no-c-format msgid "Making API Requests" msgstr "" #. Tag: para #, no-c-format msgid "All &PRODUCT; API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:" msgstr "" #. Tag: para #, no-c-format msgid "&PRODUCT; API URL: This is the web services API entry point(for example, http://www.cloud.com:8080/client/api)" msgstr "" #. Tag: para #, no-c-format msgid "Command: The web services command you wish to execute, such as start a virtual machine or create a disk volume" msgstr "" #. Tag: para #, no-c-format msgid "Parameters: Any additional required or optional parameters for the command" msgstr "" #. Tag: para #, no-c-format msgid "A sample API GET request looks like the following:" msgstr "" #. Tag: programlisting #, no-c-format msgid "http://localhost:8080/client/api?command=deployVirtualMachine&serviceOfferingId=1&diskOfferingId=1&templateId=2&zoneId=4&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D\n" " " msgstr "" #. Tag: para #, no-c-format msgid "Or in a more readable format:" msgstr "" #. Tag: programlisting #, no-c-format msgid "\n" "1. http://localhost:8080/client/api\n" "2. ?command=deployVirtualMachine\n" "3. &serviceOfferingId=1\n" "4. &diskOfferingId=1\n" "5. &templateId=2\n" "6. &zoneId=4\n" "7. &apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXqjB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ\n" "8. &signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D\n" " " msgstr "" #. Tag: para #, no-c-format msgid "The first line is the &PRODUCT; API URL. This is the Cloud instance you wish to interact with." msgstr "" #. Tag: para #, no-c-format msgid "The second line refers to the command you wish to execute. In our example, we are attempting to deploy a fresh new virtual machine. It is preceded by a (?) to separate itself from the &PRODUCT; API URL." msgstr "" #. Tag: para #, no-c-format msgid "Lines 3-6 are the parameters for this given command. To see the command and its request parameters, please refer to the appropriate section in the &PRODUCT; API documentation. Each parameter field-value pair (field=value) is preceded by an ampersand character (&)." msgstr "" #. Tag: para #, no-c-format msgid "Line 7 is the user API Key that uniquely identifies the account. See Signing API Requests on page 7." msgstr "" #. Tag: para #, no-c-format msgid "Line 8 is the signature hash created to authenticate the user account executing the API command. See Signing API Requests on page 7." msgstr ""