API 描述

<p><span style="font-size:16px"><strong>1.&nbsp;ListCalculateEbsSeries</strong></span></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><span style="font-size:16px"><strong>2.&nbsp;ListDedicatedEbsProductSeries</strong></span></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><span style="font-size:16px"><strong>3.&nbsp;ListEbsProductSeries</strong></span></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><span style="font-size:16px"><strong>4.&nbsp;CreateDedicatedHost</strong></span></p> <p><strong>接口描述</strong></p> <p>创建专属宿主机</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</p> <p>专属宿主机的可用区,创建的时候由用户选择必传字段,类型:n(正整数)</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>专属宿主机的高可用域,创建的时候由用户选择。</p> <p>必传字段,类型:n(正整数)</p> <p>会进行实体校验,校验失败,抛出异常 InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostTypeId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品规格ID<br /> 产品类型,管理员配置属性<br /> 必传字段<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VirtaulType</p> </td> <td> <p>HypervisorType</p> </td> <td> <p>是</p> </td> <td> <p>虚拟类型<br /> 专属宿主机默认类型KVM<br /> 必传字段</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>是</p> </td> <td> <p>计费方式<br /> 专属宿主机暂只支持月付费<br /> 必传字段</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>期数<br /> 必传字段</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>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>显示名称<br /> 必传字段<br /> 请填写中文, 英文字母, 数字, 空格,@ 和 _, -, 最长128个字符</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CpuOverScoreRate</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>CPU超分比<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 /> 专属宿主机目前只支持包月</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><span style="font-size:16px"><strong>5.&nbsp;&nbsp;&nbsp; DestroyDedicatedHost</strong></span></p> <p><strong>接口描述</strong></p> <p>删除专属宿主机</p> <ul> <li>如果选择删除的专属宿主机状态为 : Pending Destroying Destroyed 会抛出PacloudException。</li> <li>删除的宿主机为软删除,修改状态&nbsp; EnableFlag =false&nbsp; 以及status = destroyed。</li> </ul> <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 /> 会进行实体校验,校验失败,抛出异常InvalidParameterException</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><span style="font-size:16px"><strong>6.&nbsp;&nbsp;&nbsp; GetDedicatedEcsSummary</strong></span></p> <p><strong>接口描述</strong></p> <p>获取专属宿主机概览</p> <ul> <li>获取专属宿主机的相关信息,如:台数、内存大小、cpu、磁盘空间、实例总数等。</li> <li>入参为 regionID。</li> </ul> <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 style="width:477px"> <p><strong>参数描述</strong></p> </td> <td style="width:88px"> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td style="width:477px"> <p>地域ID<br /> 必传字段,会进行实体校验,判断是否存在该地域,校验不过抛出异常InvalidParameterException</p> </td> <td style="width:88px"> <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>HostSum</p> </td> <td> <p>Long</p> </td> <td> <p>宿主机总数<br /> 单位:台</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>云主机实例总数<br /> 单位:个</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSum</p> </td> <td> <p>Long</p> </td> <td> <p>磁盘总数<br /> 单位:个</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><span style="font-size:16px"><strong>7.&nbsp;&nbsp;&nbsp; ListDedicatedHostTypes</strong></span></p> <p><strong>接口描述</strong></p> <p>查询专属宿主机规格</p> <ul> <li>支持专属宿主机规格查询,专属宿主机规格为管理员配置。</li> <li>用于创建专属宿主机提供规格配置。</li> </ul> <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 /> 必传字段<br /> 数据来自于 base 服务</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 /> 数据来自于 base 服务</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PodUuid</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>高可用域id<br /> 必传字段<br /> 数据来自于 iaas 服务</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>DedicatedHostTypes</p> </td> <td> <p>List&lt;DedicatedHostTypeBean&gt;</p> </td> <td> <p>专属宿主机规格信息列表<br /> 管理员配置的专属宿主机规格信息包含:定价、内存、cpu 等信息 详情点开Bean</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>专属宿主机总数<br /> 所有配置的有效专属宿主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><span style="font-size:16px"><strong>8.&nbsp;&nbsp;&nbsp; ListDedicatedHosts</strong></span></p> <p><strong>接口描述</strong></p> <p>查询专属宿主机<br /> 分页查询专属宿主机,支持条件查询,支持排序,默认 id desc 排序方式。</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>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>ZoneName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>可用区名称<br /> 专属宿主机在创建需要选定具体可用区,例如可用区A。<br /> 可以通过ListZonesAction接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>HostStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>专属宿主机状态<br /> 判断当前宿主机的创建或运行状态</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> </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> </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 /> 默认按时间排序</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和ASC,默认按DESC排序</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 /> 会进行实体校验,数据来源于base 服务,不存在该实体校验失败,抛出异常 InvalidParameterException</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 /> 会进行实体校验,数据来源于iaas 服务,不存在该实体校验失败,抛出异常 InvalidParameterException</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 /> 会进行实体校验,数据来源于base 服务 ,不存在该实体校验失败,抛出异常 InvalidParameterException</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>DedicatedHosts</p> </td> <td> <p>List&lt;DedicatedHostBean&gt;</p> </td> <td> <p>专属宿主机信息列表<br /> 用于专属宿主机页面展示详细信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>数量<br /> 有效专属宿主机数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><span style="font-size:16px"><strong>9.&nbsp;&nbsp;&nbsp; ModifyHostAttribute</strong></span></p> <p><strong>接口描述</strong></p> <p>修改专属宿主机属性</p> <ul> <li>主要针对专属宿主机 disPlayName 提供修改。</li> <li>根据 uuid 找到对应专属宿主机,修改disPlayName属性。</li> </ul> <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 /> 会进行实体校验,数据来自于 Table:dedicated_host<br /> 校验失败,抛出异常 InvalidParameterException</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> <p>无</p> <p><span style="font-size:16px"><strong>10. ModifyHostCpuOverScore</strong></span></p> <p><strong>接口描述</strong></p> <p>修改专属宿主机的CPU超分比</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 /> 会进行实体校验,数据来自于 Table:dedicated_host<br /> 校验失败,抛出异常 InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CpuOverScoreRate</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>CPU超分比<br /> 必传字段</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><span style="font-size:16px"><strong>11. RenewDedicatedHost</strong></span></p> <p><strong>接口描述</strong></p> <p>专属宿主机续费</p> <ul> <li>专属宿主机续费需要校验宿主机续费类型是否为包月,否则抛出异常 IncorrectStatusException。</li> <li>续费条件包括专属宿主机状态不能为Pending Createfial Destory 等失效状态。</li> <li>针对新的期数进行续费。</li> </ul> <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 /> 会进行实体校验,数据来自于 Table:dedicated_host<br /> 校验失败,抛出异常 InvalidParameterException</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>响应参数</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>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><strong><span style="font-size:16px">12.&nbsp; ChangeDedicatedInstanceType</span></strong></p> <p><strong>接口描述</strong></p> <p>修改专属云主机规格</p> <ul> <li>修改规格期间,主机必须关机,修改值跟原值有差异,配额有效机器无其他操作等,否则抛出异常 InvalidParameterException。</li> <li>修改为异步 job 任务方式执行,返回jobuuid 可根据jobuuid 查看任务是否执行成功。</li> </ul> <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>CPUNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>专属云主机 CPU 核数</p> <p>必传字段</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Memory</p> </td> <td> <p>Integer</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 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><strong><span style="font-size:16px">13.&nbsp;&nbsp;DestroyDedicatedInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>删除专属云主机实例</p> <ul> <li>只支持停止状态、创建失败状态的云主机进行删除.</li> <li>接口为异步 job 执行删除 返回job uuid 可查询jobuuid 看任务是否执行成功。</li> </ul> <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</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CheckDependency</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否检查资源依赖关系,默认true<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>JobId</p> </td> <td> <p>String</p> </td> <td> <p>任务 ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">14. ListDedicatedInstanceCpus</span></strong></p> <p><strong>接口描述</strong></p> <p>查询所有专属云主机类型的cpu。<br /> 获取所有专属云主机核心数种类。</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> </tr> <tr> <td> <p>Cpus</p> </td> <td> <p>List&lt;Integer&gt;</p> </td> <td> <p>专属云主机CPU信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">15. ListDedicatedInstanceMemorys</span></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>Cpu</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>专属云主机CPU数<br /> 专属物理机上创建的云主机的CPU核心数</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>Memorys</p> </td> <td> <p>List&lt;Integer&gt;</p> </td> <td> <p>专属云主机内存信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">16. ListDedicatedInstanceTypes</span></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>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> </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>InstanceTypeBeanList</p> </td> <td> <p>List&lt;InstanceTypeBean&gt;</p> </td> <td> <p>云主机类型信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">17.&nbsp; RunDedicatedInstances</span></strong></p> <p><strong>接口描述</strong></p> <p>创建专属云主机</p> <ul> <li>批量创建专属云主机在专属宿主机上。</li> <li>创建为异步创建返回jobuuid,可用返回的uuid去查询是否创建成功。</li> </ul> <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 /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListRegionsAction 查询详细信息</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 /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListZonesAction 查询详细信息</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 /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListPodsAction 查询详细信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域Id<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListNetWorksAction 查询详细信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>子网Id<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListSubnetsAction 查询详细信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>操作系统镜像Id<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListImagesAction 查询详细信息</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>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>FunctionNames</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>方法名称<br /> 安全配置<br /> 用于判断是否安装免费HIDS</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Userdata</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>用户信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>UserdataBase64Encoded</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>64位编码用户信息<br /> 加密规则是否采用64加密策略 默认false</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 /> 必传字段,可通过base 服务 DTO 方式查询详细信息<br /> 门户中每种云磁盘类型都对应着相应的云磁盘产品规格,例如SSD型云硬盘对应的产品规格名称为ebs.s1。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSizes</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>磁盘大小列表<br /> 单个磁盘的大小取值范围为20-2000</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskCount</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>磁盘数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>主机ID<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过ListDedicatedHostsAction 查询详细信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VmhostNames</p> </td> <td> <p>String[]</p> </td> <td> <p>否</p> </td> <td> <p>虚拟机主机名称列表<br /> 每个主机名以字母开头, 允许字母, 数字, -, 最长45个字符<br /> 多个主机名称以英文逗号隔开</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>安全组UUID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>GeneratePasswordType</p> </td> <td> <p>GeneratePasswordType</p> </td> <td> <p>否</p> </td> <td> <p>云主机生成密码方式,默认为自定义</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceType</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品规格</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>密钥对ID,若密码生成方式为Key(密钥对),则keyId为必传参数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CustomPassword</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义密码,若密码生成方式为Custom(自定义),则keyId为必传参数<br /> 请输入8-16 个字符,必须同时包含三项(大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^&amp; 中的特殊符号)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PrivateKey</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私钥</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsInstallOracleKsplice</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否安装OracleKsplice插件</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ComponentNames</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>JobIds</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">18. StartDedicatedInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>启动专属云主机</p> <ul> <li>启动的云主机状态不能为 Stopped 否则抛出异常 IncorrectStatusException</li> <li>接口为异步job 执行返回job uuid&nbsp; 可根据job uuid 查询任务执行情况</li> </ul> <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>专属云主机UUID<br /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过 ListInstancesAction 查询详细信息</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><strong><span style="font-size:16px">19.&nbsp;StopDedicatedInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>关闭专属云主机</p> <ul> <li>在Running 的云主机不可关闭。</li> <li>接口为异步job 接口返回job uuid,可根据uuid查询接口关闭任务是否执行成功。</li> </ul> <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 /> 会进行实体校验,校验失败,抛出异常 InvalidParameterException<br /> 必传字段,可通过 ListInstancesAction 查询详细信息</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><strong><span style="font-size:16px">20. CancelShareImage</span></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>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像UUID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>BeSharedTenantId</p> </td> <td> <p>Long</p> </td> <td> <p>否</p> </td> <td> <p>被共享租户ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsShareCancel</p> </td> <td> <p>Boolean</p> </td> <td> <p>是</p> </td> <td> <p>是否共享者取消</p> <ul> <li>true表示共享者取消</li> <li>false表示被共享者取消</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">21. CreateImage</span></strong></p> <p><strong>接口描述</strong></p> <p>创建镜像</p> <ul> <li>创建镜像需要通过登陆认证获取令牌。</li> <li>调用接口应注意:云磁盘或者云主机必须存在一个,否则抛ParameterRequiredException异常。</li> </ul> <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 /> 云磁盘或者云主机必须存在一个,否则抛ParameterRequiredException异常<br /> 通过ListDisks可以查询云磁盘信息</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 /> 通过ListInstances可以查询云主机信息</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>Name</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像名称<br /> 由中文, 英文字母, 数字, @ 和 _, -组成 ,最长为 64 个字符</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Description</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>JobId</p> </td> <td> <p>String</p> </td> <td> <p>任务 ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">22. DeleteImage</span></strong></p> <p><strong>接口描述</strong></p> <p>根据镜ID删除镜像</p> <ul> <li>需要通过登陆认证获取令牌。</li> <li>调用接口注意:只有状态为Available、Unavailable、CreateFailed、DeleteFailed的镜像才能被删除。</li> </ul> <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 /> 通过ListImages接口可以查询镜像信息</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><strong><span style="font-size:16px">23.&nbsp; GetImage</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像ID<br /> 通过ListImages接口可以查询镜像信息</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>Image</p> </td> <td> <p>ImageBean</p> </td> <td> <p>镜像信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">24.&nbsp; ListImageShareTenants</span></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>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像UUID</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>分页页码,默认为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>分页大小,默认是为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 /> 默认按时间排序</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和ASC,默认按DESC排序</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> <tr> <td> <p>AccountBeans</p> </td> <td> <p>List&lt;AccountBean&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><strong><span style="font-size:16px">25. ListImages</span></strong></p> <p><strong>接口描述</strong></p> <p>查询所有镜像</p> <ul> <li>需要通过登陆认证获取令牌。</li> <li>调用接口时,需要注意:接口采用分页查询的方式,默认页码为1,每页显示100条数据。</li> </ul> <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。forCreateInstance为true或者不传的时候,为必填参数<br /> 一个地域下可能有多个可用区,可用区ID决定了镜像分布的具体可用区,例如可用区A。<br /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OsTypeId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像所属的操作系统类型ID<br /> 操作系统类型Id 决定了镜像属于哪中操作类型,例如:Linux。<br /> 可以通过ListOsTypes接口查询操作系统类型信息。</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>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>Status</p> </td> <td> <p>ImageStatus</p> </td> <td> <p>否</p> </td> <td> <p>镜像状态,例如:</p> <ul> <li>ToCreate&nbsp; 待创建</li> <li>Pending&nbsp;&nbsp; 创建中</li> <li>CreateFailed 创建失败</li> <li>Available&nbsp; 可用</li> <li>Unavailable&nbsp; 失效</li> <li>Deleting&nbsp; 删除中</li> <li>Deleted&nbsp;&nbsp; 已删除</li> <li>DeleteFailed 删除失败</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>UseType</p> </td> <td> <p>ImageType</p> </td> <td> <p>否</p> </td> <td> <p>镜像使用类型,例如:</p> <ul> <li>PUBLIC&nbsp; 公有</li> <li>SPECIAL&nbsp; 专用,分为两种,一种是基于现有实例创建的镜像,一种为手动上传且启用主机功能</li> <li>NO_AGENT 手动上传且不启用主机功能</li> </ul> </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>分页大小<br /> 分页查询时使用。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ForCreateInstance</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否可以创建主机,默认为可以</p> <ul> <li>值为true时,可以创建主机</li> <li>值为false时,不可以创建主机</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsQueryShare</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否查询共享镜像,默认false</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>Images</p> </td> <td> <p>List&lt;ImageBean&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><strong><span style="font-size:16px">26. ListOsMappingCsOs</span></strong></p> <p><strong>接口描述</strong></p> <p>根据地域和可用区筛选出所有操作系统映射到CS操作系统对应关系</p> <ul> <li>需要通过登陆认证获取令牌。</li> <li>可以通过ListRegions接口查询区域信息。</li> <li>通过ListZones接口查询可用区信息。</li> </ul> <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>操作系统映射到CS操作系统对应关系所属的地域ID。<br /> 地域ID决定了操作系统映射到CS操作系统对应关系分布在哪里,例如华东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>操作系统映射到CS操作系统对应关系所属的可用区ID。<br /> 一个地域下可能有多个可用区,可用区Id决定了操作系统映射到CS操作系统对应关系分布的具体可用区,例如可用区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>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>查询到的总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OsTypes</p> </td> <td> <p>List&lt;OsMappingCsOsBean&gt;</p> </td> <td> <p>操作系统映射到CS操作系统对应关系详细信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">27.&nbsp;ListOsTypes</span></strong></p> <p><strong>接口描述</strong></p> <p>查询操作系统类型<br /> 需要通过登陆认证获取令牌。<br /> 调用接口时,需要注意:<br /> 1、接口采用分页查询的方式,默认页码为1,每页显示10条数据,排序为升序排列。<br /> 2、如果分页大小超过3000,则设置为3000</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>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>Description</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>操作系统类型描述</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OsCategory</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>操作系统类型,如下:</p> <ul> <li>LINUX,</li> <li>WINDOWS,</li> <li>UNIX,</li> <li>AIX</li> </ul> </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 /> 默认按时间排序</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 /> 和排序关键字搭配使用,表示按照升序还是降序排列,取值如下:</p> <ul> <li>ASC:升序</li> <li>DESC:降序</li> </ul> </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>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>操作系统类型信息列表总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OsTypes</p> </td> <td> <p>List&lt;OsTypeBean&gt;</p> </td> <td> <p>操作系统类型信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">28. ManualUploadImage</span></strong></p> <p><strong>接口描述</strong></p> <p>手动上传镜像<br /> 需要通过登陆认证获取令牌。<br /> 通过ListImages接口可以查询所有镜像。</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>Url</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>OBS存放的镜像url</p> </td> <td> <p>调用OBS的接口【GetObjectIntranetPaUrl】获取url</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像名称<br /> 请填写中文, 英文字母, 数字, 空格,@ 和 _, -, 最长64个字符</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Displaytext</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> <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>Hypervisor</p> </td> <td> <p>HypervisorType</p> </td> <td> <p>否</p> </td> <td> <p>虚拟管理类型,比如:KVM,VMware<br /> 默认为KVM类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Ostypeid</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像所属的操作系统类型ID<br /> 调用ListOsMappingCsOs接口可以查询对应的cs操作系统类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Isfeatured</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否为精选,默认为true(精选)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Ispublic</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否为公有,默认为true(公有)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Passwordenabled</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否已启用密码,默认为true(已启用密码)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Requireshvm</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否需要HVM,默认为false(不需要HVM)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Isdynamicallyscalable</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否可动态扩展,默认为true(可以动态扩展)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsAgent</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否启用主机功能,默认为true(开启主机功能)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Format</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>文件类型,默认QCOW2<br /> 取值如下:QCOW2, RAW, VHD and OVA</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Checksum</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>MD5<br /> 允许英文字母、&nbsp;数字,最长 32 个字符</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Isextractable</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否可提取,默认为true(可以提取)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Isrouting</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否可以路由,默认为false(不可以路由)</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><strong><span style="font-size:16px">29. ManualUploadImageCheck</span></strong></p> <p><strong>接口描述</strong></p> <p>手动上传镜像时校验URL。<br /> 该接口只针对上传镜像时对URL的路径校验是否符合规范。</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 /> 一个地域下可能有多个可用区,可用区ID决定了镜像分布的具体可用区,例如可用区A。<br /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Url</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>OBS存放的镜像url</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">30. ModifyImageAttribute</span></strong></p> <p><strong>接口描述</strong></p> <p>根据镜像的ID修改镜像的属性。<br /> 需要通过登陆认证获取令牌。<br /> 通过ListImages接口可以查询所有镜像。</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 /> 通过ListImages接口可以查询所有镜像</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> <p>无</p> <p>&nbsp;</p> <p><strong><span style="font-size:16px">31. ShareImage</span></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>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像uuid</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TenantName</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> <p>无</p> <p><strong><span style="font-size:16px">32. SyncImage</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>镜像ID<br /> 必传项<br /> 通过ListImages接口可以查询所有镜像</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>zone的uuid</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> <p><strong><span style="font-size:16px">33. BatchDestroyInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>批量删除云主机,最多支持批量10台</p> <ol> <li>起多个job进行删除,一个主机对应一个job</li> <li>只有关机和创建失败状态的主机才能执行此操作</li> <li>单个主机的删除失败不会影响其他主机的删除</li> <li>有安全产品、有依赖资源的云主机不能删除</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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>Ids</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID,多个云主机ID需进行字符串拼接,ID之间使用英文逗号(,)进行分隔<br /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">34. BatchModifyChargeTypeInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>批量按量转包月,最多支持批量20台。</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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID,多个云主机ID需进行字符串拼接,ID之间使用英文逗号(,)进行分隔<br /> 可以通过ListInstance接口可以查看所有的云主机的ID</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>期数。最小1,最大36。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AutoRenewflag</p> </td> <td> <p>Boolean</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>&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>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><strong><span style="font-size:16px">35.BatchRenewInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>批量续费云主机,最多支持批量20台。</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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID,多个云主机ID需进行字符串拼接,ID之间使用英文逗号(,)进行分隔<br /> 可以通过ListInstance接口可以查看所有的云主机的ID</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>续费期数。最小1,最大36。</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>&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>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><strong><span style="font-size:16px">36. BatchStartInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>批量开启云主机</p> <ol> <li>起多个job进行开机,一个主机对应一个job</li> <li>只有关机状态的主机才能执行此操作</li> <li>单个主机的启动失败不会影响其他主机的启动</li> <li>过期的包月云主机不支持开机操作</li> <li>租户欠费不能进行开机操作</li> <li>批量开机会进行费用结算</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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>Ids</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID,多个云主机ID需进行字符串拼接,ID之间使用英文逗号(,)进行分隔<br /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">37. BatchStopInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>批量关闭云主机</p> <ol> <li>起多个job进行关机,一个主机对应一个job</li> <li>只有运行中状态的主机才能执行此操作</li> <li>单个主机的关机失败不会影响其他主机的关机操作</li> <li>批量关机会对费用进行一次结算</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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>Ids</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID,多个云主机ID需进行字符串拼接,ID之间使用英文逗号(,)进行分隔<br /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">38.&nbsp;BatchUpdateAutoRenewFlag</span></strong></p> <p>接口描述</p> <p>修改云主机是否自动续费</p> <ol> <li>主机是包月的条件下才能修改。</li> <li>已到期或者今天到期的云主机不能修改是否自动续费。</li> </ol> <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>Ids</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>AutoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>是</p> </td> <td> <p>是否自动续费</p> <ul> <li>true为自动续费</li> <li>false为非自动续费</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">39. CancelRelateInstance</span></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>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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>关联的实例ID(ID以&ldquo;,&rdquo;分割)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">40.CheckInstanceName</span></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>Names</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机名称,多个云主机名称需进行字符串拼接,名称之间使用英文逗号(,)进行分隔<br /> 用户自定的主机名称不能是已存在的且只能由数字和字母、中划线组成,第一个必须为英文字母,字符长度最小为1,最大为45</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><strong><span style="font-size:16px">41. CheckIpForCreateEcs</span></strong></p> <p><strong>接口描述</strong></p> <p>校验指定IP有效性</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>SubnetId</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>Ip</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>指定IP</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><strong><span style="font-size:16px">42. CopyInstance</span></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>Id</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> </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>InstanceCopyBean</p> </td> <td> <p>InstanceCopyBean</p> </td> <td> <p>云主机复制信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">43. CreateEcsScheduledRule</span></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>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>ScheduledType</p> </td> <td> <p>ScheduledType</p> </td> <td> <p>是</p> </td> <td> <p>定时任务类型,枚举类型;取值:Start,Stop</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RepeatType</p> </td> <td> <p>RepeatType</p> </td> <td> <p>是</p> </td> <td> <p>定时任务重复周期,枚举类型;取值:Once、Daily、Weekly、Monthly</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ScheduledDate</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>定时日期</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ScheduledTime</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>定时时间</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>BeginTime</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>定时任务开始时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>EndTime</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>定时任务结束时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>WeekType</p> </td> <td> <p>WeekType</p> </td> <td> <p>否</p> </td> <td> <p>定时星期几:MON、TUE、WED、THU、FRI、SAT、SUN</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">44.&nbsp;DeleteEcsScheduledRule</span></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>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> <p>无</p> <p><strong><span style="font-size:16px">45. DestroyInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>删除云主机</p> <ol> <li>只有关机或者创建失败的云主机才能删除</li> <li>有未支付的订单的主机不能删除</li> <li>该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放,则不能删除云主机</li> <li>checkDependency为true:释放云主机时,校验资源依赖关系,如存在依赖资源,需先删除依赖资源,才能释放云主机。checkDependency为false:释放云主机时,不校验资源依赖关系</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CheckDependency</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>释放云主机时是否检查资源依赖关系,默认值为true</p> <ul> <li>true:释放云主机时,校验资源依赖关系,如存在依赖资源,需先删除依赖资源,才能释放云主机</li> <li>false:释放云主机时,不校验资源依赖关系</li> </ul> </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><strong><span style="font-size:16px">46.&nbsp;DowngradeInstance</span></strong></p> <p>接口描述</p> <p>云主机降配<br /> 降配做的校验:</p> <ol> <li>未支付订单</li> <li>云主机必须关机,且不为包月过期云主机</li> <li>操作状态为 None</li> <li>必须与原实例类型不同,同时必须在同一个tag内</li> <li>价格不能高于原价格</li> <li>必须有足够的CPU和内存的配额</li> </ol> <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>Id</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>NewInstanceType</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>更改配置后的云主机类型<br /> 可以通过ListProductSeries接口查询产品系列信息。</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>期数,最小1,最大36<br /> 仅包月主机才需要传,通过GetRemainMonth接口查询期数</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>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><strong><span style="font-size:16px">47.&nbsp; GetAllEcsSummary</span></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 /> 可以通过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>InstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RunningInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>正在运行中的云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>StoppedInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>已关机的云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MonthlyInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>包月的云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ExpiredInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>已经到期的云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>WillexpireInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>即将到期的云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSum</p> </td> <td> <p>Long</p> </td> <td> <p>云磁盘总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SnapshotSum</p> </td> <td> <p>Long</p> </td> <td> <p>快照总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageSum</p> </td> <td> <p>Long</p> </td> <td> <p>镜像总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalSeparateInstance</p> </td> <td> <p>Long</p> </td> <td> <p>按地域对云主机、磁盘等进行分组统计的数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SeparateRegionInstance</p> </td> <td> <p>List&lt;InstanceOverviewBean&gt;</p> </td> <td> <p>保存根据地域对云主机、磁盘等资源进行分组统计的数量值</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">48. GetEcsSummary</span></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 /> 可以通过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>InstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>云主机总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSum</p> </td> <td> <p>Long</p> </td> <td> <p>云磁盘总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SnapshotSum</p> </td> <td> <p>Long</p> </td> <td> <p>快照总数</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">49. GetHeaderTitleCustom</span></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>ProductCode</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>HeaderTitleCustomBean</p> </td> <td> <p>HeaderTitleCustomBean</p> </td> <td> <p>用户自定义选项返回对象</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">50. GetInstance</span></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>Id</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> </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>InstanceDetail</p> </td> <td> <p>InstanceDetailBean</p> </td> <td> <p>云主机实例信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">51. GetInstancePassword</span></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>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>Password</p> </td> <td> <p>String</p> </td> <td> <p>密码</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">52.InstallAgent</span></strong></p> <p><strong>接口描述</strong></p> <p>安装云主机agent</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>安装agent的云主机ID<br /> 可以通过ListInstance接口可以查看所有的云主机的id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>FunctionName</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>方法名</p> </td> <td> <p>secagent表示安装PHS,mcafeeagent表示安装平安卫士</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><strong><span style="font-size:16px">53.&nbsp;InstallInstanceComponent</span></strong></p> <p><strong>接口描述</strong></p> <p>安装云主机组件,目前只支持安装windowsRDS。</p> <p>运行中主机/操作系统为WINDOWS才能安装。</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>ComponentName</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>安装的组件名称</p> </td> <td> <p>windowsRDS</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><strong><span style="font-size:16px">54. InstallOrUninstallOracleKsplice</span></strong></p> <p><strong>接口描述</strong></p> <p>安装平安热补丁</p> <ol> <li>只有运行中的主机且未安装热补丁才能安装热补丁</li> <li>通过登陆认证获取令牌</li> <li>安装中的主机不能重启或关机</li> <li>只有操作系统中配置支持安装热补丁且为LINUX才支持安装</li> </ol> <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>IsInstall</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否安装热补丁。<br /> 默认为true(安装)。</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><strong><span style="font-size:16px">55. InstallOracleKsplice</span></strong></p> <p><strong>接口描述</strong></p> <p>安装平安热补丁</p> <ol> <li>只有运行中的主机且未安装热补丁才能安装热补丁</li> <li>通过登陆认证获取令牌</li> <li>安装中的主机不能重启或关机</li> <li>只有操作系统中配置支持安装热补丁且为LINUX才支持安装</li> <li>GPU主机不能安装热补丁</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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> </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><strong><span style="font-size:16px">56. ListAbleKeyRelateInstancs</span></strong></p> <p><strong>接口描述</strong></p> <p>查询可用关联密钥对的云主机</p> <ol> <li>云主机状态必须为运行中状态</li> <li>分页显示</li> </ol> <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>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>PrivateIpAddress</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 /> 可以通过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 /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像ID<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像名称<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域ID<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域名称<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateName</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>分页页码,默认为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>分页大小,默认为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 /> 默认按时间排序。</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和ASC,默认按DESC排序</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>InstanceStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机状态,取值范围请查看枚举类型InstanceStatus</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<br /> 默认不传则为共享云主机,取值 InstanceCategory.Ecs | InstanceCategory.Caas</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>否</p> </td> <td> <p>计费类型,具体信息查看枚举类型ChargeType</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><strong><span style="font-size:16px">57. ListAllEcsScheduledRules</span></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>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>ScheduledType</p> </td> <td> <p>ScheduledType</p> </td> <td> <p>否</p> </td> <td> <p>定时任务类型,枚举类型;取值:Start,Stop</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RepeatType</p> </td> <td> <p>RepeatType</p> </td> <td> <p>否</p> </td> <td> <p>定时任务重复周期,枚举类型;取值:Once,Weekly</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>WeekType</p> </td> <td> <p>WeekType</p> </td> <td> <p>否</p> </td> <td> <p>星期,枚举类型;取值:MON、TUE、WED、THU、FRI、SAT、SUN</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>EcsScheduledRuleBean</p> </td> <td> <p>List&lt;EcsScheduledRuleBean&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><strong><span style="font-size:16px">58.&nbsp; ListAllRelatedInstances</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云主机IP<br /> 云主机ID<br /> 可以通过ListInstance接口可以查看所有的云主机的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>PrivateIpAddress</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私有网络地址</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PublicIpAddress</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 /> 可以通过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 /> 可以通过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 /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>VPC ID<br /> 可以通过ListVpcs接口查询VPC信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云主机类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>安全组ID<br /> 可以通过ListSecurityGroups接口查询安全组信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NotSecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>在这个安全组id范围之外的安全组ID<br /> 可以通过ListSecurityGroups接口查询安全组信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像ID<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像名称<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>子网ID<br /> 可以通过ListSubnets接口查询子网信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域ID<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域名称<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>创建人名称</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkType</p> </td> <td> <p>NetworkType</p> </td> <td> <p>否</p> </td> <td> <p>网络域类型,取值范围请查看枚举类型NetworkType</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>分页页码,默认为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>分页大小,默认是为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 /> 默认按时间排序</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和ASC,默认按DESC排序</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>InstanceStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机状态,取值范围请查看枚举类型InstanceStatus</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ErrorFlag</p> </td> <td> <p>InstanceErrorStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机错误状态,取值范围请查看枚举类型InstanceErrorStatus</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 /> 可以通过ListTags接口查询所有标签</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>是否为普通云主机,默认不传则为普通云主机,取值 Ecs和Caas<br /> 取值范围为{Ecs,Caas,Dedicated,AutoScaling,GBD,FORTRESS}</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>否</p> </td> <td> <p>计费类型,取值范围请查看枚举类型ChargeType</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VmHostName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>虚拟机主机名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateEip</p> </td> <td> <p>boolean</p> </td> <td> <p>否</p> </td> <td> <p>判断主机是否创建eip<br /> 若为true,则需对实例根据eip状态进行过滤,否则不过滤</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostId</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>ScheduledRuleId</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>IsRelated</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>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><strong><span style="font-size:16px">59.&nbsp; ListExpiredInstance</span></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</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> </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> </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><strong><span style="font-size:16px">60.&nbsp; ListExpiringInstance</span></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</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> </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> </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><strong><span style="font-size:16px">61. ListInstanceDependencies</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机的UUID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsDeleteFollowInstance</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>待查询的资源是否随云主机删除而删除。<br /> 该值为null时,表示查询出全部的依赖资源。</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>DependentInfoList</p> </td> <td> <p>List&lt;DependentInfoBean&gt;</p> </td> <td> <p>云主机依赖资源列表。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsDeleteFollowInstance</p> </td> <td> <p>Boolean</p> </td> <td> <p>查询出的资源是否随云主机删除而删除。</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">62. ListInstanceProductSeries</span></strong></p> <p><strong>接口描述</strong></p> <p>查询ECS相关的产品系列信息</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>ProductId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>产品UUID<br /> 产品详细信息参见ListProduct接口描述</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>产品名称<br /> 产品详细信参见ListProduct接口描述</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>地域uuid,<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>可用区UUID<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>高可用域UUID<br /> 高可用域详细信息参见接口ListPods说明</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsSupportAutoScaling</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>待查询ECS产品系列是否支撑弹性伸缩,<br /> 取值范围:</p> <ul> <li>true:待查询ECS产品系列支撑弹性伸缩</li> <li>false:待查询ECS产品系列不支撑弹性伸缩</li> <li>null:不论查询ECS产品系列是否支撑弹性伸缩,全部返回</li> </ul> </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>InstanceProductSeriesBeanList</p> </td> <td> <p>List&lt;InstanceProductSeriesBean&gt;</p> </td> <td> <p>ECS产品系列信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">63. ListInstanceProductSpec</span></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>PodId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>高可用域UUID</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>可用区UUID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MemoryCpuScale</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>Cpu倍频</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>产品规格UUID</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>ProductSeriesId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品系列UUID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</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>InstanceTypeBeanList</p> </td> <td> <p>List&lt;InstanceTypeBean&gt;</p> </td> <td> <p>云主机类型信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">64. ListInstanceTypes</span></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>PodId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>高可用域ID<br /> 如果云主机产品规格ID不存在,则ZoneId或PodId必须存在一个,且都存在时只有PodId有效。<br /> 可以通过ListPods接口查询可用域信息。</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不存在,则ZoneId或PodId必须存在一个,且都存在时只有PodId有效。<br /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MemoryCpuScale</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>Cpu倍频</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 /> 可以通过ListInstanceTypes接口查询云主机产品规格信息。</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 /> 可以通过ListProductSeries接口查询产品系列信息。</p> </td> <td> <p>&nbsp;</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> </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>InstanceTypes</p> </td> <td> <p>List&lt;InstanceTypeBean&gt;</p> </td> <td> <p>云主机类型信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">65. ListInstanceTypesByOperation</span></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>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>PodId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>高可用域ID<br /> 如果云主机产品规格Id不存在,则ZoneId或PodId必须存在一个,且都存在时只有PodId有效<br /> 可以通过ListPods接口查询可用域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductSpecId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机产品规格ID<br /> 可以通过ListInstanceTypes接口查询云主机产品规格信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsUpgrade</p> </td> <td> <p>Boolean</p> </td> <td> <p>是</p> </td> <td> <p>是否是升配</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</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>InstanceTypes</p> </td> <td> <p>List&lt;InstanceTypeBean&gt;</p> </td> <td> <p>云主机类型信息列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">66. ListInstances</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云主机IP<br /> 云主机ID<br /> 可以通过ListInstance接口可以查看所有的云主机的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>PrivateIpAddress</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私有网络地址</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PublicIpAddress</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 /> 可以通过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 /> 可以通过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 /> 可以通过ListZones接口查询可用区信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>VPC ID<br /> 可以通过ListVpcs接口查询VPC信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云主机类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>安全组ID<br /> 可以通过ListSecurityGroups接口查询安全组信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NotSecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>在这个安全组ID范围之外的安全组ID<br /> 可以通过ListSecurityGroups接口查询安全组信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像ID<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像名称<br /> 可以通过ListImages接口查询镜像信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>子网Id<br /> 可以通过ListSubnets接口查询子网信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域ID<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域名称<br /> 可以通过ListNetworks接口查询网络域信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>创建人名称</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkType</p> </td> <td> <p>NetworkType</p> </td> <td> <p>否</p> </td> <td> <p>网络域类型,取值范围请查看枚举类型NetworkType</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>分页页码,默认为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>分页大小,默认是为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 /> 默认按时间排序</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和ASC,默认按DESC排序</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>InstanceStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机状态,取值范围请查看枚举类型InstanceStatus</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ErrorFlag</p> </td> <td> <p>InstanceErrorStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机错误状态,取值范围请查看枚举类型InstanceErrorStatus</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 /> 可以通过ListTags接口查询所有标签</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>是否为普通云主机,默认不传则为普通云主机,取值 Ecs和Caas<br /> 取值范围为{Ecs,Caas,Dedicated,AutoScaling,GBD,FORTRESS}</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>否</p> </td> <td> <p>计费类型,取值范围请查看枚举类型ChargeType</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VmHostName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>虚拟机主机名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateEip</p> </td> <td> <p>boolean</p> </td> <td> <p>否</p> </td> <td> <p>判断主机是否创建eip<br /> 若为true,则需对实例根据eip状态进行过滤,否则不过滤</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostId</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>ScheduledRuleId</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>IsRelated</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>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><strong><span style="font-size:16px">67.ListKeyRelatedInstance</span></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>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>key 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>PrivateIpAddress</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> </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> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</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>ImageName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>镜像名称</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</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>NetworkName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域名称</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateName</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> </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> </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 /> 默认按时间排序</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和ASC,默认按DESC排序</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>InstanceStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>云主机状态<br /> 如果要按状态查询那必须展示所有(即showAll设置为true),否则只会默认查询运行中的。</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> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>计费类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ShowAll</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>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><strong><span style="font-size:16px">68.&nbsp;ListProductDynamicConfig</span></strong></p> <p><strong>接口描述</strong></p> <p>获取产品动态可配置列表</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> </tr> <tr> <td> <p>ListObject</p> </td> <td> <p>List&lt;Object&gt;</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">69. ModifyChargeType</span></strong></p> <p><strong>接口描述</strong></p> <p>按量转包月</p> <ol> <li>只有按量才能转包月</li> <li>创建中、创建失败、取消、释放、释放中状态都不能按量转包月</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的ID</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>期数。最小1,最大36</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AutoRenewflag</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>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><strong><span style="font-size:16px">70. ModifyEcsScheduledRule</span></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>Id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>云主机规则ID<br /> 可通过ListAllEcsScheduledRulesAction接口查询云主机规则信息。</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>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>ScheduledType</p> </td> <td> <p>ScheduledType</p> </td> <td> <p>是</p> </td> <td> <p>定时任务类型,枚举类型;取值:Start,Stop</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RepeatType</p> </td> <td> <p>RepeatType</p> </td> <td> <p>是</p> </td> <td> <p>定时任务重复周期,枚举类型;取值:Once、Daily、Weekly、Monthly</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ScheduledDate</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>定时日期</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ScheduledTime</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>定时时间</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>BeginTime</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>定时任务开始时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>EndTime</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>定时任务结束时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>WeekType</p> </td> <td> <p>WeekType</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><span style="font-size:16px">71. ModifyInstanceAttribute</span></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>Id</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 /> 请填写中文、英文字母、&nbsp;数字、空格、@ 和 _, -, 最长128个字符</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">72.&nbsp;OpenConsole</span></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>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> <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>ConsoleHttpUrl</p> </td> <td> <p>String</p> </td> <td> <p>云主机控制台地址</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">73. RelateInstance</span></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>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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>关联的实例id(id以&ldquo;,&rdquo;分割)</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> <tr> <td> <p>EcsInstanceScheduledRule</p> </td> <td> <p>List&lt;EcsInstanceScheduledRule&gt;</p> </td> <td> <p>关联的实例</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">74.RenewInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>云主机续费</p> <ol> <li>只有包月云主机才能续费</li> <li>创建中、创建失败、释放、释放中状态都不能续费</li> <li>主机下挂载的包月磁盘只能是可用状态</li> <li>此操作为异步进行,需要一定时间</li> </ol> <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>Period</p> </td> <td> <p>Integer</p> </td> <td> <p>是</p> </td> <td> <p>续费期数,最小1,最大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>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><strong><span style="font-size:16px">75. ResetPasswordForInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>重置云主机密码</p> <ol> <li>到期的包月云主机不能重置密码</li> <li>只有关机状态才能重置密码</li> <li>重置密码为异步操作</li> </ol> <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>GeneratePasswordType</p> </td> <td> <p>GeneratePasswordType</p> </td> <td> <p>否</p> </td> <td> <p>云主机生成密码方式,默认为随机生成<br /> 取值范围请查看枚举类型GeneratePasswordType,默认为Random(随机)<br /> 目前不支持密钥对</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CustomPassword</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义密码,若密码生成方式为Custom(自定义)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisableRootFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否禁用Root或Administrator账号</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><strong><span style="font-size:16px">76. RestartInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>重启云主机</p> <ol> <li>必须运行中的主机才能重启</li> <li>安装热补丁时不能重启</li> <li>此操作为异步进行,需要一定时间</li> <li>重启会对费用进行一次结算</li> </ol> <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>重启云主机<br /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">77. RestoreInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>云主机重装系统</p> <ol> <li>此操作为异步进行,需要一定时间</li> <li>包月云主机过期或按量云主机欠费不能重装系统</li> <li>只有关机云主机才能重装</li> <li>该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放,则不能重装云主机</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</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>CustomPassword</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>自定义密码,若密码生成方式为Custom(自定义),则keyId为必传参数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisableRootFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否禁用Root或Administrator账号</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InitUsername</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>JobId</p> </td> <td> <p>String</p> </td> <td> <p>任务ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">78. ResumeInstance</span></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>Id</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> </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><strong><span style="font-size:16px">79.RunInstances</span></strong></p> <p><strong>接口描述</strong></p> <p>创建云主机</p> <ol> <li>资源售罄则不可创建云主机</li> <li>云主机类型与磁盘类型匹配才能创建</li> <li>创建的主机数不能大于可用ip数</li> <li>如果安装安全组,则必须云主机与安全组在同一个网络域</li> <li>所用的镜像必须为可用状态</li> </ol> <p>说明:该接口已过期,不建议继续使用,创建主机请使用新接口RunInstancesByStep</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>DiskType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>磁盘类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSizes</p> </td> <td> <p>Integer[]</p> </td> <td> <p>否</p> </td> <td> <p>磁盘大小列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Eip</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>eip信息</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> </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> </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> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceType</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品规格</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</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>SubnetId</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>ImageId</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> <tr> <td> <p>ResourceGroupId</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>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>否</p> </td> <td> <p>计费类型</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> <tr> <td> <p>FunctionNames</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>方法名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Userdata</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>用户数据</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>UserdataBase64Encoded</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>64位用户数据</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>SecurityGroupId</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>VmhostNames</p> </td> <td> <p>String[]</p> </td> <td> <p>否</p> </td> <td> <p>用户云主机主机名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AutoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否自动续费</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>GeneratePasswordType</p> </td> <td> <p>GeneratePasswordType</p> </td> <td> <p>否</p> </td> <td> <p>云主机生成密码方式,默认为随机生成</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>密钥对ID,若密码生成方式为Key(密钥对),则keyId为必传参数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CustomPassword</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义密码,若密码生成方式为Custom(自定义),则keyId为必传参数。<br /> 请输入8 - 16 个字符,必须同时包含三项(大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^&amp; 中的特殊符号)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsInstallOracleKsplice</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否安装OracleKsplice插件</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PrivateKey</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私钥</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Ip</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>指定IP</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RootSize</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>root盘扩容后的大小</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RootDiskType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>root盘类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsRootUpgrade</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否root扩容</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceSourceType</p> </td> <td> <p>InstanceSourceType</p> </td> <td> <p>否</p> </td> <td> <p>主机来源</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisableRootFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否禁用Root或Administrator账号</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InitUsername</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义账户</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ComponentNames</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>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><strong><span style="font-size:16px">80. RunInstancesByStep</span></strong></p> <p><strong>接口描述</strong></p> <p>创建云主机</p> <ol> <li>资源售罄则不可创建云主机</li> <li>云主机类型与磁盘类型匹配才能创建</li> <li>创建的主机数不能大于可用ip数</li> <li>如果安装安全组,则必须云主机与安全组在同一个网络域</li> <li>所用的镜像必须为可用状态</li> </ol> <p><strong>请求参数</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <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>Disks</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>磁盘信息</p> </td> <td> <p>[{&quot;diskType&quot;:&quot;ebs.gen1&quot;,&quot;diskSize&quot;:&quot;20&quot;,&quot;snapshotId&quot;:&quot;&quot;},{&quot;diskType&quot;:&quot;ebs.gen1&quot;,&quot;diskSize&quot;:&quot;50&quot;,&quot;snapshotId&quot;:&quot;&quot;}]</p> </td> </tr> <tr> <td> <p>Eip</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>eip信息</p> </td> <td> <p>{&quot;eipTypeUuid&quot;:&quot;ProductSpec-Izkfc9L1X4&quot;,&quot;isRecord&quot;:false,&quot;bandwidthSize&quot;:1,&quot;domainName&quot;:&quot;PINGAN&quot;}</p> </td> </tr> <tr> <td> <p>RegionId</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> </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> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceType</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品规格</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</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>SubnetId</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>ImageId</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> <tr> <td> <p>ResourceGroupId</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>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>数量</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>否</p> </td> <td> <p>计费类型</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> <tr> <td> <p>FunctionNames</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>方法名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Userdata</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>用户数据</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>UserdataBase64Encoded</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>64位用户数据</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>SecurityGroupId</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>VmhostNames</p> </td> <td> <p>String[]</p> </td> <td> <p>否</p> </td> <td> <p>用户云主机主机名</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AutoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否自动续费</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>GeneratePasswordType</p> </td> <td> <p>GeneratePasswordType</p> </td> <td> <p>否</p> </td> <td> <p>云主机生成密码方式,默认为随机生成</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>密钥对ID,若密码生成方式为Key(密钥对),则keyId为必传参数</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CustomPassword</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义密码,若密码生成方式为Custom(自定义),则CustomPassword为必传参数<br /> 请输入8 - 16 个字符,必须同时包含三项(大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^&amp; 中的特殊符号)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsInstallOracleKsplice</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否安装OracleKsplice插件</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PrivateKey</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私钥</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RootSize</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>root盘扩容后的大小</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RootDiskType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>root盘类型</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsRootUpgrade</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否root扩容</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceSourceType</p> </td> <td> <p>InstanceSourceType</p> </td> <td> <p>否</p> </td> <td> <p>主机来源</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisableRootFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>否</p> </td> <td> <p>是否禁用Root或Administrator账号</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InitUsername</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义账户</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ComponentNames</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>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><strong><span style="font-size:16px">81. SaveHeaderTitleCustom</span></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>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品代码</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TitleKeys</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>自定义选项集合,多个key需进行字符串拼接,key之间使用英文逗号(,)进行分隔</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">82.&nbsp; SelectInstanceItem</span></strong></p> <p><strong>接口描述</strong></p> <p>根据vpcId和subnetId获取主机选项列表信息</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</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcIds</p> </td> <td> <p>String[]</p> </td> <td> <p>否</p> </td> <td> <p>VPC列表</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetIds</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>SelectInstanceBeans</p> </td> <td> <p>List&lt;SelectInstanceBean&gt;</p> </td> <td> <p>主机选项列表信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">83. StartInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>启动云主机</p> <ol> <li>非关机状态不能启动云主机</li> <li>包月云主机或者按量云主机欠费不能启动云主机</li> <li>开机会对费用进行结算</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">84. StopInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>云主机关机</p> <ol> <li>该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放,则不能关机云主机</li> <li>只有运行中的云主机才能关机</li> <li>安装热补丁时不能关机</li> <li>关机会对费用进行一次结算</li> <li>该操作异步进行,需要一定的时间</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">85.&nbsp; SuspendInstance</span></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>Id</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> </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><strong><span style="font-size:16px">86. UpdateInstanceAutoRenewFlag</span></strong></p> <p><strong>接口描述</strong></p> <p>修改云主机是否自动续费</p> <ol> <li>主机是包月的条件下才能修改。</li> <li>已到期或者今天到期的云主机不能修改是否自动续费。</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AutoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>是</p> </td> <td> <p>是否自动续费</p> <ul> <li>true为自动续费</li> <li>false为非自动续费</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong><span style="font-size:16px">87. UpdateInstanceName</span></strong></p> <p><strong>接口描述</strong></p> <p>修改用户自定义云主机名称</p> <ol> <li>只有在主机关机的状态下才能修改。</li> <li>已到期云主机不能修改云主机名</li> <li>操作状态为 无才能修改主机名</li> <li>该操作为异步进行</li> </ol> <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>Name</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机名称<br /> 每个主机名以字母开头, 允许字母, 数字, -, 最长64个字符,多个主机名称以英文逗号隔开</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 /> 可以通过ListInstance接口可以查看所有的云主机的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><strong><span style="font-size:16px">88.&nbsp;UpgradeInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>云主机升配</p> <ol> <li>有未支付订单的主机不能升配</li> <li>关机且未过期的主机才能升配</li> <li>升配时,必须与原主机类型不同</li> <li>GPU主机不能升配</li> <li>必须有足够的CPU和内存的配额才能升配</li> <li>升配会对费用进行一次结算</li> </ol> <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 /> 可以通过ListInstance接口可以查看所有的云主机的id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NewInstanceType</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>更改配置后的云主机类型<br /> 可以通过ListProductSeries接口查询产品系列信息。</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>期数,最小1,最大36<br /> 仅包月主机才需要传,通过GetRemainMonth接口查询期数</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>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><strong><span style="font-size:16px">89. CreateKey</span></strong></p> <p><strong>接口描述</strong></p> <p>创建密钥对</p> <ul> <li>创建密钥对需要通过登陆认证获取令牌。</li> <li>应用对应的DTO调用createKey方法来创建密钥对。</li> <li>创建密钥对后可进行关联实例的操作。</li> <li>接口只适用于华南、香港地区,华东未上密钥对功能。</li> </ul> <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>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>KeyType</p> </td> <td> <p>KeyType</p> </td> <td> <p>是</p> </td> <td> <p>生成类型<br /> 当KeyType为IMPORT时,PublicKey为必填<br /> 类型分为两种:</p> <ul> <li>IMPORT:导入已有</li> <li>AUTO:自动</li> </ul> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PublicKey</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>公钥内容</p> <ul> <li>当KeyType为IMPORT时,PublicKey为必填</li> <li>长度不得超过1024位</li> <li>需要导入符合Base64编码格式的公钥</li> </ul> </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> <ul> <li>地域ID决定了用户创建的秘钥对分布在哪里,例如华东。</li> <li>可以通过ListRegions接口查询区域信息。</li> </ul> </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>Key</p> </td> <td> <p>KeyBean</p> </td> <td> <p>密钥对信息</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">90. CreateKeyRelatedInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>创建云主机关系密钥对</p> <ul> <li>创建云主机关系密钥对需要通过登陆认证获取令牌。</li> <li>可通过ListAbleKeyRelateInstancs接口来查询可关联的实例。</li> <li>关联时需要发送短信验证。</li> <li>创建时需要注意如果已到期云主机,到达强制关机时间,包月的云主机一旦关机,不允许云主机关系密钥对</li> </ul> <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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID、对应的云主机的UUID<br /> 可以通过ListInstances接口查询到云主机信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>key id<br /> 可以通过ListKey接口查询到密钥对的信息。</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>JobIds</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">91. DeleteKey</span></strong></p> <p><strong>接口描述</strong></p> <p>删除密钥对</p> <ul> <li>删除密钥对需要通过登陆认证获取令牌。</li> <li>通过获取密钥对的id得到所属的密钥对再调用deleteKey方法删除密钥对。</li> <li>接口为异步job创建,查看删除密钥对是否成功。</li> </ul> <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>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>key id、密钥对的id值<br /> 可以通过ListKey接口查询到密钥对的信息。</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><strong><span style="font-size:16px">92.&nbsp;DeleteKeyRelatedInstance</span></strong></p> <p><strong>接口描述</strong></p> <p>删除云主机关系密钥对</p> <ul> <li>可通过ListKeyRelatedInstance接口来查询可取消关联的实例。</li> <li>删除云主机关系密钥对需要通过登陆认证获取令牌。</li> </ul> <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>InstanceIds</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>云主机ID<br /> 可以通过ListInstances接口查询到云主机信息。</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>KeyId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>key id<br /> 可以通过ListKey接口查询到密钥对的信息。</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>JobIds</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong><span style="font-size:16px">93.ListKey</span></strong></p> <p><strong>接口描述</strong></p> <p>分页查询租户下的密钥对信息</p> <ul> <li>分页查询租户下的密钥对信息需要通过登陆认证获取令牌。</li> <li>通过对应的DTO调用findAllByTenant查询信息。</li> <li>调用接口时,需要注意:接口采用分页查询的方式,默认页码为1,每页显示1000条数据。</li> </ul> <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>地域<br /> 地域ID决定了用户创建的云磁盘分布在哪里,例如华东1。<br /> 可以通过ListRegions接口查询区域信息。</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 /> 通过CreateKey接口自动生成的秘钥名称。</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 /> 分页查询时使用。<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 /> 分页查询时使用。<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 /> 不传默认为1000。</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>Keys</p> </td> <td> <p>List&lt;KeyBean&gt;</p> </td> <td> <p>key信息列表</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><span style="font-size:16px">94.&nbsp; ListPods</span></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>
以上内容是否解决了您的问题?
请补全提交信息!
联系我们

电话咨询

400-151-8800

邮件咨询

fincloud@ocft.com

在线客服

工单支持

解决云产品相关技术问题