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

API 描述

1. AttachDiskToInstance 接口描述 挂载云磁盘到云主机实例。 挂载云磁盘需要通过登陆认证获取令牌。 调用接口是，需要注意： 1、云磁盘的状态必须为ToAttach（待挂载）; 2、云磁盘类型必须和云主机类型对应; 调用该接口之前，可以调用ListDisks接口查询当前云磁盘的信息。 调用该接口之前，可以调用ListAbleAttachInstance接口将查询出所有可挂载的云主机实例。 该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 待挂载的云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 云磁盘挂载的ECS实例Id。 可以调用ListAbleAttachInstance接口将查询出所有可挂载的云主机实例 </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. CheckEbsForUpgrade 接口描述 用于磁盘扩容前校验 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 待扩容的云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </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> </tbody> </table>   3. CheckQuotaOrUntreatedOrder 接口描述 用于配额或者未支付订单的校验 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 否 </td> <td> 待扩容的云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> 否 </td> <td> 扩容后的云磁盘大小。 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 否 </td> <td> 云主机Id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   4. CreateDedicatedecsDisk 接口描述 创建一个或多个专属云磁盘。 专属云磁盘只可专属租户使用 创建专属云磁盘需要通过登陆认证获取令牌。 创建专属云磁盘不涉及到资源计费，跟创建的专属物理机磁盘大小容量有关 请求参数 <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> 是 </td> <td> 专属云磁盘大小，（单位：GB） 请填写10的倍数，不能小于20 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 专属云磁盘显示名称 请填写中文, 英文字母, 数字，空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 专属实例Id 专属云磁盘挂在在哪台云主机上 </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> 是 </td> <td> 产品规格 专属云磁盘类型 门户中每种云磁盘类型都对应着相应的云磁盘产品规格，例如SSD型云硬盘对应的产品规格ebs.s1。 可以通过ListAllEbsTypes接口查询云磁盘产品规格。 </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> 否 </td> <td> 专属云磁盘磁盘数量 单位：个 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </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> ChargeType </td> <td> ChargeType </td> <td> 云磁盘的计费方式。 计费方式枚举如下： Hour：  按小时计费 Usage：  按量计费 PreUsage：按量预付费 Monthly：包月计费 Free：  免费 Annual：  包年计费 目前创建云磁盘的计费方式固定为Hour </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </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> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </td> <td>   </td> </tr> </tbody> </table>   5. CreateDisk 接口描述 创建一块或多块付费的数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。 创建云磁盘需要通过登陆认证获取令牌。 创建云磁盘会涉及到资源计费，建议提前了解云磁盘EBS的计费方式。 请求参数 <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> 是 </td> <td> 云磁盘容量大小，单位：GB。 必填项 请填写10的倍数，不能小于20 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 云磁盘在门户界面显示名称。 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> 是 </td> <td> 云磁盘产品规格。 门户中每种云磁盘类型都对应着相应的云磁盘产品规格，例如SSD型云硬盘对应的产品规格ebs.s1。 可以通过ListAllEbsTypes接口查询云磁盘产品规格。 </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> 是 </td> <td> 需要创建云磁盘数量。 默认情况下为1。 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> 否 </td> <td> 云磁盘标签。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 云磁盘所属的地域Id。 必填项 地域Id 决定了用户创建的云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 云磁盘所属的可用区Id。 必填项 一个地域下可能有多个可用区，可用区Id决定了用户创建的云磁盘分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> SnapshotId </td> <td> String </td> <td> 否 </td> <td> 创建云磁盘时所使用的快照。 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 云磁盘可挂载的云主机Id。 必填项 云主机实例Id 决定了创建的云磁盘将要挂载在哪个的云主机实例上。 可以通过ListAbleAttachInstance接口查询可挂载的云主机实例信息。 </td> <td>   </td> </tr> <tr> <td> IsEncryption </td> <td> boolean </td> <td> 否 </td> <td> 云磁盘是否需要加密 默认不加密 </td> <td>   </td> </tr> <tr> <td> DiskEncryptionType </td> <td> String </td> <td> 否 </td> <td> 云磁盘加密类型 </td> <td>   </td> </tr> <tr> <td> IsBackUp </td> <td> boolean </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> ChargeType </td> <td> ChargeType </td> <td> 云磁盘的计费方式。 计费方式枚举如下： Hour：  按小时计费 Usage：  按量计费 PreUsage：按量预付费 Monthly：包月计费 Free：  免费 Annual：  包年计费 目前创建云磁盘的计费方式固定为Hour </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </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> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </td> <td>   </td> </tr> </tbody> </table>   6. DeleteDisk 接口描述 释放付费数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。 释放云磁盘需要通过登陆认证获取令牌。 只有当云磁盘的状态为如下几种之一时，才能释放，否则抛出异常： 1、Available（可用） 2、CreateFailed（创建失败） 3、DestroyFailed（删除失败） 4、ToAttach（待挂载） 目前删除云磁盘会同步删除该云磁盘对应快照（包括手动快照和自动快照），可以通过设置needDeleteSnapshot=false来关闭该功能。 该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <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> 是 </td> <td> 需要释放的云磁盘Id。 </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>   7. DetachDIsk 接口描述 从云主机实例上卸载付费云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。 卸载云磁盘需要通过登陆认证获取令牌。 使用该接口时，需要注意： 1、云磁盘的EnableFlag属性必须是true; 2、云磁盘必须已经挂载到云主机实例; 3、云磁盘的状态必须为Available或者DestroyFailed; 4、与磁盘的计费方式不能为 Monthly（按月付费）; 可以通过ListDisks接口查询云磁盘信息的上述信息。 该接口是异步操作，接口调用成功返回信息后需要等待片刻才能完成。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 需要卸载的云磁盘Id。 </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>   8. GetDisk 接口描述 根据云磁盘Id获取云磁盘详细信息。 请求参数 <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> 是 </td> <td> 云磁盘Id。 </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> DiskDetail </td> <td> EbsDetailBean </td> <td> 云磁盘详细信息。 </td> <td>   </td> </tr> </tbody> </table>   9. ListAbleAttachInstance 接口描述 查询云磁盘可挂载的所有云主机实例。 该接口通常是在调用AttachDiskToInstance接口之前调用，用来保证云磁盘将要挂载的云主机类型状态的有效性。 请求参数 <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> 否 </td> <td> 待挂载的云磁盘Id。 id和ebsTypeId至少存在一个 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云主机实例名称。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 待挂载云磁盘所属的地域Id。 地域Id 决定了云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 待挂载云磁盘所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了云磁盘分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 否 </td> <td> 待挂载云磁盘所属的高可用域Id。 一个可用区下可能有多个高可用域，高可用域Id决定了云磁盘所在的具体位置，例如深圳C1。 可以通过ListPods接口查询高可用域信息。 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码。 分页查询时使用。 默认值为1。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小。 分页查询时使用。 默认值为10。 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字。 查询时指定按照哪个关键字将返回的数据进行排序。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式。 默认按DESC排序 和排序关键字搭配使用，表示按照升序还是降序排列，取值如下： ASC：升序 DESC：降序 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 云主机分类数组，默认取值 InstanceCategory.Ecs 和 InstanceCategory.Caas 云主机分类，取值为： Ecs：        独立云主机 Caas：       集群云主机 Dedicated：  专属云主机 AutoScaling：弹性伸缩 GBD：        大数据云主机 FORTRESS：   堡垒机 </td> <td>   </td> </tr> <tr> <td> EbsTypeId </td> <td> String </td> <td> 否 </td> <td> 云磁盘产品规格Id。 id和ebsTypeId至少存在一个。 门户中每种云磁盘类型都对应着相应的云磁盘产品规格，例如SSD型云硬盘对应的产品规格名称为ebs.s1。 可以通过ListAllEbsTypes接口查询云磁盘产品规格信息。 </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>   10. ListAbleRelateDisks 接口描述 查询出所有能被快照策略关联的云磁盘列表。 调用接口时，需要注意： 1、该接口返回的数据为分页数据，默认情况下页码值为1，每页显示数据条数为10。 请求参数 <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> 是 </td> <td> 云磁盘所属的地域Id。 地域Id 决定了云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> 是 </td> <td> 快照策略的周期。 取值如下： MANUAL：手动 HOURLY：小时 DAILY：  天 WEEKLY：星期 MONTHLY：月 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 云磁盘所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了云磁盘分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云磁盘名称。 </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> 否 </td> <td> 云主机名称。 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码。 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小。 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字。 查询时指定按照哪个关键字将返回的数据进行排序。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式。 默认按DESC排序 和排序关键字搭配使用，表示按照升序还是降序排列，取值如下： ASC：升序 DESC：降序 </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> 否 </td> <td> 云磁盘类型。 设置了该值之后，则只会查询出对应类型的云磁盘。 与磁盘类型取值如下： ROOT:系统盘 DATADISK:数据盘 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 云主机分类数组，默认取值 InstanceCategory.Ecs 和 InstanceCategory.Caas 设置了该值之后，则只会查询出该数组中对应的云主机所挂载的云磁盘。 云主机分类，取值为： Ecs：        独立云主机 Caas：       集群云主机 Dedicated：  专属云主机 AutoScaling：弹性伸缩 GBD：        大数据云主机 FORTRESS：   堡垒机 </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> Disks </td> <td> List<EbsBean> </td> <td> 查询到的云磁盘信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 查询到的云磁盘总数。 </td> <td>   </td> </tr> </tbody> </table>   11. ListAllEbsTypes 接口描述 查询云磁盘产品规格。 请求参数 <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> 是 </td> <td> 云磁盘所属的地域Id。 地域Id 决定了云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 云磁盘所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了云磁盘分布的具体可用区，例如可用区A。 可以通过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> EbsTypes </td> <td> List<EbsTypeBean> </td> <td> 云磁盘产品规格信息列表。 </td> <td>   </td> </tr> <tr> <td> Map </td> <td> List<Object> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   12. ListCalculateEbsSeries 接口描述 为价格计算器查询磁盘系列 请求参数 <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> 否 </td> <td> 地域 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区 </td> <td>   </td> </tr> <tr> <td> InstanceProductSeriesId </td> <td> String </td> <td> 否 </td> <td> 云主机实例产品系列Id </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> ProductSeries </td> <td> List<ProductSeriesBean> </td> <td> 产品系列信息列表 </td> <td>   </td> </tr> </tbody> </table>   13. ListDedicatedEbsProductSeries 接口描述 查询专属云磁盘产品系列 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 云主机实例产品系列Id </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </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> ProductSeries </td> <td> List<ProductSeriesBean> </td> <td> 产品系列信息列表 </td> <td>   </td> </tr> </tbody> </table>   14. ListDiskByPolicyId 接口描述 查询出关联同一快照策略的磁盘列表。 调用接口时，需要注意： 1、只能查询如下状态的云磁盘信息： ToAttach：待挂载 Attaching：挂载中 Deteaching：卸载中 Available：可用 Destroying：删除中 DestroyFailed：删除失败 2、云磁盘所在的云主机的状态必须在如下状态中： Running：运行中 Stopped：已关机 Starting：启动中 Stopping：关机中 Destroying：删除中 3、返回的数据为分页查询结果，默认情况下页码为1，每页显示10条数据。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> SnapshotPolicyId </td> <td> String </td> <td> 是 </td> <td> 云磁盘关联的快照策略Id。 可以通过ListAllSnapshotPolicies接口获取快照策略信息。 </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> Disks </td> <td> List<EbsBean> </td> <td> 查询到的云磁盘信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 查询到的云磁盘总数。 </td> <td>   </td> </tr> </tbody> </table>   15. ListDisks 接口描述 查询云磁盘信息。 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示1000条数据。 请求参数 <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> 是 </td> <td> 云磁盘所属的地域Id。 地域Id 决定了云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 云磁盘所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了云磁盘分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> 否 </td> <td> 云磁盘所属的可用区名称。 一个地域下可能有多个可用区，可用区名称决定了云磁盘分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云磁盘名称。 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 否 </td> <td> 云主机实例Id。 云主机实例Id 表示云磁盘所挂载的云主机实例标识。 可以通过ListInstances接口查询云主机实例信息。 </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> 否 </td> <td> 云主机实例名称。 云主机实例名称表示云磁盘所挂载的云主机实例标识。 可以通过ListInstances接口查询云主机实例信息。 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码。 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小。 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字。 查询时指定按照哪个关键字将返回的数据进行排序。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式。 默认按DESC排序 和排序关键字搭配使用，表示按照升序还是降序排列，取值如下： ASC：升序 DESC：降序 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> DiskStatus[] </td> <td> 否 </td> <td> 云磁盘状态数组。 设置了该值之后，则只会查询出云磁盘状态在该数组中的云磁盘。 云磁盘状态取值如下： ToCreate：待创建 Pending：创建中 Available：可用 CreateFailed：创建失败 Destroying：删除中 Destroyed：已删除 DestroyFailed：删除失败 Cancel：取消 ToAttach：待挂载 Attaching：挂载中 Deteaching：卸载中 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String[] </td> <td> 否 </td> <td> 云磁盘标签列表数组。 设置了该值之后，则只会查询出云磁盘标签在该数组中的云磁盘。 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 云主机分类数组，默认取值 InstanceCategory.Ecs 和 InstanceCategory.Caas 设置了该值之后，则只会查询出该数组中对应的云主机所挂载的云磁盘。 云主机分类，取值为： Ecs：        独立云主机 Caas：       集群云主机 Dedicated：  专属云主机 AutoScaling：弹性伸缩 GBD：        大数据云主机 FORTRESS：   堡垒机 </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> 否 </td> <td> 云磁盘类型。 设置了该值之后，则只会查询出对应类型的云磁盘。 与磁盘类型取值如下： ROOT:系统盘 DATADISK:数据盘 </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> Disks </td> <td> List<EbsBean> </td> <td> 查询到的云磁盘信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 查询到的云磁盘总数。 </td> <td>   </td> </tr> </tbody> </table>   16. ListEbsProductSeries 接口描述 查询云磁盘产品系列 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 云主机实例产品系列Id </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </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> ProductSeries </td> <td> List<ProductSeriesBean> </td> <td> 产品系列信息列表 </td> <td>   </td> </tr> </tbody> </table>   17. ListEbsTypes 接口描述 查询云磁盘产品规格。 门户中每种云磁盘类型都对应着相应的云磁盘产品规格，例如SSD型云硬盘对应的产品规格名称为ebs.s1。 请求参数 <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> 是 </td> <td> 待查询的产品系列Id。 可以通过ListProductSeries接口查询产品系列信息。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 云磁盘产品规格所在地域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> EbsTypes </td> <td> List<EbsTypeBean> </td> <td> 云磁盘产品规格信息列表。 </td> <td>   </td> </tr> <tr> <td> Map </td> <td> List<Object> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   18. ListEbsTypesByInstanceType 接口描述 根据云主机类型查询可创建的磁盘类型 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 云主机实例产品系列Id </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </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> EbsTypes </td> <td> List<EbsTypeBean> </td> <td> 云磁盘产品规格信息列表。 </td> <td>   </td> </tr> <tr> <td> Map </td> <td> List<Object> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   19. ModifyDiskAttribute 接口描述 修改云磁盘属性。 修改云磁盘的属性需要通过登陆认证获取令牌。 请求参数 <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> 是 </td> <td> 待修改的云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 云磁盘修改后的显示名称。 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   20. ModifyEbsAttribute 接口描述 修改云磁盘的属性 修改云磁盘的属性需要通过登陆认证获取令牌。 通过获取的磁盘uuid查询到需要修改的磁盘在进行判断，区分数据盘和系统盘，并判断是否为本地盘否则将会抛出异常提醒。 请求参数 <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> 是 </td> <td> 云磁盘Id </td> <td>   </td> </tr> <tr> <td> IsNeedDeleteShapshot </td> <td> Boolean </td> <td> 否 </td> <td> 是否随磁盘自动释放快照 </td> <td>   </td> </tr> <tr> <td> IsInstanceDeleteDisk </td> <td> Boolean </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> </tbody> </table>   21. UpgradeDisk 接口描述 云磁盘扩容。 扩容云磁盘需要通过登陆认证获取令牌。 扩容云磁盘会涉及到资源计费，建议提前了解云磁盘EBS的计费方式。 调用该接口时，需要注意： 1、只有数据盘（类型为DATADISK）才能扩容，系统盘（类型为ROOT）不能扩容; 2、云磁盘的状态为 Available 或 Destroyfailed 才能扩容; 3、云磁盘的操作状态为Normal时才能扩容; 4、扩容后的磁盘容量不能小于原来磁盘容量; 5、对于已到期的磁盘不能进行扩容; 6、如果云磁盘计费方式是包年/包月，则要重新计算云磁盘开始时间、到期时间及周期。 请求参数 <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> 是 </td> <td> 待扩容的云磁盘Id。 </td> <td>   </td> </tr> <tr> <td> Size </td> <td> Integer </td> <td> 是 </td> <td> 扩容后的云磁盘大小。 </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> 否 </td> <td> 用户持有的代金券Id。 可以通过支付服务里的listAvailableCoupons方法查询 </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </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> ChargeType </td> <td> ChargeType </td> <td> 云磁盘的计费方式。 计费方式枚举如下： Hour：  按小时计费 Usage：  按量计费 PreUsage：按量预付费 Monthly：包月计费 Free：  免费 Annual：  包年计费 目前创建云磁盘的计费方式固定为Hour </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </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> <tr> <td> ProductCode </td> <td> String </td> <td> 产品Code </td> <td>   </td> </tr> </tbody> </table>   22. ListPods 接口描述 查询高可用域 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 高可用域Id 可以通过ListPods接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 否 </td> <td> 产品Code 可以通过ListProducts接口可以查询所有的产品的code </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> Pods </td> <td> List<PodBean> </td> <td> 高可用域信息列表 </td> <td>   </td> </tr> </tbody> </table>   23. CreateDedicatedSnapshotPolicy 接口描述 专属云主机创建快照策略 云主机到期,不允许创建快照 接口为异步job 创建  查看快照状态确认是否创建成功 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 云磁盘Id 专属云磁盘id 必传字段 </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> 是 </td> <td> 周期 必传字段指定有效周期 </td> <td>   </td> </tr> <tr> <td> Schedule </td> <td> String </td> <td> 是 </td> <td> 必传字段 暂时不使用 </td> <td>   </td> </tr> <tr> <td> MaxSnaps </td> <td> Integer </td> <td> 是 </td> <td> 最大快照保留份数 必传字段 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 策略显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128 个字符 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域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> SnapshotPolicy </td> <td> SnapshotPolicyBean </td> <td> 快照策略相关信息 </td> <td>   </td> </tr> </tbody> </table>   24. CreateEbsRelatedPolicy 接口描述 创建磁盘和快照策略的关联策略 创建磁盘和快照策略的关联策略需要通过登陆认证获取令牌。 通过ListAllSnapshotPolicies接口查询到快照策略进行操作关联磁盘。 如果快照策略为空则会抛出快照策略不存在的异常。 并且创建磁盘的快照策略关联磁盘数量不得超过8个，否则会抛出异常。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsIds </td> <td> String </td> <td> 是 </td> <td> 需要关联关系的云磁盘Id 长度最长36 </td> <td>   </td> </tr> <tr> <td> SnapshotPolicyId </td> <td> String </td> <td> 是 </td> <td> 快照策略Id 可通过ListAllSnapshotPolicies接口查询到快照策略信息。 长度最长36 </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> SuccNum </td> <td> int </td> <td> 成功条数 </td> <td>   </td> </tr> <tr> <td> ErrorNum </td> <td> int </td> <td> 失败次数 </td> <td>   </td> </tr> <tr> <td> ErrorMsg </td> <td> List<String> </td> <td> 失败内容 </td> <td>   </td> </tr> </tbody> </table>   25. CreateInstanceSnapshot 接口描述 创建云主机快照 如果已到期云主机，到达强制关机时间，一旦关机，不允许创建快照 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 快照显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128个字符 </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>   26. CreateSnapshot 接口描述 创建快照 创建快照需要通过登陆认证获取令牌。 通过ListDisks接口查询到快照，然后进行操作创建快照。 如果已到期云主机，到达强制关机时间，一旦关机，不允许创建快照 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 云磁盘Id 可通过ListDisks接口查询到磁盘信息。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 快照显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128个字符 </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>   27. CreateSnapshotPolicy 接口描述 创建快照策略 创建快照策略需要通过登陆认证获取令牌。 创建快照策略时需要注意最大保留份数不能超过8个。 以对应的DTO通过createSnapshotPolicy方法创建快照策略。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 否 </td> <td> 云磁盘Id 可通过ListDisks接口查询到磁盘信息。 </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> 是 </td> <td> 周期 周期分为5种： MANUAL：手动  (不支持创建人工手动的策略) DAILY：天 WEEKLY：星期 MONTHLY：月 </td> <td>   </td> </tr> <tr> <td> Schedule </td> <td> String </td> <td> 是 </td> <td> 时间 长度最长30 第二位是时， 如果是按天的没有第三位， 按周的第三位是周几（周日是1、周一是2类推）， 按月的第三位是日 </td> <td>   </td> </tr> <tr> <td> MaxSnaps </td> <td> Integer </td> <td> 是 </td> <td> 最大快照保留份数 请填写整数，不能大于8 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 策略显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128 个字符 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id 地域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> SnapshotPolicy </td> <td> SnapshotPolicyBean </td> <td> 快照策略的bena对象 </td> <td>   </td> </tr> </tbody> </table>   28. DeleteDedicatedSnapshotPolicy 接口描述 删除专属快照策略 已删除快照策略不可再删除 接口为异步删除,可根据快照策略状态确认是否删除成功 请求参数 <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> 是 </td> <td> 快照策略Id 必传字段 会进行实体校验,校验失败,抛出异常 InvalidParameterException 可通过 ListSnapshotPoliciesAction获取详细信息 </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>   29. DeleteEbsRelatedPolicy 接口描述 解除磁盘和策略的关联关系 解除关联需要通过登陆认证获取令牌。 需要通过调用getDisk接口查询磁盘详细信息进行解除关联操作。 获取磁盘对应的快照策略通过deleteEbsRelatedPolicy方法来解除关联关系 接口为异步job删除  查看解除磁盘和策略的关联关系是否解除成功 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RelatedId </td> <td> String </td> <td> 是 </td> <td> 快照策略Id， 需要解除关联关系的快照策略的id。 长度最长36 </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>   30. DeleteSnapshot 接口描述 删除快照 删除快照需要通过登陆认证获取令牌。 通过ListAllSnapshots接口查询快照进行操作删除。 获取快照的id调用deleteSnapshotJob方法删除快照 接口为异步job删除  查看快照是否删除成功 请求参数 <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> 是 </td> <td> 快照Id 可通过ListAllSnapshots接口查询快照信息。 长度最长36 </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>   31. DeleteSnapshotPolicy 接口描述 删除快照策略 删除快照策略需要通过登陆认证获取令牌。 通过ListAllSnapshotPolicies接口查询快照策略进行操作删除。 在删除之前请注意依赖资源的绑定。需要通过getDisk接口查询磁盘信息中先取消关联后才能进行删除操作。 获取对应的快照策略的id，然后调用deleteSnapshotPolicy方法删除快照策略 请求参数 <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> 是 </td> <td> 快照策略Id 可通过ListAllSnapshotPolicies接口查询快照策略信息。 长度最长36 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   32. GetSnapshot 接口描述 获取快照信息 需要通过登陆认证获取令牌。 通过快照的id查询到对应的快照信息 请求参数 <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> 是 </td> <td> 快照ID 长度最长36 </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> SnapshotBean </td> <td> SnapshotBean </td> <td> 快照信息 </td> <td>   </td> </tr> </tbody> </table>   33. GetSnapshotPolicy 接口描述 获取磁盘快照策略信息 需要通过登陆认证获取令牌。 通过ListAllSnapshotPolicies接口查询快照策略进行操作编辑。 通过快照策略的id查询到对应的快照策略信息 请求参数 <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> 是 </td> <td> 磁盘快照策略Id 长度最长36 </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> SnapshotPolicyDetailBean </td> <td> SnapshotPolicyDetailBean </td> <td> 快照策略信息 </td> <td>   </td> </tr> </tbody> </table>   34. ListAllSnapshotPolicies 接口描述 查询全部快照策略 需要通过登陆认证获取令牌。 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示10条数据。 通过findAllByTenant方法、按照排序方式，排序关键字，每页显示数量，显示的页数来查询全部的快照策略 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 分页查询时使用。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 分页查询时使用。 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域 地域Id决定了用户创建的云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 长度最长36 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 快照策略名称 长度最长45 </td> <td>   </td> </tr> <tr> <td> IntervalType </td> <td> IntervalType </td> <td> 否 </td> <td> 周期 周期分为5种： MANUAL：手动 HOURLY：小时 DAILY：天 WEEKLY：星期 MONTHLY：月 </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> SnapshotPolicies </td> <td> List<SnapshotPolicyBean> </td> <td> 快照策略信息列表，快照的具体详细信息 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数，总共有多少条快照数量 </td> <td>   </td> </tr> </tbody> </table>   35. ListAllSnapshots 接口描述 查询全部快照信息 查询全部快照信息需要通过登陆认证获取令牌。 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示10条数据。 通过findAllByTenant方法、按照排序方式，排序关键字，每页显示数量，显示的页数来查询全部的快照信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 分页查询时使用。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 分页查询时使用。 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域 地域Id决定了用户创建的云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 长度最长36 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 快照名称 长度最长255 </td> <td>   </td> </tr> <tr> <td> EbsName </td> <td> String </td> <td> 否 </td> <td> 磁盘名称 长度最长45 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> SnapshotStatus[] </td> <td> 否 </td> <td> 快照状态分类数组 取值为： ToCreate：待创建 Pending：创建中 CreateFailed：创建失败 Available：可用 Deleting：删除中 Deleted：已删除 DeleteFailed：删除失败 Reverting：还原 Restore：用于重装 </td> <td>   </td> </tr> <tr> <td> Type </td> <td> String </td> <td> 否 </td> <td> 快照类型 长度最长20。 </td> <td>   </td> </tr> <tr> <td> EbsType </td> <td> String </td> <td> 否 </td> <td> 云磁盘产品规格， 长度最长10 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区 </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 否 </td> <td> 高可用域 </td> <td>   </td> </tr> <tr> <td> WhetherEbsCreate </td> <td> Boolean </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> Snapshots </td> <td> List<SnapshotBean> </td> <td> 快照信息列表，每条快照信息的集合 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数,查询到的快照信息总数 </td> <td>   </td> </tr> </tbody> </table>   36. ListSnapshotPolicies 接口描述 查询快照策略 查询快照策略要通过登陆认证获取令牌。 通过GetDisk接口查询云磁盘详细信息时调用。用于查询已关联的快照策略。 根据所提供的磁盘id通过findRelatedPolicyByEbsId方法查询该磁盘下的快照策略信息。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 云磁盘Id 长度最长36 </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> SnapshotPolicies </td> <td> List<SnapshotPolicyBean> </td> <td> 快照策略信息列表，快照的具体详细信息 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数，总共有多少条快照数量 </td> <td>   </td> </tr> </tbody> </table>   37. ListSnapshots 接口描述 查询快照 查询快照要通过登陆认证获取令牌。 通过GetDisk接口查询云磁盘详细信息时调用。用于查询已关联的快照。 根据所提供的磁盘id通过querySnapshots方法查询该磁盘下的快照信息。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 是 </td> <td> 云磁盘Id 长度最长36 </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> Snapshots </td> <td> List<SnapshotBean> </td> <td> 快照信息列表，每条快照信息的集合 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数,查询到的快照信息总数 </td> <td>   </td> </tr> </tbody> </table>   38. ModifySnapshotAttribute 接口描述 修改快照属性 修改快照属性需要通过登陆认证获取令牌。 通过ListAllSnapshots接口查询到快照后进行名称描述修改。 通过所提供的id查询到对应的快照，再将需要的修改的快照属性重新设置更新。 请求参数 <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> 是 </td> <td> 快照Id 可通过ListAllSnapshots接口查询快照信息。 长度最长36 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 快照显示名 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   39. ModifySnapshotPolicyAttribute 接口描述 修改快照策略属性 修改快照策略属性需要通过登陆认证获取令牌。 通过ListAllSnapshotPolicies接口查询快照策略进行操作编辑修改。 通过所提供的id查询到对应的快照策略，再将需要的修改的快照策略属性重新设置更新。 请求参数 <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> 是 </td> <td> 快照策略Id 可通过ListAllSnapshotPolicies接口查询快照策略信息。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 快照策略显示名 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   40. ModifySnapshotPolicyDisplayName 接口描述 修改快照策略描述 修改快照策略描述属性需要通过登陆认证获取令牌。 通过ListAllSnapshotPolicies接口查询快照策略对名称描述进行修改。 通过所提供的id查询到对应的快照策略，再将要修改的快照策略描述名称的属性重新设置更新。 请求参数 <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> 是 </td> <td> 快照策略Id 可通过ListAllSnapshotPolicies接口查询快照策略信息。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 快照策略显示名 请填写中文, 英文字母, 数字，空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   41. RevertSnapshot 接口描述 快照回滚 快照回滚需要通过登陆认证获取令牌。 通过ListAllSnapshots查询快照进行操作快照回滚。 通过id先查询到快照，再通过快照查询到磁盘。 然后加已判断。 如果是已到期云主机，到达强制关机时间，包月的云磁盘一旦关机，不允许回滚磁盘 满足回滚要求的则调用revertSnapshot方法进行快照回滚。 接口为异步job回滚  查看快照回滚是否成功 请求参数 <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> 是 </td> <td> 快照Id 需要进行回滚的快照id 长度最长36 </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>   42. SyncSnapshot 接口描述   请求参数 <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> 是 </td> <td>   </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td>   </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td>   </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </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> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>

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