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

API_Description

1.  CreateImage Interface Description Create image create image need to get the token by logging in for authentication. Please take note that when calling interface: 1) there must be EBS or ECS, or throwing exception of ParameterRequiredException 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> no </td> <td> EBS Id  There must be EBS or ECS, or throwing exception of ParameterRequiredException Can list EBS information by ListDisks </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> no </td> <td> ECS Id determines the source of image  Can list ECS information by ListInstances </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of image in user interface.  The longest length of EBS display name is 20, if exceed, then it will throw ParameterValidateException exception. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> yes </td> <td> Image name Including Chinese, English letters, numbers, @ and _, -, the longest length to display name is 50 digits. </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Image Description </td> <td>   </td> </tr> </tbody> </table> <a name="_Toc528583476">Response Parameter</a> <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>   2.  DeleteImage Interface Description Destroy image by image id. Please take note to get the token by logging in for in for authentication before calling interface: 1) image that Status is Available, Unavailable, CreateFailed, DeleteFailed can be destroyed. 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> Image Id need to be deleted  Can list image information by ListImages 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> Job Id </td> <td>   </td> </tr> </tbody> </table>   3.  ListImages Interface Description Query all the images. Pay attention and need to get the token by logging in for authentication before calling interface: 1, the interface is executed by page query with the default page 1, 100 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 image 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> ZoneId </td> <td> String </td> <td> yes </td> <td> Available zone Id image 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> OsTypeId </td> <td> String </td> <td> no </td> <td> Operating type Id that image belongs to  Operating type Id determines which kind of type image belongs to, such as Linux  Can list operating type information by ListOsTypes interface. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Image name </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of image in portal interface  The longest length is 20, or it will throw ParameterValidate exception </td> <td>   </td> </tr> <tr> <td> Status </td> <td> ImageStatus </td> <td> no </td> <td> Image Status, such as:   ToCreate to create   Pending   pending   CreateFailed create failed   Available  available   Unavailable  unavailable   Deleting  deleting   Deleted   deleted   DeleteFailed delete failed </td> <td>   </td> </tr> <tr> <td> UseType </td> <td> ImageType </td> <td> no </td> <td> Image using type, for example:    Public public SPECIAL dedicated and can be divided into two types: one is image created based on an existing instance, and the other is a manual upload with host function NO_AGENT and without host function. </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> ForCreateInstance </td> <td> Boolean </td> <td> no </td> <td> Whether the host machine can be created, if the default value is yes, if the host value is no, the host machine cannot be created </td> <td>   </td> </tr> </tbody> </table> <a name="_Toc528583484">Response Parameter</a> <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> Images </td> <td> List<ImageBean> </td> <td> Image information list </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of image </td> <td>   </td> </tr> </tbody> </table>   4.  ListOsMappingCsOs Interface Description Query all the corresponding relations operating system mapped to CS operating system. Need to get the token by log in authentication. Be able to query regional information by ListRegions. Query available zone information by ListZones 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> The operating system maps to the domain ID to which the CS operating system correspondence belongs.  Region Id determines where ECS located, 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> The operating system maps to the available zone Id to which the CS operating system corresponding 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> TotalCount </td> <td> Long </td> <td> The total amount queried </td> <td>   </td> </tr> <tr> <td> OsTypes </td> <td> List<OsMappingCsOsBean> </td> <td> Details list operating system mapping to CS operating system correspondence </td> <td>   </td> </tr> </tbody> </table>   5.  ListOsTypes Interface Description Query operating system type. Please take note to get the token by logging in for authentication before calling interface: 1, interface is used by page query, the default page is 1, 10 rows of data will be displayed each page in an ascending sort order. 2, if the page is over 3000, then set the page size will be set as 3000 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> Operating system type Id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Operating system type name </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Operating system type Description </td> <td>   </td> </tr> <tr> <td> OsCategory </td> <td> String </td> <td> no </td> <td> Operating system type, as follows:    LINUX, WINDOWS, UNIX, AIX </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> Orde by key words, which means sorting by what fields.  Default order is by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type. Default is sorting by DESC, 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> </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> TotalCount </td> <td> Long </td> <td> Total amount of operating system type information list </td> <td>   </td> </tr> <tr> <td> OsTypes </td> <td> List<OsTypeBean> </td> <td> Operating system type information list </td> <td>   </td> </tr> </tbody> </table>   6.  ManualUploadImage Interface Description Manual upload image. Need to get the token by logging in for authentication. Query  images by ListImages interface. 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> Url </td> <td> String </td> <td> yes </td> <td> Image Url stored in OBS </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> yes </td> <td> Image name </td> <td>   </td> </tr> <tr> <td> Displaytext </td> <td> String </td> <td> no </td> <td> Image Description </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id image belongs to when uploaded.  Region Id determines where the image located, 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 that image belongs to when uploaded.  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> Hypervisor </td> <td> HypervisorType </td> <td> no </td> <td> Virtual management type, such as: KVM, VMware  Defaulted as KVM type </td> <td>   </td> </tr> <tr> <td> Ostypeid </td> <td> String </td> <td> yes </td> <td> Operating type Id that image belongs to  Can list corresponding operating type information by calling ListOsMappingCsOs interface </td> <td>   </td> </tr> <tr> <td> Isfeatured </td> <td> Boolean </td> <td> no </td> <td> Whether it is featured, defaulted as yes(featured) </td> <td>   </td> </tr> <tr> <td> Ispublic </td> <td> Boolean </td> <td> no </td> <td> Whether it is public, defaulted as yes(public) </td> <td>   </td> </tr> <tr> <td> Passwordenabled </td> <td> Boolean </td> <td> no </td> <td> Whether the password is started, defaulted as yes(started) </td> <td>   </td> </tr> <tr> <td> Requireshvm </td> <td> Boolean </td> <td> no </td> <td> Whether need HVM or not, defaulted as no (HVM not required) </td> <td>   </td> </tr> <tr> <td> Isdynamicallyscalable </td> <td> Boolean </td> <td> no </td> <td> Whether it is dynamically extended, defaulted as yes ( can be dynamically extended) </td> <td>   </td> </tr> <tr> <td> IsAgent </td> <td> Boolean </td> <td> no </td> <td> Whether start host machine function, defaulted as yes (start host machine function) </td> <td>   </td> </tr> <tr> <td> Format </td> <td> String </td> <td> no </td> <td> File type, defaulted as QCOW2 the values are as follows: QCOW2, RAW, VHD and OVA </td> <td>   </td> </tr> <tr> <td> Checksum </td> <td> String </td> <td> no </td> <td> MD5 </td> <td>   </td> </tr> <tr> <td> Isextractable </td> <td> Boolean </td> <td> no </td> <td> Whether can be extracted, defaulted as yes ( can be extracted) </td> <td>   </td> </tr> <tr> <td> Isrouting </td> <td> Boolean </td> <td> no </td> <td> Whether can be routed, defaulted as no ( no routing) </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>   7.  ModifyImageAttribute Interface Description Modify image attribute according to image id.  Need to get the token by logging in for authentication. Query all the image by ListImages interface 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> Image Id Must be uploaded Can list all the images by ListImages interface </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of image in portal interface  The longest length is 20, or it will throw ParameterValidate 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>   8.  BatchDestroyInstance Interface Description To destroy ECS in batches 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> Ids </td> <td> String </td> <td> yes </td> <td> ECS Id, Multiple host machine ids need to be concatenated by strings, separated by commas (, ) in English  Can see all the ECS ids 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> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   9.  BatchStartInstance Interface Description To destroy ECS in batches 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> Ids </td> <td> String </td> <td> yes </td> <td> ECS Id, Multiple host machine ids need to be concatenated by strings, separated by commas (, ) in English  Can see all the ECS ids 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> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   10.   BatchStopInstance Interface Description To stop ECS in batches 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> Ids </td> <td> String </td> <td> yes </td> <td> ECS Id, Multiple host machine ids need to be concatenated by strings, separated by commas (, ) in English  Can see all the ECS ids 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> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   11.   CheckInstanceName Interface Description Check the uniqueness of users’ customized ECS name 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> Names </td> <td> String </td> <td> yes </td> <td> ECS Id, Multiple host machine ids need to be concatenated by strings, separated by English comma (,).  User-defined host machine names cannot already exist and can only consist of numbers, letters and dashes. The first must be English letters with a minimum length of 1 and a maximum length of 45 characters. </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>   12. DestroyInstance Interface Description Destroy Instance 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> ECS Id needs to be released can be checked by interface ListInstance </td> <td>   </td> </tr> <tr> <td> CheckDependency </td> <td> Boolean </td> <td> no </td> <td> Whether to check the resource dependency relationship when releasing ECS. yes: when releasing host machine, verify the resource dependency relationship. if there are dependent resources, you need to delete the dependent resources before releasing the host machine   no: when releasing the host machine, the default value for not checking the resource dependency relationship is 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>   13. DowngradeInstance Interface Description Downgrade ECS 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> ECS Id  Can check all the ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> NewInstanceType </td> <td> String </td> <td> yes </td> <td> Upgraded ECS type  Can list all product series by ListProductSeries interface. </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> no </td> <td> Coupon Id Can list by listAvailableCoupons method by payment service </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> no </td> <td> The number of periods, the minimum is 1 and the maximum is 36  only needs to be uploaded by monthly-paid host machine, and the number of periods is queried by the GetRemainMonth 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> ProductCode </td> <td> String </td> <td> Product code </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 </td> <td>   </td> </tr> </tbody> </table>   14.   GetAllEcsSummary Interface Description Get all ECS summary 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> no </td> <td> Region Id  Can list region information by ListIRegions 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> InstanceSum </td> <td> Long </td> <td> Total amount of ECS </td> <td>   </td> </tr> <tr> <td> RunningInstanceSum </td> <td> Long </td> <td> Total amount of ECS in running </td> <td>   </td> </tr> <tr> <td> StoppedInstanceSum </td> <td> Long </td> <td> Total amount of ECS shut down </td> <td>   </td> </tr> <tr> <td> MonthlyInstanceSum </td> <td> Long </td> <td> Total amount of ECS paid by month </td> <td>   </td> </tr> <tr> <td> ExpiredInstanceSum </td> <td> Long </td> <td> Total amount of ECS expired </td> <td>   </td> </tr> <tr> <td> WillexpireInstanceSum </td> <td> Long </td> <td> Total amount of ECS about to expire </td> <td>   </td> </tr> <tr> <td> DiskSum </td> <td> Long </td> <td> Total amount of EBS </td> <td>   </td> </tr> <tr> <td> SnapshotSum </td> <td> Long </td> <td> Total amount of snapshots </td> <td>   </td> </tr> <tr> <td> ImageSum </td> <td> Long </td> <td> Total amount of image </td> <td>   </td> </tr> <tr> <td> TotalSeparateInstance </td> <td> Long </td> <td> Number of host machines, disks etc. grouped by region </td> <td>   </td> </tr> <tr> <td> SeparateRegionInstance </td> <td> List<InstanceOverviewBean> </td> <td> Save the amount value of grouping and counting host machines, disks and other resources according to the region </td> <td>   </td> </tr> </tbody> </table>   15. Get ECS summary Interface Description Get ECS summary 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  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> InstanceSum </td> <td> Long </td> <td> Total amount of ECS </td> <td>   </td> </tr> <tr> <td> DiskSum </td> <td> Long </td> <td> Total amount of EBS </td> <td>   </td> </tr> <tr> <td> SnapshotSum </td> <td> Long </td> <td> Total amount of snapshots </td> <td>   </td> </tr> </tbody> </table>   16.   GetInstance Interface Description Get ECS information 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> ECS Id  Can list all ECS host machine ids by ListInstance 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> InstanceDetail </td> <td> InstanceDetailBean </td> <td> ECS detail information </td> <td>   </td> </tr> </tbody> </table>   17. GetInstancePassword Interface Description Get ECS password 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> ECS Id that need to get password </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> Password </td> <td> String </td> <td> Password </td> <td>   </td> </tr> </tbody> </table>   18. InstanceExport Interface Description Export instance information to Excel document 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> RowNames </td> <td> String[] </td> <td> yes </td> <td> Field name of the exported host machine information. Can be queried by the ListExcelTitleKeys interface.Parameter productCode: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>   19. ListAbleKeyRelateInstancs Interface Description List available key related ECS 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> Name </td> <td> String </td> <td> no </td> <td> ECS name </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> no </td> <td> Private network address </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id  Can list region information by ListRegions interface </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> no </td> <td> Available zone name  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> no </td> <td> ImageId   Can list image information by Listimages Interface. </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> no </td> <td> Image name  Can list image information by ListImages Interface. </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> no </td> <td> Network region Id  Can list network region information by ListNetworks Interface. </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> no </td> <td> Network region name   Can list network region information by ListNetworks Interface. </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> no </td> <td> Creator name </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number, defaulted as 1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size, defaulted as 10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sorting by key words  defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type  order types are DESC and ASC, defaulted as DESC order </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> no </td> <td> ECS Status, please check Enum TypesInstanceStatus for rangement </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> Whether it is a dedicated host machine or not, please check the range of values by ENUM Typesinstancategory   Defaulted as shared ECS if it is not uploaded, and the value is InstanceCategory.Ecs | InstanceCategory.Caas </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> no </td> <td> Charge type, check Enum TypesChargeType for details </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>   20. ListExpiredInstance Interface Description List expired instance 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> no </td> <td> Region Id </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page 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> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> List of ECS instance information </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total numbers of ECS instances </td> <td>   </td> </tr> </tbody> </table>   21. ListExpiringInstance Interface Description List expiring instance 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> no </td> <td> Region Id </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page 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> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> List of ECS instance information </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total numbers of ECS instances </td> <td>   </td> </tr> </tbody> </table>   22. ListInstanceDependencies Interface Description List instance dependencies 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> ECS uuid。 </td> <td>   </td> </tr> <tr> <td> IsDeleteFollowInstance </td> <td> Boolean </td> <td> no </td> <td> Whether the resource to be queried is deleted with the deletion of the cloud host. When the value is null, it means that all dependent resources are queried. </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> DependentInfoList </td> <td> List<DependentInfoBean> </td> <td> List of ECS dependencies </td> <td>   </td> </tr> <tr> <td> IsDeleteFollowInstance </td> <td> Boolean </td> <td> Whether the resource to be queried is deleted with the deletion of the cloud host. </td> <td>   </td> </tr> </tbody> </table>   23. ListInstanceTypes Interface Description List ECS type 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> PodId </td> <td> String </td> <td> no </td> <td> High available zone Id  If the host machine product specification Id does not exist, then ZoneId or PodId must exist, and only PodId is valid when both exist  Available zone information can be queried by the ListPods interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id  If the host machine product specification Id does not exist, then ZoneId or PodId must exist, and only PodId is valid when both exist  Available zone information can be queried by the ListZones interface. </td> <td>   </td> </tr> <tr> <td> MemoryCpuScale </td> <td> Integer </td> <td> no </td> <td> Cpu frequency doubling </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> no </td> <td> ECS product type Id  Can list ECS product type by ListInstanceTypes interface. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Product series name   Can list ECS product series by ListInstanceTypes interface. </td> <td>   </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> yes </td> <td> Product series name   Can list ECS product series by ListInstanceTypes 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> InstanceTypes </td> <td> List<InstanceTypeBean> </td> <td> ECS type information list </td> <td>   </td> </tr> </tbody> </table>   24. ListInstances Interface Description List ECS 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> Id </td> <td> String </td> <td> no </td> <td> ECS ip  ECS id   Can list all ECS ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> ECS name </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> no </td> <td> Private Ip address </td> <td>   </td> </tr> <tr> <td> PublicIpAddress </td> <td> String </td> <td> no </td> <td> Public address </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id  Can list region information by ListRegions interface </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> no </td> <td> Available zone name  Can list available zone information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> VpcId </td> <td> String </td> <td> no </td> <td> VPC Id  Can list VPC information by ListVpcs interface. </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> no </td> <td> ECS type </td> <td>   </td> </tr> <tr> <td> ResourceGroupId </td> <td> String </td> <td> no </td> <td> Resource group Id customized by users </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> no </td> <td> Security group Id  Can list security group information  by ListSecurityGroups interface. </td> <td>   </td> </tr> <tr> <td> NotSecurityGroupId </td> <td> String </td> <td> no </td> <td> Security Group Id outside the scope of this Security Group Id  Can list security group information by ListSecurityGroups interface. </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> no </td> <td> ImageId   Can list image information by Listimages Interface. </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> no </td> <td> Image name  Can list image information by ListImages Interface. </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> no </td> <td> Subnet Id Can list subnet information by ListSubnets interface. </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> no </td> <td> Network region Id  Can list network region information by ListNetworks Interface. </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> no </td> <td> Network region name   Can list network region information by ListNetworks Interface. </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> no </td> <td> Creator’s name </td> <td>   </td> </tr> <tr> <td> NetworkType </td> <td> NetworkType </td> <td> no </td> <td> Network region type   Please check Enum TypesNetworkType for details </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number, defaulted as 1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size, defaulted as 10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sorting by key words  defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type  order types are DESC and ASC, defaulted as DESC order </td> <td>   </td> </tr> <tr> <td> status </td> <td> InstanceStatus[] </td> <td> no </td> <td> ECS Status, please check Enum TypesInstanceStatus for rangement </td> <td>   </td> </tr> <tr> <td> ErrorFlag </td> <td> InstanceErrorStatus[] </td> <td> no </td> <td> ECS error instance Status, please check Enum TypesInstanceStatus for rangement </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String[] </td> <td> no </td> <td> Tag list Can list all the tags by ListTages </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> Whether it is normal ECS, defaulted unload as normal ECS, value as Ecs and Caas with the value rangement as {Ecs, Caas, Dedicated, AutoScaling, GBD, FORTRESS} </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> no </td> <td> Charge type, please check Enum TypesInstanceStatus for rangement </td> <td>   </td> </tr> <tr> <td> VmHostName </td> <td> String </td> <td> no </td> <td> Name if virtual host machine </td> <td>   </td> </tr> <tr> <td> CreateEip </td> <td> boolean </td> <td> no </td> <td> Check whether ECS create eip If it is yes, then need to filter instance according to eipStatus, or do not filter </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>   25.   ListKeyRelatedInstance Interface Description List ECS that can destroy bound secret key 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> KeyId </td> <td> String </td> <td> yes </td> <td> key id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> ECS name </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> no </td> <td> Private Ip address </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> no </td> <td> Available zone name </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> no </td> <td> Image Id </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> no </td> <td> Image name </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> no </td> <td> Network region Id </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> no </td> <td> Network region name </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> no </td> <td> Creator name </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sorting by key words  defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type  order types are DESC and ASC, defaulted as DESC order </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> no </td> <td> ECS Status </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> no </td> <td> Whether it is dedicated host machine, defaulted unloaded as shared ECS host machine, which valued as InstanceCategory.Ecs | InstanceCategory.Caas </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> String </td> <td> no </td> <td> Charge type </td> <td>   </td> </tr> <tr> <td> ShowAll </td> <td> Boolean </td> <td> no </td> <td> Whether to show all </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>   26. ModifyChargeType Interface Description Modify to change type to monthly payment 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> ECS Id  Can list all the ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> yes </td> <td> The number of periods, the minimum is 1 and the maximum is 36 </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> yes </td> <td> Whether renewed automatically </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> 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 </td> <td>   </td> </tr> </tbody> </table>   27. ModifyInstanceAttribute Interface Description Modify ECS attribute 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> ECS Id  Can list all ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> ECS display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException 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>   28. OpenConsole Interface Description Open console 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> InstanceId </td> <td> String </td> <td> yes </td> <td> ECS Id </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> ConsoleHttpUrl </td> <td> String </td> <td> ECS console address </td> <td>   </td> </tr> </tbody> </table>   29. RenewInstance Interface Description Renew ECS 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> ECS Id </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> yes </td> <td> Periods of renewal, the minimum is 1 and the maximum is 36 </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> 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 </td> <td>   </td> </tr> </tbody> </table>   30. ResetPasswordForInstance Interface Description Reset password for ECS 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> ECS Id </td> <td>   </td> </tr> <tr> <td> GeneratePasswordType </td> <td> GeneratePasswordType </td> <td> yes </td> <td> ECS password type generating method,defaulted as generated randomly Please check the Enum TypesGeneratePasswordType for details </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> no </td> <td> Customized password, if the generated method of code is Custom (customized), then keyId is must be uploaded </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>   31. RestartInstance Interface Description Restart ECS 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> ECS Id  Can list all ECS host machine ids by ListInstance 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> Job Id </td> <td>   </td> </tr> </tbody> </table>   32. RestoreInstance Interface Description Restore ECS 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> ECS Id  Can list all the ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td>   </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>   33. RunInstances Interface Description Run ECS 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  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  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> yes </td> <td> High available zone Id  Can list available zone information by ListZones interface. </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> yes </td> <td> ECS product type Id  Can list ECS product specification information by ListInstanceTypes interface. </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> yes </td> <td> Network region Id  Can list network region information by ListNetworks Interface. </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> no </td> <td> Subnet Id Can list subnet information by ListSubnets interface. </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> yes </td> <td> ImageId   Can list image information by Listimages Interface. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> ECS display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException exception. </td> <td>   </td> </tr> <tr> <td> ResourceGroupId </td> <td> String </td> <td> no </td> <td> Resource group Id </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> no </td> <td> Amount of creating ECS, defaulted as 1 </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> no </td> <td> Charge type, please check Enum TypesInstanceStatus for rangement </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> no </td> <td> The number of periods, the minimum is 1 and the maximum is 36 </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> no </td> <td> EBS type can query EBS information by ListAllEbsTypes interface. </td> <td>   </td> </tr> <tr> <td> DiskSizes </td> <td> Integer[] </td> <td> no </td> <td> List of disk size The largest size of each disk is 2000G </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> no </td> <td> Tags Can list all the tags by ListTags interface or customize tags and key value pair, the longest length of key and value is 45 </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> no </td> <td> Security group Id  Can list security group information  by ListSecurityGroups interface. </td> <td>   </td> </tr> <tr> <td> VmhostNames </td> <td> String[] </td> <td> no </td> <td> User ECS host machine name  Each host machine name start with letters, letters, numbers, -, the longest length to display name is 45 digits Multiple host machine names can be separated by English comma </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> no </td> <td> Whether renewal is automatically  yes is automatically renew no is not </td> <td>   </td> </tr> <tr> <td> GeneratePasswordType </td> <td> GeneratePasswordType </td> <td> no </td> <td> ECS password type generating method,defaulted as generated randomly Please check the Enum TypesGeneratePasswordType for details </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> no </td> <td> Secret key id, if the password generated method is Key (secret key pair), then keyId is must uploaded parameter  Can list secret key information by ListKey. </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> no </td> <td> Customized password,  if the password generated method is Custom (customized), then customPassword must be uploaded </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> 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 </td> <td>   </td> </tr> </tbody> </table>   34. StartInstance Interface Description Start ECS 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> ECS Id  Can list all the ECS host machine ids by ListInstance 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> Job Id </td> <td>   </td> </tr> </tbody> </table>   35. StopInstance Interface Description Stop ECS 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> ECS Id  Can list all the ECS host machine ids by ListInstance 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> Job Id </td> <td>   </td> </tr> </tbody> </table>   36. UpdateInstanceAutoRenewFlag Interface Description Modify ECS charges to be renew automatically or notmanual renewal. Only valid when the ECS is in monthly payment. 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> ECS Id  Can list all the ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> yes </td> <td> Whether renewal is automatically  yes is automatically renew no is not </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>   37. UpdateInstanceName Interface Description Update user’s customized ECS name, Only ESC with Status of shut down can be changed.. 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> Name </td> <td> String </td> <td> yes </td> <td> ECS name, ECS name must be unique and can only consist of numbers, letters and dashes. The first must be English letters with a minimum length of 1 and a maximum length of 45 characters. </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> ECS Id  Can list all the ECS host machine ids by ListInstance 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>   38. UpgradeInstance Interface Description Upgraded ECS 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> ECS Id  Can list all the ECS host machine ids by ListInstance interface </td> <td>   </td> </tr> <tr> <td> NewInstanceType </td> <td> String </td> <td> yes </td> <td> Upgraded ECS type  Can list all product series by ListProductSeries interface. </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> no </td> <td> Coupon Id Can list by listAvailableCoupons method by payment service </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> no </td> <td> The number of periods, the minimum is 1 and the maximum is 36  only needs to be uploaded by monthly-paid host machine, and the number of periods is queried by the GetRemainMonth 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> ProductCode </td> <td> String </td> <td> Product code </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 </td> <td>   </td> </tr> </tbody> </table>   39. CreateKey Interface Description Create secret key pair. Create secret key needs to get the token by logging in for authentication. Calling createKey by using corresponding DTO to create secret key. Associated instance operations can be made aAfter the creation of creating secret key normal operations can be performed on the instance. 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> DisplayName </td> <td> String </td> <td> no </td> <td> Secret key Description, the longest length is 20 </td> <td>   </td> </tr> <tr> <td> KeyType </td> <td> KeyType </td> <td> yes </td> <td> Generation type. When KeyType is IMPORT, PublicKey is must be filled which has two types:   IMPORT: import existed   AUTO: automatic </td> <td>   </td> </tr> <tr> <td> PublicKey </td> <td> String </td> <td> no </td> <td> Public key   When KeyType is IMPORT, PublicKey is must be filled  The length cannot exceed 1024 digits  Need to import public key that meet Base64 code format </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id RegionId determines where the EBS user created located, such as Huadong.  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> Key </td> <td> KeyBean </td> <td> Secret key pair information </td> <td>   </td> </tr> </tbody> </table>   40. CreateKeyRelatedInstance Interface Description Create ECS related secret key pairs. Create ECS related secret key pairs needs to get the token by logging in for authentication. Can list instance that can be associated instance by ListAbleKeyRelateInstancs interface. Need to send short message when relateassociating an instance.  When creating, it is important to note that if ECS has expired and reaches the forced shutdown time, the ECS will not be allowed to have a key pair relationship once it shut down for a month. 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> InstanceIds </td> <td> String </td> <td> yes </td> <td> ECS Id, uuid corresponded to ECS  Can get ECS instance information by ListInstances interface. </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> yes </td> <td> Key id  Can list secret key pair information by ListVpcs 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> SuccNum </td> <td> int </td> <td> Numbers of success </td> <td>   </td> </tr> <tr> <td> ErrorNum </td> <td> int </td> <td> Number of error </td> <td>   </td> </tr> <tr> <td> ErrorMsg </td> <td> List<String> </td> <td> Context of error </td> <td>   </td> </tr> </tbody> </table>   41. DeleteKey Interface Description Delete secret key pair. Delete secret key pair needs to get the token by logging in for authentication. Get the secret key pair by getting the id of secret key, and then calling deleteKey to delete secret key pair. The interface is asynchronous job creation. Check whether the deletion is successful. 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> KeyId </td> <td> String </td> <td> yes </td> <td> Key id, id value of secret key pair. Can get secret key pair information by ListKey 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> Job Id </td> <td>   </td> </tr> </tbody> </table>   42. DeleteKeyRelatedInstance Interface Description Delete ECS relation secret key pair. Call ListKeyRelatedInstance interface Be able to list the associated instance that can be cancelled to associate by ListKeyRelatedInstance interface. Deleteion of ECS relatedion secret key pair 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> InstanceIds </td> <td> String </td> <td> yes </td> <td> ECS Id Can get ECS instance information by ListInstances interface. </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> yes </td> <td> key Id  Can list secret key pair information by ListKey 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> SuccNum </td> <td> int </td> <td> Numbers of success </td> <td>   </td> </tr> <tr> <td> ErrorNum </td> <td> int </td> <td> Number of error </td> <td>   </td> </tr> <tr> <td> ErrorMsg </td> <td> List<String> </td> <td> Context of error </td> <td>   </td> </tr> </tbody> </table>   43. ListKey Interface Description Listing of tenant secret key information by page. Page listing the secret key information under the tenant need to get the token by logging in for authentication. Pay attentionPlease take note that when calling findAllByTenant to list information. Calling interface by using corresponding DTO: 1, the interface executed by page query with the default page 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 RegionId determines where the EBS user created located, such as Huadong 1.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name name of secret key generated automatically by CreateKey interface </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Order by keywords. Used in page query.  Defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type. Used in page query. Order types are DESC and ASC, defaulted as DESC order </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number. Used in page query.  Defaulted as 1 if do not load. </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size. Used in page query.  Defaulted as 1000 if do not load. </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> Keys </td> <td> List<KeyBean> </td> <td> Key information list </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount </td> <td>   </td> </tr> </tbody> </table>   44. AddInstanceToSecurityGroup Interface Description Add ECS to security group. Add security group rule need to get the token by logging in for authentication. ECS information can be checked by calling ListInstances. Security group information can be checked by calling ListSecurityGroups interface.  Please take note that when calling interfaces:  （1）the security group and ECS must be in the same Internet region, or InvalidParameterException exception will be thrown. （2）security groups bound to ECS cannot exceed three, or LimitExceededException exception will be thrown. 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> InstanceId </td> <td> String </td> <td> yes </td> <td> ECS Id, only host machines in the same network region  can join the security group and query all ECS information by ListInstances interface </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> yes </td> <td> Security group Id  Can list security group information  by ListSecurityGroups 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> </tbody> </table>   45. AddSecurityGroupRule Interface Description Add security group rule to security group. Add security group rule to security group that need to get the token by logging in for authentication. Security group rule information can be checked by calling ListSecurityGroupRules interface. Security group information can be checked by calling ListSecurityGroups interface. 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> SecurityGroupId </td> <td> String </td> <td> yes </td> <td> Add security group Id of security group rules   Security group information can be listed by calling ListSecurityGroups interface </td> <td>   </td> </tr> <tr> <td> Direction </td> <td> DirectionType </td> <td> yes </td> <td> Direction type, for example:    In in OUT out </td> <td>   </td> </tr> <tr> <td> Cidr </td> <td> String </td> <td> yes </td> <td> Ip address authorized </td> <td>   </td> </tr> <tr> <td> Port </td> <td> String </td> <td> no </td> <td> Port This parameter is not required when protocol selects ALL or ICMP protocol, it  is required when TCP/HTTP is selected </td> <td>   </td> </tr> <tr> <td> Protocol </td> <td> ProtocolType </td> <td> yes </td> <td> Protocol type, such as: ALL, TCP, UDP, ICMP must be filled </td> <td>   </td> </tr> <tr> <td> IcmpCode </td> <td> String </td> <td> no </td> <td> Code of ICMP </td> <td>   </td> </tr> <tr> <td> IcmpType </td> <td> String </td> <td> no </td> <td> ICMP type </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> SecurityGroupRule </td> <td> SecurityGroupRuleBean </td> <td> Security group rules information </td> <td>   </td> </tr> </tbody> </table>   46. CreateSecurityGroup Interface Description Create security group needs to get the token by logging in for authentication. The interface to create the subnet is CreateSubnet.  The interface to query subnet is ListSubnets. Please take note that when calling interface. 1) there must be at least one subnet to create security group 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> NetworkId </td> <td> String </td> <td> yes </td> <td> Create network region Id security group belongs to </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> false </td> <td> Display name of security group in portal interface  The longest length is 20, or it will throw ParameterValidate 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> <tr> <td> SecurityGroup </td> <td> SecurityGroupBean </td> <td> Security group details </td> <td>   </td> </tr> </tbody> </table>   47. DeleteSecurityGroup Interface Description Delete security group by security group id. Need to get the token by logging in for authentication.  Delete security group needs to verify whether there is resource dependence, if it is, the security group should be deleted by relieving dependent resource. 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> Security group Id verified  Can list security group information by ListSecurityGroups 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> </tbody> </table>   48. ListSecurityGroupRules Interface Description List security group rules 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> Security group Id one security group rule can has multiple corresponding security groups </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> yes </td> <td> Security group Id can list security group information  by calling ListSecurityGroups </td> <td>   </td> </tr> <tr> <td> Direction </td> <td> DirectionType </td> <td> no </td> <td> Direction of security group rules, for example:    IN= direction of entry, OUT= direction of out </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> SecurityGroupRules </td> <td> List<SecurityGroupRuleBean> </td> <td> List security group rules information </td> <td>   </td> </tr> </tbody> </table>   49. ListSecurityGroups Interface Description List security groups. Please take note that when calling interface: 1, the interface is used page query with its default page is 1, 3000 rows of data is most that 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> Id </td> <td> String </td> <td> no </td> <td> Security group Id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Security group name </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of security group The longest length of name can be displayed is 20. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id that security group belongs to.  Region Id determines where the EBS user created located, such as Huadong 1.  Can list region information by ListRegions interface. </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> no </td> <td> ECS instance Id.  ECS instance Id determines which ECS instance the security group queried attached.  Can list region information by ListInstances interface. </td> <td>   </td> </tr> <tr> <td> VpcId </td> <td> String </td> <td> no </td> <td> VPC Id VPC Id determines which VPC the security group queried attached.  Can list vpc information by ListVpcs interface </td> <td>   </td> </tr> <tr> <td> VpcName </td> <td> String </td> <td> no </td> <td> VPC name Fuzzy query is performed according to the incoming name, and all is queried when it is not found. </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> no </td> <td> Network region name Fuzzy query is performed according to the incoming name, and all is queried when it is not found. </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> no </td> <td> Network region Id  networkId determines which network region the security group attached Can list network region information by ListNetworks interface. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number needed in page display </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page size needed in page display </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> SecurityGroups </td> <td> List<SecurityGroupBean> </td> <td> Security group information list </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount of security group information list </td> <td>   </td> </tr> </tbody> </table>   50. ModifySecurityGroupAttribute Interface Description Modify security group attribute by security group id. Security group information can be listed by calling ListSecurityGroups interface 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> Security group id need to be modified  Security group information can be listed by calling ListSecurityGroups interface </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of security group in portal interface  The longest length is 20, or it will throw ParameterValidate 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>   51. RemoveInstanceFromSecurityGroup Interface Description Remove ECS from security group. Adding security group rules need to get the token by logging in for authentication. ECS information can be listed by calling ListInstances interface. Security group information can be listed by calling ListSecurityGroups interface 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> InstanceId </td> <td> String </td> <td> yes </td> <td> ECS Id deleted can list ECS information by calling ListInstances interface </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> yes </td> <td> Security group id  can list security group information by calling ListSecurityGroups </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>   52. RemoveSecurityGroupRule Interface Description Remove security group rule by security group rules id. Security group rules information can be listed by ListSecurityGroupRules 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> Security group rules id need to be deleted  Security group rules information can be listed by ListSecurityGroupRules </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>   53. CreateEbsRelatedPolicy Interface Description Create related policy between disk and snapshot policy. Create related policy between disk and snapshot policy need to get the token by logging in for authentication. List snapshot policy by ListAllSnapshotPolicies interface to operate related EBS.  If the snapshot policy is null, then the exception will be thrown that snapshot policy is nonexistent. And the related disk to create the snapshot policy of disk cannot exceed 8, or it will throw exception. 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> EbsIds </td> <td> String </td> <td> yes </td> <td> EBS Id that needed to associated relation the longest length is 36 </td> <td>   </td> </tr> <tr> <td> SnapshotPolicyId </td> <td> String </td> <td> yes </td> <td> Snapshot policy Id Can get snapshot policy by ListAllSnapshotPolicies interface.  the longest length is 36 </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> SuccNum </td> <td> int </td> <td> Numbers of Success </td> <td>   </td> </tr> <tr> <td> ErrorNum </td> <td> int </td> <td> Number of error </td> <td>   </td> </tr> <tr> <td> ErrorMsg </td> <td> List<String> </td> <td> Error context </td> <td>   </td> </tr> </tbody> </table>   54. CreateSnapshot Interface Description Create snapshot. Create snapshot needs to get the token by logging in for authentication.   List snapshot by ListDisks interface and then proceed to create snapshot.  If ECS is expired or and has reached to the forced shut off time, once it has stopped, snapshot is not allowed to create. 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. Can list disk information by ListDisks interface. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Snapshot display name. The longest length of name displayed is 20, if exceed, it will throw PacloudException 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> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   55. CreateSnapshotPolicy Interface Description Create snapshot policy. Create snapshot policy needs to get the token by logging in for authentication. Please take note that that the maximum number of reserved copies cannot exceed 8 when creating snapshot policy. Create snapshot by createSnapshotPolicy method with corresponding DTO. 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> no </td> <td> EBS Id can list disk information by ListDisks interface. </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> yes </td> <td> Interval interval has 5 types:    MANUAL: manual    HOURLY: hourly    DAILY: daily WEEKLY: weekly    MONTHLY: monthly </td> <td>   </td> </tr> <tr> <td> Schedule </td> <td> String </td> <td> yes </td> <td> Time the longest length is 30 </td> <td>   </td> </tr> <tr> <td> MaxSnaps </td> <td> Integer </td> <td> yes </td> <td> The maximum number of  copies reserved which cannot exceed 8. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Policy display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException exception. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region ID RegionId determines where the EBS user created located, such as Huadong 1.  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> SnapshotPolicy </td> <td> SnapshotPolicyBean </td> <td> bena object of snapshot policy </td> <td>   </td> </tr> </tbody> </table>   56. DeleteEbsRelatedPolicy Interface Description Delete related policy between disk and policy. Delete related policy between disk and policy needs to get the token by logging in for authentication. Delete relation by calling getDisk interface for a disk details listing. Delete relation by getting snapshot policy corresponded to disk with the method of deleteEbsRelatedPolicy method The interface is asynchronous job deletion. Check whether the relation between disk and policy is succeessful. 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> RelatedId </td> <td> String </td> <td> yes </td> <td> Snapshot policy Id snapshot policy id that need to release relationship  the longest length is 36 </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>   57. DeleteSnapshot Interface Description Delete snapshot Delete snapshot needs to get the token by logging in for authentication.   List snapshot by ListAllSnapshots to delete. Delete snapshot by get the id of snapshot to call deleteSnapshotJob method. The interface is asynchronous job deletion. Check whether the snapshot is deleted 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> Snapshot Id can list snapshot information by ListAllSnapshots interface.  the longest length is 36 </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>   58. DeleteSnapshotPolicy Interface Description Delete snapshot policy. Delete snapshot policy needs to get the token by logging in for authentication. List snapshot policy by ListAllSnapshotPolicies interface to delete.  Please take note of the resource dependency before deleting. Need to disassociate by listing disk information through getDisk interface to delete.  Get the id of corresponding snapshot policy, and then delete snapshot policy by calling deleteSnapshotPolicy 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> Snapshot policy Id Can get snapshot policy information by ListAllSnapshotPolicies interface  the longest length is 36 </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>   59. GetSnapshotPolicy Interface Description Get snapshot policy. Need to get the token by logging in for authentication. List snapshot policy to execute by ListAllSnapshotPolicies interface. List snapshot policy by the id of snapshot policy 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> Disk snapshot policy Id the longest length is 36 </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> SnapshotPolicyDetailBean </td> <td> SnapshotPolicyDetailBean </td> <td> Snapshot policy information </td> <td>   </td> </tr> </tbody> </table>   60. ListAllSnapshotPolicies Interface Description List all snapshot policies. Need to get the token by logging in for authentication. Please take note that when calling interface: 1, the interface is executed by page query with the default page is 1, 10 rows of data will be displayed in each page.   List all the snapshot policy by findAllByTenant method, sorting order, display amount in each page, pages displayed. 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> OrderBy </td> <td> String </td> <td> no </td> <td> Order by keywords. Used in page query.  Defaulted sorting by time </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Order type. Used in page query.  Order types are DESC and ASC, defaulted as DESC order </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> RegionId </td> <td> String </td> <td> yes </td> <td> Region RegionId determines where the EBS user created located, such as Huadong 1.  Can list region information by ListRegions interface.  the longest length is 36 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Snapshot policy name the longest length is 45 </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> no </td> <td> Interval interval has 5 types:    MANUAL: manual    HOURLY: hourly    DAILY: daily WEEKLY: weekly    MONTHLY: monthly </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> SnapshotPolicies </td> <td> List<SnapshotPolicyBean> </td> <td> Snapshot policy information list, details for shapshot </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount, how many snapshots in total </td> <td>   </td> </tr> </tbody> </table>   61. ListAllSnapshots Interface Description List all snapshot. List all snapshot information needs to get the token by logging in for authentication. Please take note that when calling interface: 1, the interface executed by page query with the default page 1, 10 rows of data will be displayed in each page.   List all the snapshot policy by findAllByTenant method, sorting order, display amount of each page, pages displayed. 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> OrderBy </td> <td> String </td> <td> no </td> <td> Sort by key words Used in page query.  Sorting by time as default </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sorting order Used in page query.  Order types are DESC and ASC, defaulted as DESC order </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> RegionId </td> <td> String </td> <td> yes </td> <td> Region RegionId determines where the EBS user created located, such as Huadong 1.  Can list region information by ListRegions interface.  the longest length is 36 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Snapshot name  the longest length is 255 </td> <td>   </td> </tr> <tr> <td> EbsName </td> <td> String </td> <td> no </td> <td> EBS name the longest length is 45 </td> <td>   </td> </tr> <tr> <td> status </td> <td> SnapshotStatus[] </td> <td> no </td> <td> The snapshot Status type array has the following values:    ToCreate: to create   Pending:pending   CreateFailed: create failed   Available: available   Unavailable: unavailable   Deleting: deleting   Deleted: deleted   DeleteFailed: delete failed </td> <td>   </td> </tr> <tr> <td> Type </td> <td> String </td> <td> no </td> <td> Snapshot types  the longest length is 20 </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> no </td> <td> EBS product specification, the longest length is 10 </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> Snapshots </td> <td> List<SnapshotBean> </td> <td> Snapshot information list, set of each piece of snapshot </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount, total amount of snapshot information listed </td> <td>   </td> </tr> </tbody> </table>   62. ListSnapshotPolicies Interface Description List snapshot policy. List snapshot policy needs to get the token by login authentication.   List ECS by calling GetDisk interface. Used to list associated snapshot policy. List snapshot policy under this disk by findRelatedPolicyByEbsId method provided by disk 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> EbsId </td> <td> String </td> <td> yes </td> <td> EBS Id the longest length is 36 </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> SnapshotPolicies </td> <td> List<SnapshotPolicyBean> </td> <td> Snapshot policy information list, details for snapshot </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount, how many snapshots in total </td> <td>   </td> </tr> </tbody> </table>   63. ListSnapshots Interface Description List snapshot List snapshot policy needs to get the token by logging in for authentication.  List EBS by calling GetDisk interface. Used to list associated snapshot policy. List snapshot policy under this disk by querySnapshotsPolicy method provided by disk 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> EbsId </td> <td> String </td> <td> yes </td> <td> EBS Id the longest length is 36 </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> Snapshots </td> <td> List<SnapshotBean> </td> <td> Snapshot information list, set of each piece of snapshot </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Total amount, total amount of snapshot information listed </td> <td>   </td> </tr> </tbody> </table>   64. ModifySnapshotAttribute Interface Description Modify snapshot attribute. Modify snapshot attribute need to get the token by login authentication. Modify the name Description after list snapshot by ListAllSnapshots interface.   List corresponding snapshot by id provided, and then update snapshot attribute that need to be modified. 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> Snapshot Id List snapshot information by ListAllSnapshots interface.  the longest length is 36 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Snapshot display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException 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>   65. ModifySnapshotPolicyAttribute Interface Description Modify snapshot policy attribute. Modify snapshot policy attribute needs to get the token by login authentication. Modify snapshot policy after listing it by ListAllSnapshots interface.   List corresponding snapshot by id provided, and then update snapshot policy attribute that need to be modified. 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> Snapshot policy Id Can get snapshot policy by ListAllSnapshotPolicies interface  the longest length is 36 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Snapshot display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException exception. </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> yes </td> <td> Interval interval has 5 types:    MANUAL: manual    HOURLY: hourly    DAILY: daily WEEKLY: weekly    MONTHLY: monthly </td> <td>   </td> </tr> <tr> <td> Schedule </td> <td> String </td> <td> yes </td> <td> Time the longest length is 30 </td> <td>   </td> </tr> <tr> <td> MaxSnaps </td> <td> Integer </td> <td> yes </td> <td> Please take note that that the maximum number of reserved copies cannot exceed 8. </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>   66. ModifySnapshotPolicyDisplayName Interface Description Modify snapshot policy Description. Modify snapshot policy Description needs to get the token by logging in for authentication. Modify the name Description after listing snapshot by ListAllSnapshotsPolicies interface. List corresponding snapshot by id provided, and then update snapshot policy Description name properties that need to be modified. 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> Snapshot policy Id Can get snapshot policy by ListAllSnapshotPolicies interface  the longest length is 36 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Snapshot display name  The longest length of name displayed is 20, if exceed, it will throw PacloudException 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>   67. RevertSnapshot Interface Description Revert snapshot. Revert snapshot needs to get the token by logging in for authentication. List snapshot to revert snapshot by ListAllSnapshots.  List snapshot by id and list disk by snapshot.  Then do the judgment.  If ECS is expired and reaches to the forced shut down time, once the monthly-paid EBS shut down, revert disk is not allowed.  One that meet the requirement to revert need to do the revert snapshot by revertSnapshot method. The interface is asynchronous job revert Check whether revert snapshot is succeeded, 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> Snapshot Id snapshot id needed to be reverted the longest length is 36 </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>   68. ListPods Interface Description List high available zone 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> ZoneId </td> <td> String </td> <td> no </td> <td> Available zone Id  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> no </td> <td> High available zone Id  Can list available zone information  by ListZones interface. </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> no </td> <td> Product code can list all the product code by ListProducts 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> Pods </td> <td> List<PodBean> </td> <td> High available zone information list </td> <td>   </td> </tr> </tbody> </table>

Did the above content solve your problem? Yes No