API 描述
<p><strong><span style="font-size:18px">ListDedicatedEbsProductSeries</span></strong></p>
<p>接口描述</p>
<p>查询专属云磁盘产品系列</p>
<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>
<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> </p>
</td>
</tr>
<tr>
<td>
<p>RegionId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>地域</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ZoneId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>可用区</p>
</td>
<td>
<p> </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>ProductSeries</p>
</td>
<td>
<p>List<ProductSeriesBean></p>
</td>
<td>
<p>产品系列信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">CreateDedicatedHost</span></strong></p>
<p>接口描述</p>
<p>创建专属宿主机<br />
专属宿主机有自己独有的标签确定专属宿主机</p>
<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>
<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 />
专属宿主机的可用区,创建的时候由用户选择<br />
必传字段,类型:n(正整数);</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PodId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>高可用域Id<br />
专属宿主机的高可用域,创建的时候由用户选择<br />
必传字段,类型:n(正整数)<br />
会进行实体校验,校验失败,抛出异常 InvalidParameterException</p>
</td>
<td>
<p> </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> </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> </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> </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> </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> </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> </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>ChargeType</p>
</td>
<td>
<p>ChargeType</p>
</td>
<td>
<p>计费类型<br />
专属宿主机目前只支持包月</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ProductCode</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>产品标识码<br />
专属宿主机的产品标识</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>OrderId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>订单Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>OrderStatus</p>
</td>
<td>
<p>订单状态</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ProductCode</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>产品标识码<br />
专属宿主机的产品标识</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">DestroyDedicatedHost</span></strong></p>
<p>接口描述</p>
<p>删除专属宿主机<br />
如果选择删除的专属宿主机状态为 : Pending Destroying Destroyed 会抛出 PacloudException<br />
删除的宿主机为软删除,修改状态 EnableFlag =false 以及status = destroyed</p>
<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>
<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> </p>
</td>
</tr>
</tbody>
</table>
<p>响应参数</p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">GetDedicatedEcsSummary</span></strong></p>
<p>接口描述</p>
<p>获取专属宿主机概览<br />
获取专属宿主机的 相关信息 如:台数,内存大小,cpu,磁盘空间,实例总数 等<br />
入参为 regionID</p>
<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>
<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</p>
</td>
<td>
<p> </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>HostSum</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>宿主机总数<br />
单位:台</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>InstanceSum</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>云主机实例总数<br />
单位:个</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>DiskSum</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>磁盘总数<br />
单位:个</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ListDedicatedHostTypes</span></strong></p>
<p>接口描述</p>
<p>查询专属宿主机规格<br />
支持专属宿主机规格查询,专属宿主机规格为管理员配置<br />
用于创建专属宿主机提供规格配置</p>
<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>
<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> </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> </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> </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>DedicatedHostTypes</p>
</td>
<td>
<p>List<DedicatedHostTypeBean></p>
</td>
<td>
<p>专属宿主机规格信息列表<br />
管理员配置的专属宿主机规格信息包含 定价,内存,cpu 等信息 详情点开Bean</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>专属宿主机总数<br />
所有配置的有效专属宿主机总数</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ListDedicatedHosts</span></strong></p>
<p>接口描述</p>
<p>查询专属宿主机<br />
分页查询专属宿主机,支持条件查询,支持排序,默认 id desc 排序方式</p>
<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>
<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> </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> </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> </p>
</td>
</tr>
<tr>
<td>
<p>PageNumber</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页页码</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PageSize</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>分页大小</p>
</td>
<td>
<p> </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> </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> </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> </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> </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> </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>DedicatedHosts</p>
</td>
<td>
<p>List<DedicatedHostBean></p>
</td>
<td>
<p>专属宿主机信息列表<br />
用于专属宿主机页面展示详细信息</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>TotalCount</p>
</td>
<td>
<p>Long</p>
</td>
<td>
<p>数量<br />
有效专属宿主机数量</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ModifyHostAttribute</span></strong></p>
<p>接口描述</p>
<p>修改专属宿主机属性<br />
主要针对专属宿主机 disPlayName 提供修改。<br />
根据 uuid 找到对应专属宿主机,修改disPlayName属性</p>
<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>
<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> </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> </p>
</td>
</tr>
</tbody>
</table>
<p>响应参数</p>
<table border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<p><strong>参数名称</strong></p>
</td>
<td>
<p><strong>参数类型</strong></p>
</td>
<td>
<p><strong>参数描述</strong></p>
</td>
<td>
<p><strong>备注</strong></p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">RenewDedicatedHost</span></strong></p>
<p>接口描述</p>
<p>专属宿主机续费<br />
专属宿主机续费需要校验宿主机续费类型是否为包月否则 抛出异常 IncorrectStatusException<br />
续费条件包括专属宿主机状态不能为Pending Createfial Destory 等失效状态<br />
针对新的期数进行续费</p>
<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>
<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> </p>
</td>
</tr>
<tr>
<td>
<p>Period</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>专属宿主机续费期数</p>
</td>
<td>
<p> </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> </p>
</td>
</tr>
<tr>
<td>
<p>Status</p>
</td>
<td>
<p>OrderStatus</p>
</td>
<td>
<p>订单状态</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>ProductCode</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ChangeDedicatedInstanceType</span></strong></p>
<p>接口描述</p>
<p>修改专属云主机规格<br />
修改规格期间,主机必须关机,修改值跟原值有差异,配额有效 机器无其他操作等,否则抛出异常 InvalidParameterException<br />
修改为异步 job 任务方式执行,返回jobuuid 可根据jobuuid 查看任务是否执行成功</p>
<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>
<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> </p>
</td>
</tr>
<tr>
<td>
<p>CPUNumber</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>专属云主机 CPU 核数 必传字段</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Memory</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>专属云主机内存 必传字段</p>
</td>
<td>
<p> </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>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">DestroyDedicatedInstance</span></strong></p>
<p>接口描述</p>
<p>删除专属云主机实例<br />
只支持 停止状态、创建失败状态 的云主机进行删除<br />
接口为异步 job 执行删除 返回job uuid 可查询jobuuid 看任务是否执行成功</p>
<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>
<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> </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> </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>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ListDedicatedInstanceCpus</span></strong></p>
<p>接口描述</p>
<p>查询所有专属云主机类型的cpu<br />
获取所有专属云主机核心数种类</p>
<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>
<td>
<p><strong>备注</strong></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>Cpus</p>
</td>
<td>
<p>List<Integer></p>
</td>
<td>
<p>专属云主机CPU信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ListDedicatedInstanceMemorys</span></strong></p>
<p>接口描述</p>
<p>查询所有专属云主机的内存<br />
获取所有专属云主机所有内存种类</p>
<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>
<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> </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>Memorys</p>
</td>
<td>
<p>List<Integer></p>
</td>
<td>
<p>专属云主机内存信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">ListDedicatedInstanceTypes</span></strong></p>
<p>接口描述</p>
<p>根据专属系列查询专属规格</p>
<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>
<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> </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>InstanceTypeBeanList</p>
</td>
<td>
<p>List<InstanceTypeBean></p>
</td>
<td>
<p>云主机类型信息列表</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">RunDedicatedInstances</span></strong></p>
<p>接口描述</p>
<p>创建专属云主机<br />
批量创建专属云主机在专属宿主机上<br />
创建为异步创建返回jobuuid 可用返回的uuid 去查询是否创建成功</p>
<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>
<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> </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> </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> </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> </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> </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> </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> </p>
</td>
</tr>
<tr>
<td>
<p>Count</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>数量</p>
</td>
<td>
<p> </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> </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> </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> </p>
</td>
</tr>
<tr>
<td>
<p>DiskCount</p>
</td>
<td>
<p>Integer</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>磁盘数量</p>
</td>
<td>
<p> </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> </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> </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> </p>
</td>
</tr>
<tr>
<td>
<p>InstanceType</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>是</p>
</td>
<td>
<p>产品规格</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>GeneratePasswordType</p>
</td>
<td>
<p>GeneratePasswordType</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>云主机生成密码方式,默认为自定义</p>
</td>
<td>
<p> </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、 !@#$%^& 中的特殊符号)</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>PrivateKey</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>私钥</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>Ip</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>指定ip, 多个ip需进行字符串拼接,ip之间使用英文逗号(,)进行分隔</p>
</td>
<td>
<p> </p>
</td>
</tr>
<tr>
<td>
<p>IsSpecifyIp</p>
</td>
<td>
<p>Boolean</p>
</td>
<td>
<p>否</p>
</td>
<td>
<p>是否指定ip<br />
true:表示指定 false:表示不指定</p>
</td>
<td>
<p> </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>JobIds</p>
</td>
<td>
<p>List<String></p>
</td>
<td>
<p> </p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">StartDedicatedInstance</span></strong></p>
<p>接口描述</p>
<p>启动专属云主机<br />
启动的云主机状态不能为 Stopped 否则抛出异常 IncorrectStatusException<br />
接口为异步job 执行返回job uuid 可根据job uuid 查询任务执行情况</p>
<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>
<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> </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>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
<p><strong><span style="font-size:18px">StopDedicatedInstance</span></strong></p>
<p>接口描述</p>
<p>关闭专属云主机<br />
在Running 的云主机不可关闭<br />
接口为异步 job 接口 返回job uuid 可根据uuid 查询接口关闭任务是否执行成功</p>
<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>
<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> </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>JobId</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>任务 Id</p>
</td>
<td>
<p> </p>
</td>
</tr>
</tbody>
</table>
提交成功!非常感谢您的反馈,我们会继续努力做到更好!