incubator-cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject git commit: Rename cloudplatform-api.xml to cloudstack-api.xml Change CloudPlatform to &PRODUCT;
Date Wed, 28 Nov 2012 04:47:32 GMT
Updated Branches:
  refs/heads/master 45dd833b2 -> df8990eae

Rename cloudplatform-api.xml to cloudstack-api.xml
Change CloudPlatform to &PRODUCT;


Branch: refs/heads/master
Commit: df8990eae6ae0c8ecf9dea6c7726dbe29fcee7c4
Parents: 45dd833
Author: Gavin Lee <>
Authored: Wed Nov 28 12:45:54 2012 +0800
Committer: Gavin Lee <>
Committed: Wed Nov 28 12:45:54 2012 +0800

 docs/en-US/cloudstack-api.xml       |   31 ++++++++++++++++++++++++++++++
 docs/en-US/management-server-lb.xml |    2 +-
 2 files changed, 32 insertions(+), 1 deletions(-)
diff --git a/docs/en-US/cloudstack-api.xml b/docs/en-US/cloudstack-api.xml
new file mode 100644
index 0000000..891b19f
--- /dev/null
+++ b/docs/en-US/cloudstack-api.xml
@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" ""
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+<!-- 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
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+<section id="cloudstack-api">
+    <title>&PRODUCT; API</title>
+    <para>The &PRODUCT; API is a low level API that has been used to implement
the &PRODUCT; web UIs. It is also a good basis for implementing other popular APIs such
as EC2/S3 and emerging DMTF standards.</para>
+    <para>Many &PRODUCT; 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.</para>
+    <para>The API has a REST-like query basis and returns results in XML or JSON.</para>
+    <para>See <ulink url="">the Developer’s
Guide</ulink> and <ulink url="">the
API Reference</ulink>.</para>
+   </section>
diff --git a/docs/en-US/management-server-lb.xml b/docs/en-US/management-server-lb.xml
index c62e1ef..85a8622 100644
--- a/docs/en-US/management-server-lb.xml
+++ b/docs/en-US/management-server-lb.xml
@@ -20,7 +20,7 @@
 <section id="management-server-lb">
   <title>Setting Zone VLAN and Running VM Maximums</title>
-  <para>CloudPlatform can use a load balancer to provide a virtual IP for multiple
+  <para>&PRODUCT; can use a load balancer to provide a virtual IP for multiple
     Servers. The administrator is responsible for creating the load balancer rules for the
     Management Servers. The application requires persistence or stickiness across multiple
     The following chart lists the ports that should be load balanced and whether or not persistence

View raw message