blob: 178430e729cc801ae4257b38fad60e4b47bd272b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../includes/main.css" type="text/css">
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon">
<title>Apache CloudStack | The Power Behind Your Cloud</title>
</head>
<body>
<div id="insidetopbg">
<div id="inside_wrapper">
<div class="uppermenu_panel">
<div class="uppermenu_box"></div>
</div>
<div id="main_master">
<div id="inside_header">
<div class="header_top">
<a class="cloud_logo" href="http://cloudstack.org"></a>
<div class="mainemenu_panel"></div>
</div>
</div>
<div id="main_content">
<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<div class="api_titlebox">
<div class="api_titlebox_left">
<span>
Apache CloudStack 4.14.1.0-SNAPSHOT Root Admin API Reference
</span>
<p></p>
<h1>resizeVolume</h1>
<p>Resizes a volume</p>
</div>
<div class="api_titlebox_right">
<a class="api_backbutton" href="../index.html"></a>
</div>
</div>
<div class="api_tablepanel">
<h2>Request parameters</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>the ID of the disk volume</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><i>diskofferingid</i></td><td style="width:500px;"><i>new disk offering id</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>maxiops</i></td><td style="width:500px;"><i>New maximum number of IOPS</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>miniops</i></td><td style="width:500px;"><i>New minimum number of IOPS</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>shrinkok</i></td><td style="width:500px;"><i>Verify OK to Shrink</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>size</i></td><td style="width:500px;"><i>New volume size in GB</i></td><td style="width:180px;"><i>false</i></td>
</tr>
</table>
</div>
<div class="api_tablepanel">
<h2>Response Tags</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">ID of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>attached</strong></td><td style="width:500px;">the date the volume was attached to a VM instance</td>
</tr>
<tr>
<td style="width:200px;"><strong>chaininfo</strong></td><td style="width:500px;">the chain info of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">cluster id of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">cluster name where the volume is allocated</td>
</tr>
<tr>
<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date the disk volume was created</td>
</tr>
<tr>
<td style="width:200px;"><strong>destroyed</strong></td><td style="width:500px;">the boolean state of whether the volume is destroyed or not</td>
</tr>
<tr>
<td style="width:200px;"><strong>deviceid</strong></td><td style="width:500px;">the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskBytesReadRate</strong></td><td style="width:500px;">bytes read rate of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskBytesWriteRate</strong></td><td style="width:500px;">bytes write rate of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskIopsReadRate</strong></td><td style="width:500px;">io requests read rate of the disk volume per the disk offering</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskIopsWriteRate</strong></td><td style="width:500px;">io requests write rate of the disk volume per the disk offering</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskioread</strong></td><td style="width:500px;">the read (io) of disk on the vm</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskiowrite</strong></td><td style="width:500px;">the write (io) of disk on the vm</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskkbsread</strong></td><td style="width:500px;">the read (bytes) of disk on the vm</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskkbswrite</strong></td><td style="width:500px;">the write (bytes) of disk on the vm</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskofferingdisplaytext</strong></td><td style="width:500px;">the display text of the disk offering</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskofferingid</strong></td><td style="width:500px;">ID of the disk offering</td>
</tr>
<tr>
<td style="width:200px;"><strong>diskofferingname</strong></td><td style="width:500px;">name of the disk offering</td>
</tr>
<tr>
<td style="width:200px;"><strong>displayvolume</strong></td><td style="width:500px;">an optional field whether to the display the volume to the end user or not.</td>
</tr>
<tr>
<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">Hypervisor the volume belongs to</td>
</tr>
<tr>
<td style="width:200px;"><strong>isextractable</strong></td><td style="width:500px;">true if the volume is extractable, false otherwise</td>
</tr>
<tr>
<td style="width:200px;"><strong>isodisplaytext</strong></td><td style="width:500px;">an alternate display text of the ISO attached to the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>isoid</strong></td><td style="width:500px;">the ID of the ISO attached to the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>isoname</strong></td><td style="width:500px;">the name of the ISO attached to the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>maxiops</strong></td><td style="width:500px;">max iops of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>miniops</strong></td><td style="width:500px;">min iops of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>path</strong></td><td style="width:500px;">the path of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>physicalsize</strong></td><td style="width:500px;">the bytes alloaated</td>
</tr>
<tr>
<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">pod id of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">pod name of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vpn</td>
</tr>
<tr>
<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vpn</td>
</tr>
<tr>
<td style="width:200px;"><strong>provisioningtype</strong></td><td style="width:500px;">provisioning type used to create volumes.</td>
</tr>
<tr>
<td style="width:200px;"><strong>quiescevm</strong></td><td style="width:500px;">need quiesce vm or not when taking snapshot</td>
</tr>
<tr>
<td style="width:200px;"><strong>serviceofferingdisplaytext</strong></td><td style="width:500px;">the display text of the service offering for root disk</td>
</tr>
<tr>
<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">ID of the service offering for root disk</td>
</tr>
<tr>
<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">name of the service offering for root disk</td>
</tr>
<tr>
<td style="width:200px;"><strong>size</strong></td><td style="width:500px;">size of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>snapshotid</strong></td><td style="width:500px;">ID of the snapshot from which this volume was created</td>
</tr>
<tr>
<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>storage</strong></td><td style="width:500px;">name of the primary storage hosting the disk volume</td>
</tr>
<tr>
<td style="width:200px;"><strong>storageid</strong></td><td style="width:500px;">id of the primary storage hosting the disk volume; returned to admin user only</td>
</tr>
<tr>
<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">shared or local storage</td>
</tr>
<tr>
<td style="width:200px;"><strong>templatedisplaytext</strong></td><td style="width:500px;"> an alternate display text of the template for the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>templateid</strong></td><td style="width:500px;">the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.</td>
</tr>
<tr>
<td style="width:200px;"><strong>templatename</strong></td><td style="width:500px;">the name of the template for the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">type of the disk volume (ROOT or DATADISK)</td>
</tr>
<tr>
<td style="width:200px;"><strong>utilization</strong></td><td style="width:500px;">the disk utilization</td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">id of the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualsize</strong></td><td style="width:500px;">the bytes actually consumed on disk</td>
</tr>
<tr>
<td style="width:200px;"><strong>vmdisplayname</strong></td><td style="width:500px;">display name of the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>vmname</strong></td><td style="width:500px;">name of the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>vmstate</strong></td><td style="width:500px;">state of the virtual machine</td>
</tr>
<tr>
<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">ID of the availability zone</td>
</tr>
<tr>
<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">name of the availability zone</td>
</tr>
<tr>
<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td>
</tr>
<tr>
<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="comments_thread">
<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script>
<noscript>
<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&amp;page=4.2.0/rootadmin"></iframe>
</noscript>
</div>
<div id="footer_mainmaster">
<p>
Copyright &copy; 2015 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
<br>
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.
</p>
</div>
</div>
</div>
</div>
</body>
</html>