API Overview

<table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>API</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>AttachDiskToInstance</p> </td> <td> <p>Attach EBS to ECS.</p> <p>Attach EBS needs to get the token by logging in for authentication.&nbsp; Please take note that when calling the interface : 1. the Status of EBS must be ToAttach (to be attached) 2. the EBS type must be correspondent to ECS type, before calling this interface, you can query the information of the current EBS by calling ListDisks interface.&nbsp; Before calling this interface, you can query all the ECS instances that attached by calling ListAbleAttachInstance interface. The interface is asynchronous execution. It will take a few moments for the interface to return call&nbsp; information successfully.</p> </td> </tr> <tr> <td> <p>CheckQuota</p> </td> <td> <p>Quota check during upgrading process<br /> Contents:</p> <p>1)The expanded disk size cannot be smaller than the original disk size.<br /> 2)Single instance disk size quota<br /> 3)Single disk size quota</p> </td> </tr> <tr> <td> <p>CreateDisk</p> </td> <td> <p>Create one or more paid digital EBS.</p> <p>The type of EBS can be queried by ListAllEbsTypes.&nbsp;&nbsp; Create EBS needs to get the token by logging in for authentication.&nbsp; Creating EBS will incurred cost, thus it is recommended to understand the EBS pricing model in advance.</p> </td> </tr> <tr> <td> <p>CreateDiskNew</p> </td> <td> <p>Create one or more paid digital EBS. EBS types can be queried by interface ListAllEbsTypes.<br /> Create EBS needs to get the token by logging in for authentication.</p> </td> </tr> <tr> <td> <p>DeleteDisk</p> </td> <td> <p>Release paid data EBS.</p> <p>The type of EBS can be queried by ListAllEbsTypes.&nbsp;&nbsp; Release EBS needs to get the token by logging in for authentication. EBS can only be released under the following conditions, or&nbsp; exception error will occur: 1. Available (available) 2. CreateFailed (create failed) 3. DestroyFailed(destroy failed) 4,ToAttach (to be attached)&nbsp; Currently deleting a EBS will delete the corresponding snapshots of the EBS (including manual snapshots and automatic snapshots), this feature can be turned off by setting needDeleteSnapshot=no.&nbsp; The interface is asynchronous execution; It will take a few moments for the interface to return call information successfully.</p> </td> </tr> <tr> <td> <p>DetachDisk</p> </td> <td> <p>Detach paid EBS from ECS instance.</p> <p>The type of EBS can be queried by ListAllEbsTypes.&nbsp;&nbsp; Detach EBS need to get the token by logging in for authentication.&nbsp; Please take note of the following when using this interface:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1. The EnableFlag property in EBS is set to yes; 2. EBS must be &nbsp;attached to ECS instance; 3. Status of EBS must be either Available or DestroyFailed; 4, The charge mode of EBS cannot be Monthly (paid monthly); information above can be queried in EBS by ListDisks interface.&nbsp; The interface is asynchronous execution; It will take a few moments for the interface to return call information successfully.</p> </td> </tr> <tr> <td> <p>GetDisk</p> </td> <td> <p>Get detailed EBS information by EBS Id.</p> </td> </tr> <tr> <td> <p>ListAbleAttachInstance</p> </td> <td> <p>List all ECS instance that can be attached by EBS.&nbsp;&nbsp; The interface is usually called before calling AttachDiskToInstance interface, used to ensure the validation of ECS type Status attached to the EBS.</p> </td> </tr> <tr> <td> <p>ListAbleRelateDisks</p> </td> <td> <p>Query the list of all EBS that can be associated with the snapshot policy.&nbsp;&nbsp; Please take note that when calling the interface:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1. the data returned by this interface should be page data, the page value in default is 1, the amount of data displayed per page is 10.</p> </td> </tr> <tr> <td> <p>ListAllEbsTypes</p> </td> <td> <p>List the EBS product types.</p> </td> </tr> <tr> <td> <p>ListDiskByPolicyId</p> </td> <td> <p>Query the list of all EBS that can be associated with the snapshot policy. Please take note that when calling interface:</p> <p>1. only the following EBS information of Status can be queried:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p> <p>ToAttach: to be attached</p> <p>Attaching: attached</p> <p>Detaching: detached&nbsp;</p> <p>Available:available&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p> <p>Destroying:destroying DestroyFailed: failed to delete</p> <p>2. The Status of the ECS where EBS located must be inthefollowingstatus:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Running: running&nbsp;</p> <p>Stopped: stopped&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p> <p>Starting: started</p> <p>Stopping: stopping&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p> <p>Destroying: destroying&nbsp;&nbsp;&nbsp;</p> <p>3. The data returned is the result of page query. By default, the page number is 1 and 10 rows of data are displayed on each page</p> </td> </tr> <tr> <td> <p>ListDisks</p> </td> <td> <p>Query EBS information.&nbsp;</p> <p>Please take note that when calling interface: 1, the interface is executed by page query with the default page is 1, 1000 rows of data will be displayed in each page.</p> </td> </tr> <tr> <td> <p>ListEbsTypes</p> </td> <td> <p>Query the type of EBS product.&nbsp;</p> <p>Each EBS type in the portal has a corresponding EBS product specification, for example, the product specification name SSD cloud drive corresponded to is ebs.s1.</p> </td> </tr> <tr> <td> <p>ModifyDiskAttribute</p> </td> <td> <p>Modify EBS attribute.</p> <p>Modify EBS attribute need to get the token by logging in for authentication.</p> </td> </tr> <tr> <td> <p>ModifyEbsAttribute</p> </td> <td> <p>Modify EBS attribute</p> <p>Modify EBS need to get the token by logging in for authentication.&nbsp; List the disk that needs to modify by get disk uuid to judge and distinguish data disk and system disk, and check whether it is a local disk that can throw exceptional caution.</p> </td> </tr> <tr> <td> <p>UpgradeDisk</p> </td> <td> <p>Upgrade EBS.&nbsp;&nbsp;</p> <p>Upgrade EBS need to get the token by logging in for in for authentication.&nbsp; EBS upgrade will incur cost, it i recommended to know the pricing model of EBS in advance.&nbsp; Please take note that when calling this interface: &nbsp;</p> <p>1. only data disk (whose type is DATADISK) can be upgraded, system disk(whose type is ROOT) cannot be upgraded;</p> <p>2. Status of EBS can be upgraded when it is Available or Destroyfailed ;</p> <p>3. Status of EBS can be upgraded when it is Normal ;</p> <p>4. the disk memory of the upgrade cannot be smaller than the original one;</p> <p>5. expired disk cannot be upgraded;</p> <p>6. if the EBS charge mode is paid monthly or annually, then the start time, expiration time and period will be recalculated.</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products