etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs. Developer's Guide fixes. Moved "New APIs in 4.0" to correct section, removed obsolete product name, fixed book abstract, ID, and copyright holder.

This commit is contained in:
Jessica Tomechak 2012-10-10 14:45:59 -07:00
parent d7704422ac
commit 7ce5fdda27
7 changed files with 175 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en-US/API_Developers_Guide.ent
View File

@ -15,7 +15,7 @@
specific language governing permissions and limitations
under the License.
-->
<!ENTITY PRODUCT "CloudPlatform">
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Citrix">
<!ENTITY HOLDER "Apache Software Foundation">

9
docs/en-US/API_Developers_Guide.xml
View File

@ -23,15 +23,15 @@
-->
<book>
<bookinfo id="book-release-notes-3.0.4">
<title>&PRODUCT; API Developers Guide</title>
<bookinfo id="cloudstack_developers">
<title>&PRODUCT; API Developer's Guide</title>
<productname>Apache CloudStack</productname>
<productnumber>4.0</productnumber>
<edition></edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Complete technical documentation of &PRODUCT;.
How to integrate with &PRODUCT; using the &PRODUCT; API.
</para>
</abstract>
<corpauthor>
@ -53,5 +53,4 @@
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
</book>

164
docs/en-US/added-API-commands-4.0.xml Normal file
View File

