API 概览

<table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>API</strong></p> </td> <td style="background-color:#ededed"> <p><strong>描述</strong></p> </td> </tr> <tr> <td> <p>AttachDiskToInstance</p> </td> <td> <p>挂载云磁盘到云主机实例。<br /> <br /> 挂载云磁盘需要通过登陆认证获取令牌。<br /> 调用接口是,需要注意:<br /> 1、云磁盘的状态必须为ToAttach(待挂载);<br /> 2、云磁盘类型必须和云主机类型对应;<br /> 调用该接口之前,可以调用ListDisks接口查询当前云磁盘的信息。<br /> 调用该接口之前,可以调用ListAbleAttachInstance接口将查询出所有可挂载的云主机实例。<br /> 该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</p> </td> </tr> <tr> <td> <p>CheckEbsForUpgrade</p> </td> <td> <p>用于磁盘扩容前校验</p> </td> </tr> <tr> <td> <p>CheckQuotaOrUntreatedOrder</p> </td> <td> <p>用于配额或者未支付订单的校验</p> </td> </tr> <tr> <td> <p>CreateDedicatedecsDisk</p> </td> <td> <p>创建一个或多个专属云磁盘。<br /> 专属云磁盘只可专属租户使用<br /> 创建专属云磁盘需要通过登陆认证获取令牌。<br /> 创建专属云磁盘不涉及到资源计费,跟创建的专属物理机磁盘大小容量有关</p> </td> </tr> <tr> <td> <p>CreateDisk</p> </td> <td> <p>创建一块或多块付费的数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。<br /> &lt;p&gt;<br /> 创建云磁盘需要通过登陆认证获取令牌。<br /> 创建云磁盘会涉及到资源计费,建议提前了解云磁盘EBS的计费方式。</p> </td> </tr> <tr> <td> <p>DeleteDisk</p> </td> <td> <p>释放付费数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。<br /> &lt;p&gt;<br /> 释放云磁盘需要通过登陆认证获取令牌。<br /> 只有当云磁盘的状态为如下几种之一时,才能释放,否则抛出异常:<br /> 1、Available(可用)<br /> 2、CreateFailed(创建失败)<br /> 3、DestroyFailed(删除失败)<br /> 4、ToAttach(待挂载)<br /> 目前删除云磁盘会同步删除该云磁盘对应快照(包括手动快照和自动快照),可以通过设置needDeleteSnapshot=false来关闭该功能。<br /> 该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</p> </td> </tr> <tr> <td> <p>DetachDIsk</p> </td> <td> <p>从云主机实例上卸载付费云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。<br /> <br /> 卸载云磁盘需要通过登陆认证获取令牌。<br /> 使用该接口时,需要注意:<br /> 1、云磁盘的EnableFlag属性必须是true;<br /> 2、云磁盘必须已经挂载到云主机实例;<br /> 3、云磁盘的状态必须为Available或者DestroyFailed;<br /> 4、与磁盘的计费方式不能为 Monthly(按月付费);<br /> 可以通过ListDisks接口查询云磁盘信息的上述信息。<br /> 该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</p> </td> </tr> <tr> <td> <p>GetDisk</p> </td> <td> <p>根据云磁盘Id获取云磁盘详细信息。</p> </td> </tr> <tr> <td> <p>ListAbleAttachInstance</p> </td> <td> <p>查询云磁盘可挂载的所有云主机实例。<br /> <br /> 该接口通常是在调用AttachDiskToInstance接口之前调用,用来保证云磁盘将要挂载的云主机类型状态的有效性。</p> </td> </tr> <tr> <td> <p>ListAbleRelateDisks</p> </td> <td> <p>查询出所有能被快照策略关联的云磁盘列表。<br /> <br /> 调用接口时,需要注意:<br /> 1、该接口返回的数据为分页数据,默认情况下页码值为1,每页显示数据条数为10。</p> </td> </tr> <tr> <td> <p>ListAllEbsTypes</p> </td> <td> <p>查询云磁盘产品规格。</p> </td> </tr> <tr> <td> <p>ListCalculateEbsSeries</p> </td> <td> <p>为价格计算器查询磁盘系列</p> </td> </tr> <tr> <td> <p>ListDedicatedEbsProductSeries</p> </td> <td> <p>查询专属云磁盘产品系列</p> </td> </tr> <tr> <td> <p>ListDiskByPolicyId</p> </td> <td> <p>查询出关联同一快照策略的磁盘列表。<br /> <br /> 调用接口时,需要注意:<br /> 1、只能查询如下状态的云磁盘信息:<br /> ToAttach:待挂载<br /> Attaching:挂载中<br /> Deteaching:卸载中<br /> Available:可用<br /> Destroying:删除中<br /> DestroyFailed:删除失败<br /> 2、云磁盘所在的云主机的状态必须在如下状态中:<br /> Running:运行中<br /> Stopped:已关机<br /> Starting:启动中<br /> Stopping:关机中<br /> Destroying:删除中<br /> 3、返回的数据为分页查询结果,默认情况下页码为1,每页显示10条数据。</p> </td> </tr> <tr> <td> <p>ListDisks</p> </td> <td> <p>查询云磁盘信息。<br /> &lt;p&gt;<br /> 调用接口时,需要注意:<br /> 1、接口采用分页查询的方式,默认页码为1,每页显示1000条数据。</p> </td> </tr> <tr> <td> <p>ListEbsProductSeries</p> </td> <td> <p>查询云磁盘产品系列</p> </td> </tr> <tr> <td> <p>ListEbsTypes</p> </td> <td> <p>查询云磁盘产品规格。<br /> 门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格名称为ebs.s1。</p> </td> </tr> <tr> <td> <p>ListEbsTypesByInstanceType</p> </td> <td> <p>根据云主机类型查询可创建的磁盘类型</p> </td> </tr> <tr> <td> <p>ModifyDiskAttribute</p> </td> <td> <p>修改云磁盘属性。<br /> <br /> 修改云磁盘的属性需要通过登陆认证获取令牌。</p> </td> </tr> <tr> <td> <p>ModifyEbsAttribute</p> </td> <td> <p>修改云磁盘的属性<br /> <br /> 修改云磁盘的属性需要通过登陆认证获取令牌。<br /> 通过获取的磁盘uuid查询到需要修改的磁盘在进行判断,区分数据盘和系统盘,并判断是否为本地盘否则将会抛出异常提醒。</p> </td> </tr> <tr> <td> <p>UpgradeDisk</p> </td> <td> <p>云磁盘扩容。<br /> <br /> 扩容云磁盘需要通过登陆认证获取令牌。<br /> 扩容云磁盘会涉及到资源计费,建议提前了解云磁盘EBS的计费方式。<br /> 调用该接口时,需要注意:<br /> 1、只有数据盘(类型为DATADISK)才能扩容,系统盘(类型为ROOT)不能扩容;<br /> 2、云磁盘的状态为 Available 或 Destroyfailed 才能扩容;<br /> 3、云磁盘的操作状态为Normal时才能扩容;<br /> 4、扩容后的磁盘容量不能小于原来磁盘容量;<br /> 5、对于已到期的磁盘不能进行扩容;<br /> 6、如果云磁盘计费方式是包年/包月,则要重新计算云磁盘开始时间、到期时间及周期 。</p> </td> </tr> <tr> <td> <p>ListPods</p> </td> <td> <p>查询高可用域</p> </td> </tr> <tr> <td> <p>CreateDedicatedSnapshotPolicy</p> </td> <td> <p>专属云主机创建快照策略<br /> 云主机到期,不允许创建快照<br /> 接口为异步job 创建&nbsp; 查看快照状态确认是否创建成功</p> </td> </tr> <tr> <td> <p>CreateEbsRelatedPolicy</p> </td> <td> <p>创建磁盘和快照策略的关联策略<br /> <br /> 创建磁盘和快照策略的关联策略需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshotPolicies接口查询到快照策略进行操作关联磁盘。<br /> 如果快照策略为空则会抛出快照策略不存在的异常。<br /> 并且创建磁盘的 快照策略关联磁盘数量不得超过8个,否则会抛出异常。</p> </td> </tr> <tr> <td> <p>CreateInstanceSnapshot</p> </td> <td> <p>创建云主机快照<br /> 如果已到期云主机,到达强制关机时间,一旦关机,不允许创建快照</p> </td> </tr> <tr> <td> <p>CreateSnapshot</p> </td> <td> <p>创建快照<br /> <br /> 创建快照需要通过登陆认证获取令牌。<br /> 通过ListDisks接口查询到快照,然后进行操作创建快照。<br /> 如果已到期云主机,到达强制关机时间,一旦关机,不允许创建快照</p> </td> </tr> <tr> <td> <p>CreateSnapshotPolicy</p> </td> <td> <p>创建快照策略<br /> <br /> 创建快照策略需要通过登陆认证获取令牌。<br /> 创建快照策略时需要注意最大保留份数不能超过8个。<br /> 以对应的DTO通过createSnapshotPolicy方法创建快照策略。</p> </td> </tr> <tr> <td> <p>DeleteDedicatedSnapshotPolicy</p> </td> <td> <p>删除专属 快照策略<br /> 已删除快照策略不可再删除<br /> 接口为异步删除,可根据快照策略状态确认是否删除成功</p> </td> </tr> <tr> <td> <p>DeleteEbsRelatedPolicy</p> </td> <td> <p>解除磁盘和策略的关联关系<br /> <br /> 解除关联需要通过登陆认证获取令牌。<br /> 需要通过调用getDisk接口查询磁盘详细信息进行解除关联操作。<br /> 获取磁盘对应的快照策略通过deleteEbsRelatedPolicy方法来解除关联关系<br /> 接口为异步job删除&nbsp; 查看解除磁盘和策略的关联关系是否解除成功</p> </td> </tr> <tr> <td> <p>DeleteSnapshot</p> </td> <td> <p>删除快照<br /> <br /> 删除快照需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshots接口查询快照进行操作删除。<br /> 获取快照的id调用deleteSnapshotJob方法删除快照<br /> 接口为异步job删除&nbsp; 查看快照是否删除成功</p> </td> </tr> <tr> <td> <p>DeleteSnapshotPolicy</p> </td> <td> <p>删除快照策略<br /> <br /> 删除快照策略需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshotPolicies接口查询快照策略进行操作删除。<br /> 在删除之前请注意依赖资源的绑定。需要通过getDisk接口查询磁盘信息中先取消关联后才能进行删除操作。<br /> 获取对应的快照策略的id,然后调用deleteSnapshotPolicy方法删除快照策略</p> </td> </tr> <tr> <td> <p>GetSnapshot</p> </td> <td> <p>获取快照信息<br /> <br /> 需要通过登陆认证获取令牌。<br /> 通过快照的id查询到对应的快照信息</p> </td> </tr> <tr> <td> <p>GetSnapshotPolicy</p> </td> <td> <p>获取磁盘快照策略信息<br /> <br /> 需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshotPolicies接口查询快照策略进行操作编辑。<br /> 通过快照策略的id查询到对应的快照策略信息</p> </td> </tr> <tr> <td> <p>ListAllSnapshotPolicies</p> </td> <td> <p>查询全部快照策略<br /> <br /> 需要通过登陆认证获取令牌。<br /> 调用接口时,需要注意:<br /> 1、接口采用分页查询的方式,默认页码为1,每页显示10条数据。<br /> 通过findAllByTenant方法、按照排序方式,排序关键字,每页显示数量,显示的页数来查询全部的快照策略</p> </td> </tr> <tr> <td> <p>ListAllSnapshots</p> </td> <td> <p>查询全部快照信息<br /> <br /> 查询全部快照信息需要通过登陆认证获取令牌。<br /> 调用接口时,需要注意:<br /> 1、接口采用分页查询的方式,默认页码为1,每页显示10条数据。<br /> 通过findAllByTenant方法、按照排序方式,排序关键字,每页显示数量,显示的页数来查询全部的快照信息</p> </td> </tr> <tr> <td> <p>ListSnapshotPolicies</p> </td> <td> <p>查询快照策略<br /> <br /> 查询快照策略要通过登陆认证获取令牌。<br /> 通过GetDisk接口查询云磁盘详细信息时调用。用于查询已关联的快照策略。<br /> 根据所提供的磁盘id通过findRelatedPolicyByEbsId方法查询该磁盘下的快照策略信息。</p> </td> </tr> <tr> <td> <p>ListSnapshots</p> </td> <td> <p>查询快照<br /> <br /> 查询快照要通过登陆认证获取令牌。<br /> 通过GetDisk接口查询云磁盘详细信息时调用。用于查询已关联的快照。<br /> 根据所提供的磁盘id通过querySnapshots方法查询该磁盘下的快照信息。</p> </td> </tr> <tr> <td> <p>ModifySnapshotAttribute</p> </td> <td> <p>修改快照属性<br /> <br /> 修改快照属性需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshots接口查询到快照后进行名称描述修改。<br /> 通过所提供的id查询到对应的快照,再将需要的修改的快照属性重新设置更新。</p> </td> </tr> <tr> <td> <p>ModifySnapshotPolicyAttribute</p> </td> <td> <p>修改快照策略属性<br /> <br /> 修改快照策略属性需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshotPolicies接口查询快照策略进行操作编辑修改。<br /> 通过所提供的id查询到对应的快照策略,再将需要的修改的快照策略属性重新设置更新。</p> </td> </tr> <tr> <td> <p>ModifySnapshotPolicyDisplayName</p> </td> <td> <p>修改快照策略描述<br /> <br /> 修改快照策略描述属性需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshotPolicies接口查询快照策略对名称描述进行修改。<br /> 通过所提供的id查询到对应的快照策略,再将要修改的快照策略描述名称的属性重新设置更新。</p> </td> </tr> <tr> <td> <p>RevertSnapshot</p> </td> <td> <p>快照回滚<br /> <br /> 快照回滚需要通过登陆认证获取令牌。<br /> 通过ListAllSnapshots查询快照进行操作快照回滚。<br /> 通过id先查询到快照,再通过快照查询到磁盘。<br /> 然后加已判断。<br /> 如果是已到期云主机,到达强制关机时间,包月的云磁盘一旦关机,不允许回滚磁盘<br /> 满足回滚要求的则调用revertSnapshot方法进行快照回滚。<br /> 接口为异步job回滚&nbsp; 查看快照回滚是否成功</p> </td> </tr> <tr> <td> <p>SyncSnapshot</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题