平安云 - 云以致用智造未来

API 描述

1. AddEfsRule 接口描述 EFS卷授权一台或多台云主机的实例。  授权实例前，您需要预先在相应的平安云地域下创建EFS卷，  可以调用ListUnboundInstance查看指定EFS卷未授权的云主机实例列表。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> true </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。 </td> <td>   </td> </tr> <tr> <td> Instances </td> <td> String </td> <td> true </td> <td> 授权的云主机实例信息。该参数是JSON格式的字符串，  格式如下：[{"InstanceUuid":"xxx","InstanceName":"xxx","Permission":"xxx"}]，  其中InstanceUuid 是云主机实例的ID，InstanceName是云主机实例的名称，可以调用ListUnboundInstance获取，  Permission云主机访问EFS卷权限，NFS类型的取值范围：rw（读写）、ro（只读）、root，CIFS类型的默认为full_control（管理员权限）。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   2. BreakDPVolume 接口描述 分离DP卷。  分离DP卷前，您可以调用ListEfs查看指定区域或可用区内的EFS卷资源。  分离DP卷后，数据保护卷（DP卷）将解除与主卷的关联关系，变更为可进行相关操作的EFS主卷。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> true </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   3. CreateEfsVolume 接口描述 创建一个按量付费的弹性文件EFS卷。  创建EFS卷会涉及到资源计费，建议您提前了解弹性文件EFS的计费方式。更多详情，请参阅计费概述。  创建EFS卷前，您可以调用GetEfsSizeConfig查询可以创建卷的大小范围。  NFS类型用于用于Linux类型的云主机，CIFS类型用于Windows类型的云主机。  CIFS类型的创建不了数据保护卷（DP卷）。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> true </td> <td> EFS卷所属的产品系列ID（协议类型），您可以调用ListProductSeries获取EFS卷相关的产品系列列表。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> true </td> <td> EFS卷所属的可用区ID，您可以调用ListZones获取可用区列表。 </td> <td>   </td> </tr> <tr> <td> ProductSpecId </td> <td> String </td> <td> true </td> <td> EFS卷所属的产品规格ID（存储类型），您可以调用ListEfsResourceTypes获取EFS卷相关的产品规格列表。 </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> true </td> <td> EFS卷容量大小，您可以调用GetEfsSizeConfig查询可以创建卷的大小范围。 </td> <td>   </td> </tr> <tr> <td> Instances </td> <td> String </td> <td> true </td> <td> 授权的云主机实例信息。该参数是JSON格式的字符串，  格式如下：[{"InstanceUuid":"xxx","InstanceName":"xxx","Permission":"xxx"}]，  其中InstanceUuid 是云主机实例的ID，InstanceName是云主机实例的名称，可以调用ListUnboundInstance获取，  Permission云主机访问EFS卷权限，NFS类型的取值范围：rw（读写）、ro（只读）、root，CIFS类型的默认为full_control（管理员权限）。 </td> <td>   </td> </tr> <tr> <td> DstZoneId </td> <td> String </td> <td> false </td> <td> 数据保护卷（DP卷）所属的可用区ID，您可以调用ListZone获取对应地域下的可用区列表。  数据保护卷所属的可用区和主卷所属的可用区是在同一个地域下的。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> </tbody> </table>   4. DeleteEfsRule 接口描述 EFS卷取消关联的云主机实例授权。  可以调用ListEfsInstance查看指定的EFS卷已授权的云主机实例列表。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td style="width:40px"> 是否必须 </td> <td style="width:573px"> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsInstanceId </td> <td> String </td> <td style="width:40px"> true </td> <td style="width:573px"> EFS卷已授权的云主机实例记录的ID。  可以调用ListUnboundInstance查看指定EFS卷未授权的云主机实例列表。 </td> <td>   </td> </tr> <tr> <td>EfsInstanceType</td> <td>String</td> <td style="width:40px">true</td> <td style="width:573px"> EFS卷已授权的实例类型： <ul> <li>ECS（云主机）</li> <li>BMS（物理机）</li> </ul> </td> <td> </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   5. DestroyEfsVolume 接口描述 释放一个EFS卷。  EFS卷存在数据保护卷（DP卷），无论是否进行分离操作，释放主卷会同时释放关联的数据保护卷（DP卷）。  释放已经分离成功的数据保护卷（DP卷）时，只会释放分离后的数据保护卷（DP卷），主卷会依然保留。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> true </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   6. GetEfsSizeConfig 接口描述 获取EFS卷配置的容量大小信息。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> MinSize </td> <td> String </td> <td> EFS卷容量的最小值 </td> <td>   </td> </tr> <tr> <td> MaxSize </td> <td> String </td> <td> EFS卷容量的最大值 </td> <td>   </td> </tr> </tbody> </table>   7. ListEfsVolume 接口描述 查询EFS卷列表。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> true </td> <td> EFS卷所属的地域ID，您可以调用ListRegions获取地域列表。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> false </td> <td> EFS卷所属的可用区ID，您可以调用ListZones获取可用区列表。 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> false </td> <td> EFS名称 </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> false </td> <td> 创建人名称 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> EfsStatus[] </td> <td> false </td> <td> EFS状态 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> false </td> <td> 分页页码 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> false </td> <td> 分页大小 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> false </td> <td> 排序关键字  支持排序字段：name（EFS卷名称）， createDate（创建时间）， createName（创建人） </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> false </td> <td> 排序类型  支持排序方式：DESC（倒序），ASC（正序） </td> <td>   </td> </tr> <tr> <td> StorageType </td> <td> String </td> <td> false </td> <td> 存储类型  支持存储类型：NAS-MID（标准型），NAS-ARC（容量型） </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Efses </td> <td> List<EfsBean> </td> <td> EFS卷信息列表 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数 </td> <td>   </td> </tr> </tbody> </table>   8. ListEfsAvailableCidrs 接口描述 查询EFS卷可已授权的云主机实例的IP所属的CIDR列表。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> true </td> <td> EFS卷所属的地域ID，您可以调用ListRegions获取地域列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Cidrs </td> <td> List<EfsInstanceIpBean> </td> <td> EFS卷关联云主机实例可用IP段信息列表 </td> <td>   </td> </tr> </tbody> </table>   9. ListEfsInstances 接口描述 查询EFS卷关联的云主机实例列表。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> true </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsInstances </td> <td> List<EfsInstanceBean> </td> <td> EFS卷关联的云主机实例信息列表 </td> <td>   </td> </tr> </tbody> </table>   10. ListEfsProductSpec 接口描述 查询EFS卷所属的产品规格（存储类型）列表。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> true </td> <td> EFS卷所属的产品系列（协议类型）ID，您可以调用ListProductSeries获取产品系列列表。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> true </td> <td> EFS卷所属的可用区ID，您可以调用ListZones获取可用区列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsResourceTypes </td> <td> List<EfsResourceTypeBean> </td> <td> EFS资源类型信息列表 </td> <td>   </td> </tr> </tbody> </table>   11. ListUnboundInstance 接口描述 查询EFS卷未授权的云主机实例列表。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> false </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。  该参数不为空时，会过滤掉该卷已经关联的云主机。  与参数productSeriesId二选一，否则不返回云主机列表信息。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> false </td> <td> EFS卷所属的地域ID，您可以调用ListRegions获取地域列表。 </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> false </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> InstanceDisplayName </td> <td> String </td> <td> false </td> <td> 云主机备注 </td> <td>   </td> </tr> <tr> <td> InstanceIp </td> <td> String </td> <td> false </td> <td> 云主机IP </td> <td>   </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> false </td> <td> EFS卷所属的产品系列（协议类型）的ID，您可以调用ListProductSeries获取产品系列列表。  根据选择的产品系列，返回符合条件的云主机列表信息。  如果参数efsId不为空，则会忽略该参数。  与参数productSeriesId二选一，否则不返回云主机列表信息。 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> false </td> <td> 分页页码 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> false </td> <td> 分页大小 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> false </td> <td> 排序关键字  支持排序字段：regionName（地域名称）， azName（可用区名称），vpcName（VPC名称），networkName（网络域名称），       subnetName（子网名称）， imageName（操作系统名称），instanceType（实例类型）， name（实例名称），        createDate（创建时间）， createName（创建人） </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> false </td> <td> 排序类型  支持排序方式：DESC（倒序），ASC（正序） </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机列表 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总量 </td> <td>   </td> </tr> </tbody> </table>   12. ResizeEfsVol 接口描述 EFS卷扩容。  EFS卷扩容前，您可以调用GetEfsSizeConfig查看EFS卷容量大小限制的范围。  该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> true </td> <td> EFS卷扩容的大小 </td> <td>   </td> </tr> <tr> <td> EfsId </td> <td> String </td> <td> true </td> <td> EFS卷的ID，可以调用ListEfs查看EFS卷列表。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品类型标识码 </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> </tbody> </table>   13. SelectEfsProductSpecItem 接口描述 获取EFS卷产品规格（存储类型）code列表信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductSpecCodes </td> <td> List<SelectItemBean> </td> <td> EFS卷所属的产品规格（存储类型）code列表 </td> <td>   </td> </tr> </tbody> </table>

以上内容是否解决了您的问题？是否