@ -0,0 +1,164 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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.
-->
<section id="added-API-commands-4.0">
<title>Added API Commands in 4.0</title>
<itemizedlist>
<listitem>
<para>createCounter (Adds metric counter)</para>
</listitem>
<listitem>
<para>deleteCounter (Deletes a counter)</para>
</listitem>
<listitem>
<para>listCounters (List the counters)</para>
</listitem>
<listitem>
<para>createCondition (Creates a condition)</para>
</listitem>
<listitem>
<para>deleteCondition (Removes a condition)</para>
</listitem>
<listitem>
<para>listConditions (List Conditions for the specific user)</para>
</listitem>
<listitem>
<para>createTags. Add tags to one or more resources. Example:
<programlisting>command=createTags
&amp;resourceIds=1,10,12
&amp;resourceType=userVm
&amp;tags[0].key=region
&amp;tags[0].value=canada
&amp;tags[1].key=city
&amp;tags[1].value=Toronto </programlisting></para>
</listitem>
<listitem>
<para>deleteTags. Remove tags from one or more resources. Example:
<programlisting>command=deleteTags
&amp;resourceIds=1,12
&amp;resourceType=Snapshot
&amp;tags[0].key=city </programlisting></para>
</listitem>
<listitem>
<para>listTags (Show currently defined resource tags)</para>
</listitem>
<listitem>
<para>createVPC (Creates a VPC)</para>
</listitem>
<listitem>
<para>listVPCs (Lists VPCs)</para>
</listitem>
<listitem>
<para>deleteVPC (Deletes a VPC)</para>
</listitem>
<listitem>
<para>updateVPC (Updates a VPC)</para>
</listitem>
<listitem>
<para>restartVPC (Restarts a VPC)</para>
</listitem>
<listitem>
<para>createVPCOffering (Creates VPC offering)</para>
</listitem>
<listitem>
<para>updateVPCOffering (Updates VPC offering)</para>
</listitem>
<listitem>
<para>deleteVPCOffering (Deletes VPC offering)</para>
</listitem>
<listitem>
<para>listVPCOfferings (Lists VPC offerings)</para>
</listitem>
<listitem>
<para>createPrivateGateway (Creates a private gateway)</para>
</listitem>
<listitem>
<para>listPrivateGateways (List private gateways)</para>
</listitem>
<listitem>
<para>deletePrivateGateway (Deletes a Private gateway)</para>
</listitem>
<listitem>
<para>createNetworkACL (Creates a ACL rule the given network (the network has to belong to
VPC))</para>
</listitem>
<listitem>
<para>deleteNetworkACL (Deletes a Network ACL)</para>
</listitem>
<listitem>
<para>listNetworkACLs (Lists all network ACLs)</para>
</listitem>
<listitem>
<para>createStaticRoute (Creates a static route)</para>
</listitem>
<listitem>
<para>deleteStaticRoute (Deletes a static route)</para>
</listitem>
<listitem>
<para>listStaticRoutes (Lists all static routes)</para>
</listitem>
<listitem>
<para>createVpnCustomerGateway (Creates site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>createVpnGateway (Creates site to site vpn local gateway)</para>
</listitem>
<listitem>
<para>createVpnConnection (Create site to site vpn connection)</para>
</listitem>
<listitem>
<para>deleteVpnCustomerGateway (Delete site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>deleteVpnGateway (Delete site to site vpn gateway)</para>
</listitem>
<listitem>
<para>deleteVpnConnection (Delete site to site vpn connection)</para>
</listitem>
<listitem>
<para>updateVpnCustomerGateway (Update site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>resetVpnConnection (Reset site to site vpn connection)</para>
</listitem>
<listitem>
<para>listVpnCustomerGateways (Lists site to site vpn customer gateways)</para>
</listitem>
<listitem>
<para>listVpnGateways (Lists site 2 site vpn gateways)</para>
</listitem>
<listitem>
<para>listVpnConnections (Lists site to site vpn connection gateways)</para>
</listitem>
<listitem>
<para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well
as the IP address of the Nexus 1000v dvSwitch.)</para>
</listitem>
</itemizedlist>
</section>

133
docs/en-US/added-API-commands.xml
View File

@ -19,138 +19,7 @@
under the License.
-->
<section id="added-API-commands">
<title>Added API commands</title>
<section id="added-API-commands-4.0">
<title>Added in 4.0</title>
<itemizedlist>
<listitem>
<para>createCounter (Adds metric counter)</para>
</listitem>
<listitem>
<para>deleteCounter (Deletes a counter)</para>
</listitem>
<listitem>
<para>listCounters (List the counters)</para>
</listitem>
<listitem>
<para>createCondition (Creates a condition)</para>
</listitem>
<listitem>
<para>deleteCondition (Removes a condition)</para>
</listitem>
<listitem>
<para>listConditions (List Conditions for the specific user)</para>
</listitem>
<listitem>
<para>createTags. Add tags to one or more resources. Example:
<programlisting>command=createTags
&amp;resourceIds=1,10,12
&amp;resourceType=userVm
&amp;tags[0].key=region
&amp;tags[0].value=canada
&amp;tags[1].key=city
&amp;tags[1].value=Toronto </programlisting></para>
</listitem>
<listitem>
<para>deleteTags. Remove tags from one or more resources. Example:
<programlisting>command=deleteTags
&amp;resourceIds=1,12
&amp;resourceType=Snapshot
&amp;tags[0].key=city </programlisting></para>
</listitem>
<listitem>
<para>listTags (Show currently defined resource tags)</para>
</listitem>
<listitem>
<para>createVPC (Creates a VPC)</para>
</listitem>
<listitem>
<para>listVPCs (Lists VPCs)</para>
</listitem>
<listitem>
<para>deleteVPC (Deletes a VPC)</para>
</listitem>
<listitem>
<para>updateVPC (Updates a VPC)</para>
</listitem>
<listitem>
<para>restartVPC (Restarts a VPC)</para>
</listitem>
<listitem>
<para>createVPCOffering (Creates VPC offering)</para>
</listitem>
<listitem>
<para>updateVPCOffering (Updates VPC offering)</para>
</listitem>
<listitem>
<para>deleteVPCOffering (Deletes VPC offering)</para>
</listitem>
<listitem>
<para>listVPCOfferings (Lists VPC offerings)</para>
</listitem>
<listitem>
<para>createPrivateGateway (Creates a private gateway)</para>
</listitem>
<listitem>
<para>listPrivateGateways (List private gateways)</para>
</listitem>
<listitem>
<para>deletePrivateGateway (Deletes a Private gateway)</para>
</listitem>
<listitem>
<para>createNetworkACL (Creates a ACL rule the given network (the network has to belong to
VPC))</para>
</listitem>
<listitem>
<para>deleteNetworkACL (Deletes a Network ACL)</para>
</listitem>
<listitem>
<para>listNetworkACLs (Lists all network ACLs)</para>
</listitem>
<listitem>
<para>createStaticRoute (Creates a static route)</para>
</listitem>
<listitem>
<para>deleteStaticRoute (Deletes a static route)</para>
</listitem>
<listitem>
<para>listStaticRoutes (Lists all static routes)</para>
</listitem>
<listitem>
<para>createVpnCustomerGateway (Creates site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>createVpnGateway (Creates site to site vpn local gateway)</para>
</listitem>
<listitem>
<para>createVpnConnection (Create site to site vpn connection)</para>
</listitem>
<listitem>
<para>deleteVpnCustomerGateway (Delete site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>deleteVpnGateway (Delete site to site vpn gateway)</para>
</listitem>
<listitem>
<para>deleteVpnConnection (Delete site to site vpn connection)</para>
</listitem>
<listitem>
<para>updateVpnCustomerGateway (Update site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>resetVpnConnection (Reset site to site vpn connection)</para>
</listitem>
<listitem>
<para>listVpnCustomerGateways (Lists site to site vpn customer gateways)</para>
</listitem>
<listitem>
<para>listVpnGateways (Lists site 2 site vpn gateways)</para>
</listitem>
<listitem>
<para>listVpnConnections (Lists site to site vpn connection gateways)</para>
</listitem>
</itemizedlist>
</section>
<title>Added API commands in 3.0</title>
<section id="added-api-commands-3.0.2">
<title>Added in 3.0.2</title>
<itemizedlist>

2
docs/en-US/added-cloudPlatform-error-codes.xml → docs/en-US/added-error-codes.xml
View File

@ -22,7 +22,7 @@
under the License.
-->
<section id="added-cloudPlatform-error-codes">
<section id="added-error-codes">
<title>Added &PRODUCT; Error Codes</title>
<para>You can now find the &PRODUCT;-specific error code in the exception response for each type of exception. The following list of error codes is added to the new class named CSExceptionErrorCode. These codes are applicable in &PRODUCT; 3.0.3 and later versions.</para>
<informaltable frame="all">

1
docs/en-US/change-to-behavior-of-list-commands.xml
View File

@ -105,5 +105,4 @@
<para>The &PRODUCT; UI on a general view will display all resources that the logged-in user is
authorized to see, except for project resources. To see the project resources, select the
project view.</para>
<xi:include href="changed-apicommands-4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>

5
docs/en-US/whats-new.xml
View File

@ -27,7 +27,8 @@
<para>The following describes any new major features of each &PRODUCT; version as it applies to API usage.</para>
<section id="whats-new-in-api-4.0">
<title>What's New in the API for 4.0</title>
<para>TODO</para>
<xi:include href="changed-apicommands-4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="added-API-commands-4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="whats-new-in-api-3.0">
<title>What's New in the API for 3.0</title>
@ -36,6 +37,6 @@
<xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-cloudPlatform-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>