平安云|Ping An Cloud- Building Your Smart Future

API Description

1. AttachDiskToInstance Interface Description  Attach EBS to ECS instance.  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 that attached by calling ListAbleAttachInstance interface. The interface is asynchronous execution. It will take a few moments for the interface to call return information successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> yes </td> <td> EBS Id to be attached. </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> yes </td> <td> ECS instance Id attached on EBS.  Query all the ECS instance that can be attached by calling ListAbleAttachInstance interface </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Task Id </td> <td>   </td> </tr> </tbody> </table>   2. CheckQuota Interface Description 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 Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Unexpanded EBS ID </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> Expanded EBS Size </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   3. CreateDisk Interface Description 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.  authentication. Creating EBS will incurred cost, thus it is recommended to understand the EBS pricing model in advance. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> Memory of EBS, unit: GB   Must be filled </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> EBS display name in portal interface.  The longest length of EBS display name is 20, if exceed, then it will throw ParameterValidateException exception. </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> yes </td> <td> EBS product specification.  Each EBS type in the portal has corresponding EBS product specification, for example, the SSD cloud drive corresponds to the product specification name ebs.s1.  Query EBS product specification by ListAllEbsTypes interface. </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> yes </td> <td> Amount of EBS need to be created  1 by default. </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> no </td> <td> EBS tag. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id EBS belongs to.  Must be filled RegionId determines where the EBS user created located, such as Huadong 1.  Can Query region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> Available zone Id EBS belongs to.   Must be filled There may be more than one free area under a region, and the available zone Id determines the specific free area of the EBS distribution created by the user, such as available zone A.  Can query region information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> SnapshotId </td> <td> String </td> <td> no </td> <td> Created snapshot used in EBS. </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> yes </td> <td> ECS instance Id.   Must be filled ECS instance Id determines which ECS instance the EBS created will be attached.  Can list region information by ListInstances interface. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> Charge type of EBS.  Charge type is listed as follows:    Hour:  Charged by hourly Usage:  Charged by quantity PreUsage: Pre-paid by quantity Monthly: Paid by monthly Free:  Free of charge Annual:  Paid by year Charge mode is determined to be hour to create EBS recently.. </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product code of EBS.  Product code of EBS is fixed as Ebs. </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> Oder Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> Order Status </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product code of EBS.  Product code of EBS is fixed as Ebs. </td> <td>   </td> </tr> </tbody> </table>   4. CreateDiskNew Interface Description 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.Request Parameter Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> EBS Size, unit: GB Required field </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> EBS Display name on Ping An Cloud console Maximum EBS display name is 20 characters. If the maximum length is exceeded, a ParameterValidate exception will be thrown. </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> yes </td> <td> EBS Product Specification. Each type of cloud disk in the portal corresponds to the cloud disk product specification, such as the product specification ebs.s1 corresponding to the SSD type cloud disk. The cloud disk product specifications can be queried by the interface of ListAllEbsTypes. </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> yes </td> <td> 需要创建云磁盘数量。 默认情况下为1。 EBS numbers need to be created. The Defalut number is 1 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> no </td> <td> EBS Tags </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> EBS Region ID Required Field Region ID determines location of created EBS by users, e.g. South China 1. Region ID can be queried by interface ListRegions </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> Avialable Zone ID of EBS Required Field A Region may have various Available Zone. Available Zone ID determines the specific Availability Zone of the cloud disk distribution created by the user, e.g. Availability Zone A. Available Zone ID can be queried by interface ListZones </td> <td>   </td> </tr> <tr> <td> SnapshotId </td> <td> String </td> <td> no </td> <td> Snapshots of created EBS </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> yes </td> <td> Attached ECS ID of EBS Required field The ECS instance Id determines which instance the EBS can be attached可以通过ListAbleAttachInstance Instance ID can be queried by interface ListAbleAttachInstance </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> Billing method of EBS: Hour/Usage/PreUsage/ Monthly/Free/Annual Currently EBS billing method is by hour. </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product Code </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> Order Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> Order status </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product Code </td> <td>   </td> </tr> </tbody> </table>   5. DeleteDisk Interface Description 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. The EBS could be released only when the Status is one of the follows, or it will throw exception: 1, Available (availabe) 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 execute, it will take a few moments for the interface to call return information successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> EBS Id need to be released. </td> <td>   </td> </tr> <tr> <td> NeedDeleteSnapshot </td> <td> boolean </td> <td> no </td> <td> Whether to delete snapshots synchronously.  When the value is yes, which means delete snapshots synchronously (including manual and automatic snapshot) When the value is no, which means do not delete snapshot synchronously.  The value defaulted as yes. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   6. DetachDisk Interface Description Detach paid EBS from ECS. 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）EnableFlag properties in EBS must be yes; （2）EBS must have been attached to ECS instance; （3）Status of EBS must be Available or DestroyFailed; 4, The charge mode of EBS cannot be set to 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. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> yes </td> <td> EBS Id need to be unloaded. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   7. GetDisk Interface Description Get detailed EBS information by EBS Id. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> EBSId. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> DiskDetail </td> <td> EbsDetailBean </td> <td> Details of EBS. </td> <td>   </td> </tr> </tbody> </table>   8. ListAbleAttachInstance Interface Description List all the ECS instance 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. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> no </td> <td> EBSId to be attached. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name of ECS instance. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id to be attached belongs to EBS.  RegionId determines where EBS located, such as Huadong 1.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Availabe zone Id to be attached belonged to EBS.  There may be more than one available zone under a region, and the available zone Id determines the specific available zone of the EBS distribution created by the user, such as available zone A.  Can query region information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> no </td> <td> High available zone Id to be attached belonged to EBS.  There may be more than one high available zone under a region, and the high available zone Id determines the specific available zone of the EBS distribution created by the user, such as Shenzhen C1.  Can list region information by ListPods interface. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number.  Used in page query.  The default value is 1. </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size. Used in page query.  The default value is 10. </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Order by keywords.  When querying, specify by which keyword to sort the returned data.  Default sort order is by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type. By default, sorting by DESC is used in conjunction with sorting by keywords, indicating whether sorting is by ascending or descending order. The values are as follows:       ASC: ascending order   DESC: descending order </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> ECS classification array, the default values are Instance Category.ECS and InstanceCategory. Caas  ECS classification, and the values are:       Ecs:        Independent ECS    Caas:       Cluster ECS     Dedicated；  Dedicated ECS    AutoScaling: elastic scaling    GBD:        Bigdata ECS     FORTRESS:   Fortress machine </td> <td>   </td> </tr> <tr> <td> EbsTypeId </td> <td> String </td> <td> yes </td> <td> EBS product type Id.  Each EBS type in the portal has corresponding EBS product specification, for example, the SSD cloud drive corresponds to the product  specification name ebs.s1.  Can list region information by ListTypes interface. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> ECS instance information list </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of ECS host machines </td> <td>   </td> </tr> </tbody> </table>   9. ListAbleRelateDisks Interface Description Query the list of all EBS that can be associated with the snapshot policy. Please take note that when calling 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. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id EBS belongs to. Region Id determines where the ECS locates, such as Huadong 1. Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> yes </td> <td> Periods under snapshot policy.  The values are as follows.       MANUAL： Manual   HOURLY: Hourly     DAILY:  Daily    WEEKLY: Weekly    MONTHLY: monthly </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id EBS belongs to.  There may be more than one available zone under a region, and the available zone Id determines the specific available zone of the EBS distribution created by the user, such as available zone A.  Can list region information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name of EBS </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> no </td> <td> Name of ECS. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number.  Used in page query. </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size  Used in page query. </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Order by keywords.  When querying, specify by which keyword to sort the returned data.  Default sort order is by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type.  By default, sorting by DESC is used in conjunction with sorting keywords, indicating whether sorting is in ascending or descending order. The values are as follows:       ASC: ascending order   DESC: descending order </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> no </td> <td> EBS type. Only the EBS attached by the corresponding ECS in the array will be queried.  EBS type, the values are as follows:       ROOT: system disk    DATADISK: data disk </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> The ECS classification array column, with the default values of InstanceCategory.Ecs and InstanceCategory.Caas Only the EBS attached by the corresponding ECS in the array column will be queried.  ECS type, the values are as follows:       Ecs:        Independent ECS    Caas:       Cluster ECS     Dedicated；  Dedicated ECS    AutoScaling: elastic scaling    GBD:        Bigdata ECS     FORTRESS:   Fortress machine </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Disks </td> <td> List<EbsBean> </td> <td> Information list of EBS queried </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of EBS queried. </td> <td>   </td> </tr> </tbody> </table>   10. ListAllEbsTypes Interface Description List the type of EBS product types. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id EBS belongs to.  Region Id determines where the ECS locates, such as Huadong 1.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> Available zone Id EBS belongs to.  There may be more than one available zone under a region, and the available zone Id determines the specific available zone of the EBS distribution created by the user, such as available zone A.  Can list region information by ListZones interface. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EbsTypes </td> <td> List<EbsTypeBean> </td> <td> EBS product type information list. </td> <td>   </td> </tr> </tbody> </table>   11. ListDiskByPolicyId Interface Description 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 in the following status: 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 Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> SnapshotPolicyId </td> <td> String </td> <td> yes </td> <td> Snapshot policy associated to EBS.  Can get snapshot policy by ListAllSnapshotPolicies interface </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Disks </td> <td> List<EbsBean> </td> <td> Information list of EBS queried </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of EBS queried. </td> <td>   </td> </tr> </tbody> </table>   12. ListDisks Interface Description 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. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id EBS belongs to.  Region Id determines where ECS located, such as Huadong 1.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> no </td> <td> EBS Id. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id EBS belongs to.  There may be more than one available zone under a region, and the available zone Id determines the specific available zone of the EBS distribution created by the user, such as available zone A.  Can list region information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> no </td> <td> Available zone name EBS belongs to.  There may be more than one available zone under a region, and the available zone Id determines the specific available zone of the EBS distribution created by the user, such as available zone A.  Can list region information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name of EBS. </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> no </td> <td> ECS instance Id.  ECS instance Id means the ECS instance tag attached on EBS.  Can list region information by ListInstances interface. </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> no </td> <td> Name of ECS instance.  Name of ECS instance means the ECS instance tag attached on EBS.  Can list region information by ListInstances interface. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number.  Used in page query. </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size  Used in page query. </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Order by keywords.  When querying, specify by which keyword to sort the returned data.  Defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type. By default, sorting by DESC is used in conjunction with sorting keywords, indicating whether sorting is in ascending or descending order. The values are as follows:       ASC: ascending order   DESC: descending order </td> <td>   </td> </tr> <tr> <td> Status </td> <td> DiskStatus </td> <td> no </td> <td> EBS Status array column.  Only the EBS attached by the corresponding ECS in the array will be queried.  The values of EBS are as follows:       ToCreate: to create      Pending:pending       Available: available: available       CreateFailed: create       CreateFailed: create failed       Destroying: destroying       Destroyed:destroyed       DestroyFailed:destroy failed       Cancel: cancel       ToAttach: to be attached       Attaching: attaching       Deteaching: detaching </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String[] </td> <td> no </td> <td> Array column of EBS tag list.  Only the EBS attached by the corresponding ECS in the array column will be queried. </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> The ECS classification array column, with the default values of InstanceCategory.Ecs and InstanceCategory.Caas Only the EBS attached by the corresponding ECS in the array will be queried.  ECS type, the values are as follows:       Ecs:        Independent ECS    Caas:       Cluster ECS     Dedicated；  Dedicated ECS    AutoScaling: elastic scaling    GBD:        Bigdata ECS     FORTRESS:   Fortress machine </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> no </td> <td> EBS type. Only the EBS attached by the corresponding ECS in the array column will be queried.  EBS type, the values are as follows:       ROOT: system disk    DATADISK: data disk </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Disks </td> <td> List<EbsBean> </td> <td> Information list of EBS queried </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of EBS queried. </td> <td>   </td> </tr> </tbody> </table>   13. ListEbsTypes Interface Description Query the type of EBS product. Each EBS type in the portal has corresponding EBS product specification, for example, the product specification name SSD cloud drive corresponded to is ebs.s1. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> yes </td> <td> Product series Id to be queried. Can list product series information by ListProductSeries interface. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id EBS product type belongs to.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EbsTypes </td> <td> List<EbsTypeBean> </td> <td> EBS product type information list. </td> <td>   </td> </tr> </tbody> </table>   14. ModifyDiskAttribute Interface Description Modify EBS attribute. Modify EBS attribute needs to get the token by logging in for authentication. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> EBS Id to be modified. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name after EBS modification.  The longest length of EBS display name is 20, if exceed, then it will throw ParameterValidateException exception. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   15. ModifyEbsAttribute Interface Description 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. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> EBS Id </td> <td>   </td> </tr> <tr> <td> IsNeedDeleteShapshot </td> <td> boolean </td> <td> no </td> <td> Whether to release snapshot automatically with disk. </td> <td>   </td> </tr> <tr> <td> IsInstanceDeleteDisk </td> <td> boolean </td> <td> no </td> <td> Whether to release snapshot automatically with instance. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   16. UpgradeDisk Interface Description 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:  . 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 upgraded cannot be smaller than the original one; （5）expired disk cannot be upgraded; （6）if the EBS charge mode is  paid by monthly or annually, then the starting time, expiration time and period need to be calculated againwill be recalculated. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> EBS Id to be upgraded </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> EBS size after upgrading </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> no </td> <td> CouponId users hold.  Can list by listAvailableCoupons method in Payment service. </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> no </td> <td> Valid periods of upgrading. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> Charge type of EBS.  Charge type is listed as follows:    Hour:  Charged by hourly Usage:  Charged by quantity PreUsage: Pre-paid by quantity Monthly: Paid by monthly Free:  Free of charge Annual:  Paid by year Charge mode is determined to be hour to create EBS recently.. </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product code of EBS.  Product code of EBS is fixed as Ebs. </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> Oder Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> Order Status </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> Product code of EBS.  Product code of EBS is fixed as Ebs. </td> <td>   </td> </tr> </tbody> </table>

Did the above content solve your problem? Yes No