API

Description

AttachDiskToInstance

Attach EBS to ECS.

Attach EBS needs to get the token by logging in for authentication.  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.  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  information successfully.

CheckQuota

Quota check during upgrading process
Contents：

1）The expanded disk size cannot be smaller than the original disk size.
2）Single instance disk size quota
3）Single disk size quota

CreateDisk

Create one or more paid digital EBS.

The type of EBS can be queried by ListAllEbsTypes.   Create EBS needs to get the token by logging in for authentication.  Creating EBS will incurred cost, thus it is recommended to understand the EBS pricing model in advance.

CreateDiskNew

Create one or more paid digital EBS. EBS types can be queried by interface ListAllEbsTypes.
Create EBS needs to get the token by logging in for authentication.

DeleteDisk

Release paid data EBS.

The type of EBS can be queried by ListAllEbsTypes.   Release EBS needs to get the token by logging in for authentication. EBS can only be released under the following conditions, or  exception error will occur: 1. Available (available) 2. CreateFailed (create failed) 3. DestroyFailed(destroy failed) 4,ToAttach (to be attached)  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.  The interface is asynchronous execution; It will take a few moments for the interface to return call information successfully.

DetachDisk

Detach paid EBS from ECS instance.

The type of EBS can be queried by ListAllEbsTypes.   Detach EBS need to get the token by logging in for authentication.  Please take note of the following when using this interface:       1. The EnableFlag property in EBS is set to yes; 2. EBS must be  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.  The interface is asynchronous execution; It will take a few moments for the interface to return call information successfully.

GetDisk

Get detailed EBS information by EBS Id.

ListAbleAttachInstance

List all ECS instance that can be attached by EBS.   The interface is usually called before calling AttachDiskToInstance interface, used to ensure the validation of ECS type Status attached to the EBS.

ListAbleRelateDisks

Query the list of all EBS that can be associated with the snapshot policy.   Please take note that when calling the interface:       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.

ListAllEbsTypes

List the EBS product types.

ListDiskByPolicyId

Query the list of all EBS that can be associated with the snapshot policy. Please take note that when calling interface:

1. only the following EBS information of Status can be queried:              

ToAttach: to be attached

Attaching: attached

Detaching: detached 

Available：available        

Destroying：destroying DestroyFailed: failed to delete

2. The Status of the ECS where EBS located must be inthefollowingstatus:               Running: running 

Stopped: stopped          

Starting: started

Stopping: stopping        

Destroying: destroying   

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

ListDisks

Query EBS information. 

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.

ListEbsTypes

Query the type of EBS product. 

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.

ModifyDiskAttribute

Modify EBS attribute.

Modify EBS attribute need to get the token by logging in for authentication.

ModifyEbsAttribute

Modify EBS attribute

Modify EBS need to get the token by logging in for authentication.  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.

UpgradeDisk

Upgrade EBS.  

Upgrade EBS need to get the token by logging in for in for authentication.  EBS upgrade will incur cost, it i recommended to know the pricing model of EBS in advance.  Please take note that when calling this interface:  

1. only data disk (whose type is DATADISK) can be upgraded, system disk(whose type is ROOT) cannot be upgraded;

2. Status of EBS can be upgraded when it is Available or Destroyfailed ;

3. Status of EBS can be upgraded when it is Normal ;

4. the disk memory of the upgrade cannot be smaller than the original one;

5. expired disk cannot be upgraded;

6. if the EBS charge mode is paid monthly or annually, then the start time, expiration time and period will be recalculated.