mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
39 lines
2.2 KiB
XML
39 lines
2.2 KiB
XML
<?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="asynchronous-commands">
|
|
<title>Asynchronous Commands</title>
|
|
<para>Asynchronous commands were introduced in &PRODUCT; 2.x. Commands are designated as asynchronous when they can potentially take a long period of time to complete such as creating a snapshot or disk volume. They differ from synchronous commands by the following:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem><para>They are identified in the API Reference by an (A).</para></listitem>
|
|
<listitem><para>They will immediately return a job ID to refer to the job that will be responsible in processing the command.</para></listitem>
|
|
<listitem><para>If executed as a "create" resource command, it will return the resource ID as well as the job ID.</para>
|
|
<para>You can periodically check the status of the job by making a simple API call to the command, queryAsyncJobResult and passing in the job ID.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<xi:include href="job-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
<xi:include href="asynchronous-commands-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
</section>
|