API描述

<p><strong>AttachDiskToInstance</strong></p> <p><strong>接口描述</strong></p> <p>挂载云磁盘到云主机实例。</p> <p>调用接口是,需要注意:</p> <ul> <li> <p>云磁盘的状态必须为ToAttach(待挂载)。</p> </li> <li> <p>云磁盘类型必须和云主机类型对应。</p> </li> </ul> <p>调用该接口之前,可以调用ListDisks接口查询当前云磁盘的信息。</p> <p>调用该接口之前,可以调用ListAbleAttachInstance接口将查询出所有可挂载的云主机实例。</p> <p>该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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。</p> <p>可以调用ListAbleAttachInstance接口将查询出所有可挂载的云主机实例。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>任务 Id</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>CheckQuota</strong></p> <p><strong>接口描述</strong></p> <p>扩容时配额校验。</p> <p>校验内容:</p> <ul> <li>扩容后的磁盘大小不能小于原来的磁盘大小。</li> <li>单个实例磁盘大小配额。</li> <li>单块磁盘大小配额。</li> </ul> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>ebsId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>待扩容的云磁盘Id。</p> <p>此参数和size参数必须同时填写;和instanceId参数不能同时为null。</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><strong>响应参数</strong></p> <p>无</p> <p><strong>CreateDisk</strong></p> <p><strong>接口描述</strong></p> <p>创建一块或多块付费的数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。</p> <p>创建云磁盘需要通过登陆认证获取令牌。</p> <p>创建云磁盘会涉及到资源计费,建议提前了解云磁盘EBS的计费方式。</p> <p>说明: 该接口已过期,不建议继续使用,创建磁盘请使用新接口CreateDiskNew。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Size</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘容量大小,单位:GB。</p> <p>必填项</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>云磁盘在门户界面显示名称。</p> <p>云磁盘显示名称的长度最大为20,如果超过最大长度,则会抛出ParameterValidate异常。</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> <p>必填项</p> <p>云主机实例Id 决定了创建的云磁盘将要挂载在哪个的云主机实例上。</p> <p>可以通过ListInstances接口查询云主机实例信息。</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>云磁盘产品规格。</p> <p>门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格ebs.s1。</p> <p>可以通过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>需要创建云磁盘数量。</p> <p>默认情况下为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>云磁盘标签。</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</p> <p>地域Id 决定了用户创建的云磁盘分布在哪里,例如华东1</p> <p>可以通过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</p> <p>一个地域下可能有多个可用区,可用区Id决定了用户创建的云磁盘分布的具体可用区,例如可用区A</p> <p>可以通过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>IsEncryption</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否需要加密。 默认不加密。</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>云磁盘是否需要备份存储</p> <p>默认不备份</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>云磁盘的计费方式。</p> 计费方式枚举如下: <ul> <li> <p>Hour: 按小时计费。</p> </li> <li> <p>Usage: 按量计费。</p> </li> <li> <p>PreUsage: 按量预付费。</p> </li> <li> <p>Monthly: 包月计费。</p> </li> <li> <p>Free: 免费。</p> </li> <li> <p>Annual: 包年计费。</p> </li> <li> <p>目前创建云磁盘的计费方式固定为Hour。</p> </li> </ul> </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> </tbody> </table> <p><strong>CreateDiskNew</strong></p> <p><strong>接口描述</strong></p> <p>创建一块或多块付费的数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。</p> <p>创建云磁盘需要通过登陆认证获取令牌。</p> <p>创建云磁盘会涉及到资源计费,建议提前了解云磁盘EBS的计费方式。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Size</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘容量大小,单位:GB。</p> <p>必填项</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>云磁盘在门户界面显示名称。</p> <p>云磁盘显示名称的长度最大为20,如果超过最大长度,则会抛出ParameterValidate异常。</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>云磁盘产品规格。</p> <p>门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格ebs.s1。</p> <p>可以通过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>需要创建云磁盘数量。</p> <p>默认情况下为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>云磁盘标签。</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。</p> <p>必填项</p> <p>地域Id 决定了用户创建的云磁盘分布在哪里,例如华东1。</p> <p>可以通过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。</p> <p>必填项</p> <p>一个地域下可能有多个可用区,可用区Id决定了用户创建的云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过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>创建云磁盘时所使用的快照。</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> <p>必填项</p> <p>云主机实例Id 决定了创建的云磁盘将要挂载在哪个的云主机实例上。</p> <p>可以通过ListAbleAttachInstance接口查询可挂载的云主机实例信息。</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</p> <p>地域Id 决定了用户创建的云磁盘分布在哪里,例如华东1</p> <p>可以通过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</p> <p>一个地域下可能有多个可用区,可用区Id决定了用户创建的云磁盘分布的具体可用区,例如可用区A</p> <p>可以通过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>创建云磁盘所使用的的快照</td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsEncryption</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否需要加密</p> <p>默认不加密</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>云磁盘是否需要备份存储</p> <p>默认不备份</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>云磁盘的计费方式。</p> 计费方式枚举如下: <ul> <li> <p>Hour: 按小时计费</p> </li> <li> <p>Usage: 按量计费</p> </li> <li> <p>PreUsage: 按量预付费</p> </li> <li> <p>Monthly: 包月计费</p> </li> <li> <p>Free: 免费</p> </li> <li> <p>Annual: 包年计费</p> </li> <li> <p>目前创建云磁盘的计费方式固定为Hour</p> </li> </ul> </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> </tbody> </table> <p><strong>DeleteDisk</strong></p> <p><strong>接口描述</strong></p> <p>释放付费数据云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。</p> <p>释放云磁盘需要通过登陆认证获取令牌。</p> <p>只有当云磁盘的状态为如下几种之一时,才能释放,否则抛出异常:</p> <ul> <li>Available(可用)</li> <li>CreateFailed(创建失败)</li> <li>DestroyFailed(删除失败)</li> <li>ToAttach(待挂载)</li> </ul> <p>目前删除云磁盘会同步删除该云磁盘对应快照(包括手动快照和自动快照),可以通过设置needDeleteSnapshot=false来关闭该功能。</p> <p>该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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><strong>DetachDisk</strong></p> <p><strong>接口描述</strong></p> <p>从云主机实例上卸载付费云磁盘。云磁盘的类型可通过ListAllEbsTypes接口查询。</p> <p>卸载云磁盘需要通过登陆认证获取令牌。</p> <p>使用该接口时,需要注意:</p> <ul> <li>云磁盘的EnableFlag属性必须是true。</li> <li>云磁盘必须已经挂载到云主机实例。</li> <li>云磁盘的状态必须为Available或者DestroyFailed。</li> <li>与磁盘的计费方式不能为 Monthly(按月付费)。</li> <li>可以通过ListDisks接口查询云磁盘信息的上述信息。</li> <li>该接口是异步操作,接口调用成功返回信息后需要等待片刻才能完成。</li> </ul> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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><strong>GetDisk</strong></p> <p><strong>接口描述</strong></p> <p>根据云磁盘Id获取云磁盘详细信息。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>DiskDetail</p> </td> <td> <p>EbsDetailBean</p> </td> <td> <p>云磁盘详细信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>ListAbleAttachInstance</strong></p> <p><strong>接口描述</strong></p> <p>查询云磁盘可挂载的所有云主机实例。</p> <p>该接口通常是在调用AttachDiskToInstance接口之前调用,用来保证云磁盘将要挂载的云主机类型状态的有效性。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> <p>Id和EbsTypeId至少存在一个参数。</p> </td> <td> <p>待挂载的云磁盘Id。</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。</p> <p>地域Id 决定了云磁盘分布在哪里,例如华东1。</p> <p>可以通过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。</p> <p>一个地域下可能有多个可用区,可用区Id决定了云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过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。</p> <p>一个可用区下可能有多个高可用域,高可用域Id决定了云磁盘所在的具体位置,例如深圳C1。</p> <p>可以通过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>分页页码。</p> <p>分页查询时使用。</p> <p>默认值为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>分页大小。</p> <p>分页查询时使用。</p> <p>默认值为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>排序关键字。</p> <p>查询时指定按照哪个关键字将返回的数据进行排序。</p> <p>默认按时间排序</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>排序方式。</p> <p>默认按DESC排序</p> <p>和排序关键字搭配使用,表示按照升序还是降序排列,取值如下:</p> <p>ASC:升序</p> <p>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</p> 云主机分类,取值为: <ul> <li> <p>Ecs: 独立云主机</p> </li> <li> <p>Caas: 集群云主机</p> </li> <li> <p>Dedicated: 专属云主机</p> </li> <li> <p>AutoScaling:弹性伸缩</p> </li> <li> <p>GBD: 大数据云主机</p> </li> <li> <p>FORTRESS: 堡垒机</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>EbsTypeId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> <p>Id和EbsTypeId至少存在一个参数。</p> </td> <td> <p>云磁盘产品规格Id。</p> <p>门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格名称为ebs.s1。</p> <p>可以通过ListAllEbsTypes接口查询云磁盘产品规格信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Instances</p> </td> <td> <p>List</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><strong>ListAbleRelateDisks</strong></p> <p><strong>接口描述</strong></p> <p>查询出所有能被快照策略关联的云磁盘列表。</p> <p>调用接口时,需要注意:该接口返回的数据为分页数据,默认情况下页码值为1,每页显示数据条数为10。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘所属的地域Id。</p> <p>地域Id 决定了云磁盘分布在哪里,例如华东1。</p> <p>可以通过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>快照策略的周期。</p> 取值如下: <ul> <li> <p>MANUAL: 手动</p> </li> <li> <p>HOURLY: 小时</p> </li> <li> <p>DAILY: 天</p> </li> <li> <p>WEEKLY: 星期</p> </li> <li> <p>MONTHLY:月</p> </li> </ul> </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。</p> <p>一个地域下可能有多个可用区,可用区Id决定了云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过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>分页页码。</p> <p>分页查询时使用。</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>分页大小。</p> <p>分页查询时使用。</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>排序关键字。</p> <p>查询时指定按照哪个关键字将返回的数据进行排序。</p> <p>默认按时间排序</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>排序方式。</p> <p>默认按DESC排序</p> 和排序关键字搭配使用,表示按照升序还是降序排列,取值如下: <ul> <li> <p>ASC:升序</p> </li> <li> <p>DESC:降序</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云磁盘类型。</p> <p>设置了该值之后,则只会查询出对应类型的云磁盘。</p> 与磁盘类型取值如下: <ul> <li> <p>ROOT:系统盘</p> </li> <li> <p>DATADISK:数据盘</p> </li> </ul> </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</p> <p>设置了该值之后,则只会查询出该数组中对应的云主机所挂载的云磁盘。</p> 云主机分类,取值为: <ul> <li> <p>Ecs: 独立云主机</p> </li> <li> <p>Caas: 集群云主机</p> </li> <li> <p>Dedicated: 专属云主机</p> </li> <li> <p>AutoScaling:弹性伸缩</p> </li> <li> <p>GBD: 大数据云主机</p> </li> <li> <p>FORTRESS: 堡垒机</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Disks</p> </td> <td> <p>List</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><strong>ListAllEbsTypes</strong></p> <p><strong>接口描述</strong></p> <p>查询云磁盘产品规格。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘所属的地域Id。</p> <p>地域Id 决定了云磁盘分布在哪里,例如华东1。</p> <p>可以通过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。</p> <p>一个地域下可能有多个可用区,可用区Id决定了云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>EbsTypes</p> </td> <td> <p>List</p> </td> <td> <p>云磁盘产品规格信息列表。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>ListDiskByPolicyId</strong></p> <p><strong>接口描述</strong></p> <p>查询出关联同一快照策略的磁盘列表。</p> <p>调用接口时,需要注意:</p> <ul> <li>只能查询如下状态的云磁盘信息: <ul> <li> <p>ToAttach:待挂载</p> </li> <li> <p>Attaching:挂载中</p> </li> <li> <p>Deteaching:卸载中</p> </li> <li> <p>Available:可用</p> </li> <li> <p>Destroying:删除中</p> </li> <li> <p>DestroyFailed:删除失败</p> </li> </ul> </li> <li>云磁盘所在的云主机的状态必须在如下状态中: <ul> <li> <p>Running:运行中</p> </li> <li> <p>Stopped:已关机</p> </li> <li> <p>Starting:启动中</p> </li> <li> <p>Stopping:关机中</p> </li> <li> <p>Destroying:删除中</p> </li> </ul> </li> <li>返回的数据为分页查询结果,默认情况下页码为1,每页显示10条数据。</li> </ul> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>SnapshotPolicyId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘关联的快照策略Id。</p> <p>可以通过ListAllSnapshotPolicies接口获取快照策略信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Disks</p> </td> <td> <p>List</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><strong>ListDisks</strong></p> <p><strong>接口描述</strong></p> <p>查询云磁盘信息。</p> <p>调用接口时,需要注意:接口采用分页查询的方式,默认页码为1,每页显示1000条数据。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云磁盘所属的地域Id。</p> <p>地域Id 决定了云磁盘分布在哪里,例如华东1。</p> <p>可以通过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。</p> <p>一个地域下可能有多个可用区,可用区Id决定了云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过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>云磁盘所属的可用区名称。</p> <p>一个地域下可能有多个可用区,可用区名称决定了云磁盘分布的具体可用区,例如可用区A。</p> <p>可以通过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。</p> <p>云主机实例Id 表示云磁盘所挂载的云主机实例标识。</p> <p>可以通过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>云主机实例名称。</p> <p>云主机实例名称 表示云磁盘所挂载的云主机实例标识。</p> <p>可以通过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>分页页码。</p> <p>分页查询时使用。</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>分页大小。</p> <p>分页查询时使用。</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>排序关键字。</p> <p>查询时指定按照哪个关键字将返回的数据进行排序。</p> <p>默认按时间排序。</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>排序方式。</p> <p>默认按DESC排序</p> 和排序关键字搭配使用,表示按照升序还是降序排列,取值如下: <ul> <li> <p>ASC:升序</p> </li> <li> <p>DESC:降序</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>DiskStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云磁盘状态数组。</p> <p>设置了该值之后,则只会查询出云磁盘状态在该数组中的云磁盘。</p> 云磁盘状态取值如下: <ul> <li> <p>ToCreate:待创建</p> </li> <li> <p>Pending:创建中</p> </li> <li> <p>Available:可用</p> </li> <li> <p>CreateFailed:创建失败</p> </li> <li> <p>Destroying:删除中</p> </li> <li> <p>Destroyed:已删除</p> </li> <li> <p>DestroyFailed:删除失败</p> </li> <li> <p>Cancel:取消</p> </li> <li> <p>ToAttach:待挂载</p> </li> <li> <p>Attaching:挂载中</p> </li> <li> <p>Deteaching:卸载中</p> </li> </ul> </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> <p>设置了该值之后,则只会查询出云磁盘标签在该数组中的云磁盘。</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</p> <p>设置了该值之后,则只会查询出该数组中对应的云主机所挂载的云磁盘。</p> 云主机分类,取值为: <ul> <li> <p>Ecs: 独立云主机</p> </li> <li> <p>Caas: 集群云主机</p> </li> <li> <p>Dedicated: 专属云主机</p> </li> <li> <p>AutoScaling:弹性伸缩</p> </li> <li> <p>GBD: 大数据云主机</p> </li> <li> <p>FORTRESS: 堡垒机</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云磁盘类型。</p> <p>设置了该值之后,则只会查询出对应类型的云磁盘。</p> 与磁盘类型取值如下: <ul> <li> <p>ROOT:系统盘</p> </li> <li> <p>DATADISK:数据盘</p> </li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>Disks</p> </td> <td> <p>List</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><strong>ListEbsTypes</strong></p> <p><strong>接口描述</strong></p> <p>查询云磁盘产品规格。</p> <p>门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格名称为ebs.s1。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>ProductSeriesId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>待查询的产品系列Id。</p> <p>可以通过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。</p> <p>可以通过ListRegions接口查询区域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>EbsTypes</p> </td> <td> <p>List</p> </td> <td> <p>云磁盘产品规格信息列表。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>ModifyDiskAttribute</strong></p> <p><strong>接口描述</strong></p> <p>修改云磁盘属性。</p> <p>修改云磁盘的属性需要通过登陆认证获取令牌。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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>云磁盘修改后的显示名称。</p> <p>云磁盘显示名称的长度最大为20,如果超过最大长度,则会抛出ParameterValidate异常。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong>ModifyEbsAttribute</strong></p> <p><strong>接口描述</strong></p> <p>修改云磁盘的属性。</p> <p>修改云磁盘的属性需要通过登陆认证获取令牌。</p> <p>通过获取的磁盘id查询到需要修改的磁盘在进行判断,区分数据盘和系统盘,并判断是否为本地盘否则将会抛出异常提醒。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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> <p>无</p> <p><strong>UpgradeDisk</strong></p> <p><strong>接口描述</strong></p> <p>云磁盘扩容。</p> <p>扩容云磁盘需要通过登陆认证获取令牌。</p> <p>扩容云磁盘会涉及到资源计费,建议提前了解云磁盘EBS的计费方式。</p> <p>调用该接口时,需要注意:</p> <ul> <li>只有数据盘(类型为DATADISK)才能扩容,系统盘(类型为ROOT)不能扩容。</li> <li>云磁盘的状态为 Available 或 Destroyfailed 才能扩容。</li> <li>云磁盘的操作状态为Normal时才能扩容。</li> <li>扩容后的磁盘容量不能小于原来磁盘容量。</li> <li>对于已到期的磁盘不能进行扩容。</li> <li>如果云磁盘计费方式是包年/包月,则要重新计算云磁盘开始时间、到期时间及周期。</li> </ul> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>是否必须</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <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。</p> <p>可以通过支付服务里的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> <caption>&nbsp;</caption> <thead> <tr> <th> <p><strong>参数名称</strong></p> </th> <th> <p><strong>参数类型</strong></p> </th> <th> <p><strong>参数描述</strong></p> </th> <th> <p><strong>备注</strong></p> </th> </tr> </thead> <tbody> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>云磁盘的计费方式。</p> 计费方式枚举如下: <ul> <li> <p>Hour: 按小时计费</p> </li> <li> <p>Usage: 按量计费</p> </li> <li> <p>PreUsage: 按量预付费</p> </li> <li> <p>Monthly: 包月计费</p> </li> <li> <p>Free: 免费</p> </li> <li> <p>Annual: 包年计费</p> </li> </ul> <p>目前创建云磁盘的计费方式固定为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> </tbody> </table>
以上内容是否解决了您的问题?
请补全提交信息!
联系我们

电话咨询

400-151-8800

邮件咨询

fincloud@ocft.com

在线客服

工单支持

解决云产品相关技术问题