API 描述

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

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题