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

API Description

1. AddEfsRule Interface Description This interface is used to attach EFS volumes to cloud hosts instances. Before doing this, you need to create EFS volumes in corresponding Ping An Cloud regions. You can call the ListUnboundInstance to query the list of unbound cloud host instances for specified EFS volumes. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EfsId </td> <td> String </td> <td> yes </td> <td> It specifies EFS volume ID. You can call ListEfs to query the EFS volume list. </td> <td>   </td> </tr> <tr> <td> Instances </td> <td> String </td> <td> yes </td> <td> This interface indicates the instance information. Its type is a string in JSON format, for example: [{"InstanceUuid":"xxx","InstanceName":"xxx","Permission":"xxx"}]. The InstanceUuid indicates the ID of an bound instance，and the InstanceName indicates the instance name, which can be obtained by calling the ListUnboundInstance. The permission indicates whether the cloud host can access EFS volumes. The NFS can be set to rw or ro. The CIFS is set to full_control by default. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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. BreakDPVolume Interface Description This interface is used to break DP volumes. Before breaking DP volumes, you can call the ListEfs to query EFS volumes in specified areas or availability zones. If a DP volume is broken, it is disassociated from its master volume and changed to a master EFS volume. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EfsId </td> <td> String </td> <td> yes </td> <td> It specifies EFS volume ID. You can call the ListEfs to query the EFS volume list. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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. CreateEfsVolume Interface Description This interface is used to create a pay-as-you-go EFS volume. The creation of an EFS volume involves resource accounting. It is recommended that you know the tariff and pricing of the EFS in advance. For details, refer to Tariff and Pricing. Before creating an EFS volume, you can call the GetEfsSizeConfig to query the size of an EFS volume. The NFS protocol is used for cloud hosts with Linux operating system. The CIFS protocol is used for cloud hosts with Windows operating system, which cannot support creating DP Volumes. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> yes </td> <td> It specifies the product sery ID of an EFS volume. You can call the ListProductSeries to obtain product sery list. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> It specifies the zone ID. You can call the ListZones to obtain the availability zone list. </td> <td>   </td> </tr> <tr> <td> ProductSpecId </td> <td> String </td> <td> yes </td> <td> It specifies the product specification ID of EFS volumes. You can call the ListEfsResourceTypes to obtain related product specification list. </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> It specifies EFS volume size. You can call the GetEfsSizeConfig to query the size of EFS volumes that can be created. </td> <td>   </td> </tr> <tr> <td> Instances </td> <td> String </td> <td> yes </td> <td> This interface indicates the instance information. Its type is a string in JSON format, for example: [{"InstanceUuid":"xxx","InstanceName":"xxx","Permission":"xxx"}]. The InstanceUuid indicates the bound instance ID，and the InstanceName indicates the instance name, which can be obtained by calling ListUnboundInstance. The permission indicates whether the cloud host can access EFS volumes. The NFS can be set to rw or ro. The CIFS is set to full_control by default. </td> <td>   </td> </tr> <tr> <td> DstZoneId </td> <td> String </td> <td> no </td> <td> It specifies the zone ID of a DP volume. You can call the ListZone to obtain availability zone list in related regions. An EFS volume and a DP volume belong to the same region. </td> <td>   </td> </tr> </tbody> </table> Response Parameter                           <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> Order ID. </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> Order status. </td> <td>   </td> </tr> </tbody> </table>   4. DeleteEfsRule Interface Description This interface is used to delete EFS volumes for cloud host instances. You can call the ListEfsInstance to query the list of authorized cloud host instances for specified EFS volumes. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EfsInstanceId </td> <td> String </td> <td> yes </td> <td> It specifies the ID of an authorized cloud host instance for an EFS volume. You can call the ListUnboundInstance to query the list of unbound cloud host instances for specified EFS volumes. </td> <td>   </td> </tr> <tr> <td>EfsInstanceType</td> <td>String</td> <td style="width:40px">true</td> <td> Types of instances authorized by the EFS volume： <ul> <li>ECS</li> <li>BMS</li> </ul> </td> <td> </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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>   5. DestroyEfsVolume Interface Description This interface is used to destroy an EFS volumes. The EFS volume is backed up in the DP volume. Once a master EFS volume is destroyed, its slave volume is destroyed even if the break operation is not performed. If a salve EFS volume which has been separated from the DP volume is destroyed, its master EFS volume will not be destroyed. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EfsId </td> <td> String </td> <td> yes </td> <td> It specifies an EFS volume ID. You can call the ListEfs to query EFS volume list. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job ID </td> <td>   </td> </tr> </tbody> </table>   6. GetEfsSizeConfig Interface Description It is used to obtain EFS volume size configuration. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> MinSize </td> <td> String </td> <td> It specifies the minimum size of an EFS volume. </td> <td>   </td> </tr> <tr> <td> MaxSize </td> <td> String </td> <td> It specifies the maximum size of an EFS volume. </td> <td>   </td> </tr> </tbody> </table>   7. ListEfsVolume Interface Description It is used to query the EFS volume list. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> It specifies an region ID which the EFS volume belongs to. You can call the ListRegions to obtain the region list. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> no </td> <td> It specifies the zone ID which the EFS volume belongs to. You can call the ListZones to obtain the zone list. </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> EFS name. </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> no </td> <td> creator name. </td> <td>   </td> </tr> <tr> <td> Status </td> <td> EfsStatus[] </td> <td> no </td> <td> EFS status. </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> It indicates the sort keys, which include the fields name, createDate， and createName. </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> It specifies order type, which includes DESC and ASC. </td> <td>   </td> </tr> <tr> <td> StorageType </td> <td> String </td> <td> no </td> <td> storage type, which includes NAS-MID and NAS-ARC. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Efses </td> <td> List<EfsBean> </td> <td> EFS volume list. </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> total number. </td> <td>   </td> </tr> </tbody> </table>   8. ListEfsAvailableCidrs Interface Description It is used to query CIDR list of available instance IP addresses. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> It specifies an region ID which the EFS volume belongs to. You can call the ListRegion to obtain the region list of EFS volumes. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Cidrs </td> <td> List<EfsInstanceIpBean> </td> <td> It is used to query CIDR list of available instance IP addresses. </td> <td>   </td> </tr> </tbody> </table>   9. ListEfsInstances Interface Description It is used to list EFS volume instances. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EFS volume ID. You can call the ListEfs to query EFS volume list. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EfsInstances </td> <td> List<EfsInstanceBean> </td> <td> It is used to list EFS volume instances. </td> <td>   </td> </tr> </tbody> </table>   10. ListEfsProductSpec Interface Description It is used to list EFS product specification for storage. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> yes </td> <td> It specifies the product sery ID of EFS volumes. You can call the  ListProductSeries to obtain product series. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> It specifies the zone ID. You can call the ListZones to obtain the availability zone list. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> EfsResourceTypes </td> <td> List<EfsResourceTypeBean> </td> <td> It is used to list EFS resource type information. </td> <td>   </td> </tr> </tbody> </table>   11.  ListUnboundInstance Interface Description It is used to list unbound instances for EFS volumes. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> EfsId </td> <td> String </td> <td> no </td> <td> It specifies EFS volume ID. You can call the ListEfs to query EFS volume list. The cloud host information of the selected product series is returned if the  parameter ProductSeriesId is set to null. If the ProductSeriesId is not set to null, the parameter efsId is skipped and cloud host information will not be returned. </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> It specifies the region ID of an EFS volume. You can call the ListRegion to obtain the region list of an EFS volume. </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> no </td> <td> It specifies instance names of cloud hosts. </td> <td>   </td> </tr> <tr> <td> InstanceDisplayName </td> <td> String </td> <td> no </td> <td> It specifies instance display names of cloud hosts. </td> <td>   </td> </tr> <tr> <td> InstanceIp </td> <td> String </td> <td> no </td> <td> It specifies the instance IP of an cloud host. </td> <td>   </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> no </td> <td> It specifies the product sery ID of an EFS volume. You can call the ListProductSeries to obtain product series. The cloud host information of the selected product series is returned if the  parameter efsId is set to null. If the efsId is not set to null, the parameter ProductSeriesId is  skipped and cloud host information is not returned. </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> It specifies sort keys, which include the fields  regionName, azName, vpcName, networkName, subnetName, imageNameinstanceType,  name      createDate, and createName. </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> It specifies the order type, which includes DESC and ASC. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> cloud host list. </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> total number. </td> <td>   </td> </tr> </tbody> </table>   12. ResizeEfsVol Interface Description It is used to resize EFS volumes. Before the resize, you can call the GetEfsSizeConfig to query EFS volume size. This interface is implemented by an asynchronous operation, which takes a while to complete after the interface is invoked successfully. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> yes </td> <td> It specifies the size of the EFS volumes to be scaled. </td> <td>   </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> yes </td> <td> It specifies EFS volume ID. You can call the ListEfs to query EFS volume list. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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> It specifies the product code. </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> It specifies the order ID. </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> It indicates the order status. </td> <td>   </td> </tr> </tbody> </table>   13. SelectEfsProductSpecItem Interface Description It is used to obtain the list of EFS product specification for storage. Request Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ProductSpecCodes </td> <td> List<SelectItemBean> </td> <td> It specifies the product specification code. </td> <td>   </td> </tr> </tbody> </table>

Did the above content solve your problem? Yes No