cloudstack/docs/tmp/en-US/html/api-overview.html

12 lines
3.3 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 20. CloudStack API</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta name="generator" content="publican 2.8" /><meta name="package" content="Apache_CloudStack-Admin_Guide-4.0.0-incubating-en-US-1-" /><link rel="home" href="index.html" title="CloudStack Administrator's Guide" /><link rel="up" href="index.html" title="CloudStack Administrator's Guide" /><link rel="prev" href="global-config.html" title="Chapter 19. Setting Global Configuration Parameters" /><link rel="next" href="provisioning-auth-api.html" title="20.1. Provisioning and Authentication API" /></head><body><p id="title"><a class="left" href="http://cloudstack.org"><img src="Common_Content/images/image_left.png" alt="Product Site" /></a><a class="right" href="http://docs.cloudstack.org"><img src="Common_Content/images/image_right.png" alt="Documentation Site" /></a></p><ul class="docnav"><li class="previous"><a accesskey="p" href="global-config.html"><strong>Prev</strong></a></li><li class="next"><a accesskey="n" href="provisioning-auth-api.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="chapter" id="api-overview" lang="en-US"><div class="titlepage"><div><div><h2 class="title">Chapter 20. CloudStack API</h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="provisioning-auth-api.html">20.1. Provisioning and Authentication API</a></span></dt><dt><span class="section"><a href="allocators.html">20.2. Allocators</a></span></dt><dt><span class="section"><a href="user-data-and-meta-data.html">20.3. User Data and Meta Data</a></span></dt></dl></div><div class="para">
The CloudStack API is a low level API that has been used to implement the CloudStack web UIs. It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF standards.
</div><div class="para">
Many CloudStack API calls are asynchronous. These will return a Job ID immediately when called. This Job ID can be used to query the status of the job later. Also, status calls on impacted resources will provide some indication of their state.
</div><div class="para">
The API has a REST-like query basis and returns results in XML or JSON.
</div><div class="para">
See <a href="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the Developers Guide</a> and <a href="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API Reference</a>.
</div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="global-config.html"><strong>Prev</strong>Chapter 19. Setting Global Configuration Paramete...</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="provisioning-auth-api.html"><strong>Next</strong>20.1. Provisioning and Authentication API</a></li></ul></body></html>