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

API 描述

CancelShareImage 接口描述 取消共享镜像 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 镜像uuid </td> <td>   </td> </tr> <tr> <td> BeSharedTenantId </td> <td> Long </td> <td> 否 </td> <td> 被共享租户id </td> <td>   </td> </tr> <tr> <td> IsShareCancel </td> <td> Boolean </td> <td> 是 </td> <td> 是否共享者取消 true表示共享者取消 false表示被共享者取消 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   CreateImage 接口描述 创建镜像 创建镜像需要通过登陆认证获取令牌 调用接口应注意： 1)云磁盘或者云主机必须存在一个，否则抛ParameterRequiredException异常 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EbsId </td> <td> String </td> <td> 否 </td> <td> 云磁盘Id 云磁盘或者云主机必须存在一个，否则抛ParameterRequiredException异常 通过ListDisks可以查询云磁盘信息 </td> <td>   </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 否 </td> <td> 云主机Id 决定了镜像的来源 通过ListInstances可以查询云主机信息 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 镜像在门户界面显示名称。 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128 个字符 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 是 </td> <td> 镜像名称 由中文, 英文字母, 数字, @ 和 _, -组成，最长为 64 个字符 </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> 否 </td> <td> 镜像描述 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   DeleteImage 接口描述 根据镜像id删除镜像 需要通过登陆认证获取令牌 调用接口注意： 1)只有状态为Available、Unavailable、CreateFailed、DeleteFailed的镜像才能被删除 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 需要删除的镜像Id 通过ListImages接口可以查询镜像信息 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   GetImage 接口描述   请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 镜像Id 通过ListImages接口可以查询镜像信息 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Image </td> <td> ImageBean </td> <td> 镜像信息 </td> <td>   </td> </tr> </tbody> </table>   ListImageShareTenants 接口描述 查询镜像共享的租户列表 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 镜像uuid </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码，默认为1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小，默认是为10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> AccountBeans </td> <td> List<AccountBean> </td> <td> 被共享租户账户信息 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 租户总数 </td> <td>   </td> </tr> </tbody> </table>   ListImages 接口描述 查询所有镜像 需要通过登陆认证获取令牌 调用接口时，需要注意：接口采用分页查询的方式，默认页码为1，每页显示100条数据。 请求参数 <table border="1" cellpadding="0" cellspacing="0" style="width:504px"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td style="width:52px"> 是否必须 </td> <td style="width:138px"> 参数描述 </td> <td style="width:117px"> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td style="width:52px"> 是 </td> <td style="width:138px"> 镜像所属的地域Id。 地域Id 决定了镜像分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td style="width:117px">   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 镜像所属的可用区Id。forCreateInstance为true或者不传的时候，为必填参数 一个地域下可能有多个可用区，可用区Id决定了镜像分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td style="width:117px">   </td> </tr> <tr> <td> OsTypeId </td> <td> String </td> <td style="width:52px"> 是 </td> <td style="width:138px"> 镜像所属的操作系统类型Id 操作系统类型Id 决定了镜像属于哪中操作类型，例如：centos 可以通过ListOsTypes接口查询操作系统类型信息 </td> <td style="width:117px">   </td> </tr> <tr> <td> useType </td> <td> String </td> <td style="width:52px"> 是 </td> <td style="width:138px"> 镜像使用类型，例如： PUBLIC：公用 SPECIAL：是基于现有实例创建的镜像 NO_AGENT：手动上传且不启用主机功能 </td> <td style="width:117px">   </td> </tr> <tr> <td> Name </td> <td> String </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 镜像名称 </td> <td style="width:117px">   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 镜像在门户的显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128个字符 </td> <td style="width:117px">   </td> </tr> <tr> <td> Status </td> <td> ImageStatus </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 镜像状态，例如： ToCreate  待创建 Pending   创建中 CreateFailed 创建失败 Available  可用 Unavailable  失效 Deleting  删除中 Deleted   已删除 DeleteFailed 删除失败 </td> <td style="width:117px">   </td> </tr> <tr> <td> UseType </td> <td> ImageType </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 镜像使用类型，例如： PUBLIC  公有 SPECIAL  专用,分为两种，一种是基于现有实例创建的镜像,一种为手动上传且启用主机功能 NO_AGENT 手动上传且不启用主机功能 </td> <td style="width:117px">   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 分页页码 分页查询时使用。 </td> <td style="width:117px">   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 分页大小。 分页查询时使用。 </td> <td style="width:117px">   </td> </tr> <tr> <td> ForCreateInstance </td> <td> Boolean </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 是否可以创建主机，默认可以 值为true时，可以创建主机 值为false时，不可以创建主机 </td> <td style="width:117px">   </td> </tr> <tr> <td> IsQueryShare </td> <td> Boolean </td> <td style="width:52px"> 否 </td> <td style="width:138px"> 是否查询共享镜像，默认false </td> <td style="width:117px">   </td> </tr> </tbody> </table>   响应参数 <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Images </td> <td> List<ImageBean> </td> <td> 镜像信息列表 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 镜像总数 </td> <td>   </td> </tr> </tbody> </table>   ListOsMappingCsOs 接口描述 根据地域和可用区筛选出所有操作系统映射到CS操作系统对应关系 需要通过登陆认证获取令牌 可以通过ListRegions接口查询区域信息 通过ListZones接口查询可用区信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 操作系统映射到CS操作系统对应关系所属的地域Id。 地域Id 决定了操作系统映射到CS操作系统对应关系分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 操作系统映射到CS操作系统对应关系所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了操作系统映射到CS操作系统对应关系分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 查询到的总数 </td> <td>   </td> </tr> <tr> <td> OsTypes </td> <td> List<OsMappingCsOsBean> </td> <td> 操作系统映射到CS操作系统对应关系详细信息列表 </td> <td>   </td> </tr> </tbody> </table>   ListOsTypes 接口描述 查询操作系统类型 需要通过登陆认证获取令牌 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示10条数据，排序为升序排列。 2、如果分页大小超过3000，则设置为3000 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 操作系统类型Id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 操作体统类型名称 </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> 否 </td> <td> 操作系统类型描述 </td> <td>   </td> </tr> <tr> <td> OsCategory </td> <td> String </td> <td> 否 </td> <td> 操作系统类型，如下： LINUX, WINDOWS, UNIX, AIX </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字,即按什么字段排序 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式。 默认按DESC排序 和排序关键字搭配使用，表示按照升序还是降序排列，取值如下： ASC：升序 DESC：降序 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 操作系统类型信息列表总数 </td> <td>   </td> </tr> <tr> <td> OsTypes </td> <td> List<OsTypeBean> </td> <td> 操作系统类型信息列表 </td> <td>   </td> </tr> </tbody> </table>   ManualUploadImage 接口描述 手动上传镜像 需要通过登陆认证获取令牌 通过ListImages接口可以查询所有镜像 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Url </td> <td> String </td> <td> 是 </td> <td> OBS存放的镜像url </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 是 </td> <td> 镜像名称 </td> <td>   </td> </tr> <tr> <td> Displaytext </td> <td> String </td> <td> 否 </td> <td> 镜像描述 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 镜像上传时所属的地域Id。 地域Id 决定了镜像分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 镜像上传时所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了镜像分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Hypervisor </td> <td> HypervisorType </td> <td> 否 </td> <td> 虚拟管理类型，比如：KVM,VMware 默认为KVM类型 </td> <td>   </td> </tr> <tr> <td> Ostypeid </td> <td> String </td> <td> 是 </td> <td> 镜像所属的操作系统类型id 调用ListOsMappingCsOs接口可以查询对应的cs操作系统类型 </td> <td>   </td> </tr> <tr> <td> Isfeatured </td> <td> Boolean </td> <td> 否 </td> <td> 是否为精选，默认为true(精选) </td> <td>   </td> </tr> <tr> <td> Ispublic </td> <td> Boolean </td> <td> 否 </td> <td> 是否为公有，默认为true(公有) </td> <td>   </td> </tr> <tr> <td> Passwordenabled </td> <td> Boolean </td> <td> 否 </td> <td> 是否已启用密码，默认为true(已启用密码) </td> <td>   </td> </tr> <tr> <td> Requireshvm </td> <td> Boolean </td> <td> 否 </td> <td> 是否需要HVM,默认为false(不需要HVM) </td> <td>   </td> </tr> <tr> <td> Isdynamicallyscalable </td> <td> Boolean </td> <td> 否 </td> <td> 是否可动态扩展，默认为true(可以动态扩展) </td> <td>   </td> </tr> <tr> <td> IsAgent </td> <td> Boolean </td> <td> 否 </td> <td> 是否启用主机功能，默认为true(开启主机功能) </td> <td>   </td> </tr> <tr> <td> Format </td> <td> String </td> <td> 否 </td> <td> 文件类型，默认QCOW2 取值如下：QCOW2, RAW, VHD and OVA </td> <td>   </td> </tr> <tr> <td> Checksum </td> <td> String </td> <td> 否 </td> <td> MD5 允许英文字母, 数字,最长 32 个字符 </td> <td>   </td> </tr> <tr> <td> Isextractable </td> <td> Boolean </td> <td> 否 </td> <td> 是否可提取，默认为true(可以提取) </td> <td>   </td> </tr> <tr> <td> Isrouting </td> <td> Boolean </td> <td> 否 </td> <td> 是否可以路由，默认为false(不可以路由) </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   ManualUploadImageCheck 接口描述 手动上传镜像时校验URL 该接口只针对上传镜像时对URL的路径校验是否符合规范 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 镜像上传时所属的可用区Id。 一个地域下可能有多个可用区，可用区Id决定了镜像分布的具体可用区，例如可用区A。 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Url </td> <td> String </td> <td> 是 </td> <td> OBS存放的镜像url </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   ModifyImageAttribute 接口描述 根据镜像的id修改镜像的属性 需要通过登陆认证获取令牌 通过ListImages接口可以查询所有镜像 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 镜像Id 必传项 通过ListImages接口可以查询所有镜像 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 镜像在门户的显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   ShareImage 接口描述 共享镜像 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 镜像uuid </td> <td>   </td> </tr> <tr> <td> TenantName </td> <td> String </td> <td> 是 </td> <td> 被共享租户名称 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   SyncImage 接口描述   请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 镜像Id 必传项 通过ListImages接口可以查询所有镜像 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> zone的uuid </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td>   </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td>   </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   BatchDestroyInstance 接口描述 批量删除云主机 1）起多个job进行删除，一个主机对应一个job 2）只有关机和创建失败状态的主机才能执行此操作 3）单个主机的删除失败不会影响其他主机的删除 4）有安全产品、有依赖资源的云主机不能删除 5)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Ids </td> <td> String </td> <td> 是 </td> <td> 云主机Id，多个云主机id需进行字符串拼接，id之间使用英文逗号(,)进行分隔 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   BatchRenewInstance 接口描述 批量续费云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> 是 </td> <td> 云主机id，多个云主机id需进行字符串拼接，id之间使用英文逗号(,)进行分隔 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 是 </td> <td> 续费期数，最小1，最大36 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td>   </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   BatchStartInstance 接口描述 批量开启云主机 1）起多个job进行开机，一个主机对应一个job 2）只有关机状态的主机才能执行此操作 3）单个主机的启动失败不会影响其他主机的启动 4）过期的包月云主机不支持开机操作 5）租户欠费不能进行开机操作 6）批量开机会进行费用结算 7)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Ids </td> <td> String </td> <td> 是 </td> <td> 云主机Id，多个云主机id需进行字符串拼接，id之间使用英文逗号(,)进行分隔 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   BatchStopInstance 接口描述 批量关闭云主机 1）起多个job进行关机，一个主机对应一个job 2）只有运行中状态的主机才能执行此操作 3）单个主机的关机失败不会影响其他主机的关机操作 4）批量关机会对费用进行一次结算 5)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Ids </td> <td> String </td> <td> 是 </td> <td> 云主机Id，多个云主机id需进行字符串拼接，id之间使用英文逗号(,)进行分隔 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   BatchUpdateAutoRenewFlag 接口描述 修改云主机是否自动续费 1)主机是包月的条件下才能修改。 2）已到期或者今天到期的云主机不能修改是否自动续费 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Ids </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> 是 </td> <td> 是否自动续费 true为自动续费 false为非自动续费 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   CancelRelateInstance 接口描述 取消定时规则关联的实例 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 定时规则唯一标识：定时规则Id </td> <td>   </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> 是 </td> <td> 关联的实例id(id以“，”分割) </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   CheckInstanceName 接口描述 检查用户自定义云主机名称的唯一性 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Names </td> <td> String </td> <td> 是 </td> <td> 云主机名称，多个云主机名称需进行字符串拼接，名称之间使用英文逗号(,)进行分隔 用户自定的主机名称不能是已存在的且只能由数字和字母、中划线组成，第一个必须为英文字母，字符长度最小为1，最大为45 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   CheckIpForCreateEcs 接口描述 校验指定ip有效性 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> 是 </td> <td> 子网Id </td> <td>   </td> </tr> <tr> <td> Ip </td> <td> String </td> <td> 是 </td> <td> 指定ip </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   CreateEcsScheduledRule 接口描述 创建云主机定时规则 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id 地域Id决定了用户创建的云主机分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128 个字符 </td> <td>   </td> </tr> <tr> <td> ScheduledType </td> <td> ScheduledType </td> <td> 是 </td> <td> 定时任务类型,枚举类型;取值：Start,Stop </td> <td>   </td> </tr> <tr> <td> RepeatType </td> <td> RepeatType </td> <td> 是 </td> <td> 定时任务重复周期,枚举类型;取值：Once,Daily,Weekly,Monthly </td> <td>   </td> </tr> <tr> <td> ScheduledDate </td> <td> String </td> <td> 是 </td> <td> 定时日期 </td> <td>   </td> </tr> <tr> <td> ScheduledTime </td> <td> String </td> <td> 是 </td> <td> 定时时间 </td> <td>   </td> </tr> <tr> <td> BeginTime </td> <td> String </td> <td> 否 </td> <td> 定时任务开始时间，时间格式：Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] </td> <td>   </td> </tr> <tr> <td> EndTime </td> <td> String </td> <td> 否 </td> <td> 定时任务结束时间，时间格式：Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] </td> <td>   </td> </tr> <tr> <td> WeekType </td> <td> WeekType </td> <td> 否 </td> <td> 定时星期几：MON，TUE，WED，THU，FRI，SAT，SUN </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   DeleteEcsScheduledRule 接口描述 删除云主机定时规则 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机定时规则唯一标识：云主机定时规则Id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   DestroyInstance 接口描述 删除云主机 1)只有关机或者创建失败的云主机才能删除 2）有未支付的订单的主机不能删除 3）该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能删除云主机 4)checkDependency为true:释放云主机时，校验资源依赖关系，如存在依赖资源，需先删除依赖资源，才能释放云主机 checkDependency为false:释放云主机时，不校验资源依赖关系 5)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 需要释放的云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> CheckDependency </td> <td> Boolean </td> <td> 否 </td> <td> 释放云主机时是否检查资源依赖关系 true:释放云主机时，校验资源依赖关系，如存在依赖资源，需先删除依赖资源，才能释放云主机 false:释放云主机时，不校验资源依赖关系 默认值为true </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   DowngradeInstance 接口描述 云主机降配 a.降配做的校验： 1）未支付订单 2）云主机必须关机,且不为包月过期云主机 3）操作状态为 None 4)必须与原实例类型不同，同时必须在同一个tag内 5）价格不能高于原价格 6）必须有足够的CPU和内存的配额 b.此接口是同步调用的 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> NewInstanceType </td> <td> String </td> <td> 是 </td> <td> 更改配置后的云主机类型 可以通过ListProductSeries接口查询产品系列信息。 </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> 否 </td> <td> 代金券Id 可以通过支付服务里的listAvailableCoupons方法查询 </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 否 </td> <td> 期数,最小1，最大36 仅包月主机才需要传，通过GetRemainMonth接口查询期数 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品编码 </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品编码 </td> <td>   </td> </tr> </tbody> </table>   GetAllEcsSummary 接口描述 获取所有区域云主机概览信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceSum </td> <td> Long </td> <td> 云主机总数 </td> <td>   </td> </tr> <tr> <td> RunningInstanceSum </td> <td> Long </td> <td> 正在运行中的云主机总数 </td> <td>   </td> </tr> <tr> <td> StoppedInstanceSum </td> <td> Long </td> <td> 已关机的云主机总数 </td> <td>   </td> </tr> <tr> <td> MonthlyInstanceSum </td> <td> Long </td> <td> 包月的云主机总数 </td> <td>   </td> </tr> <tr> <td> ExpiredInstanceSum </td> <td> Long </td> <td> 已经到期的云主机总数 </td> <td>   </td> </tr> <tr> <td> WillexpireInstanceSum </td> <td> Long </td> <td> 即将到期的云主机总数 </td> <td>   </td> </tr> <tr> <td> DiskSum </td> <td> Long </td> <td> 云磁盘总数 </td> <td>   </td> </tr> <tr> <td> SnapshotSum </td> <td> Long </td> <td> 快照总数 </td> <td>   </td> </tr> <tr> <td> ImageSum </td> <td> Long </td> <td> 镜像总数 </td> <td>   </td> </tr> <tr> <td> TotalSeparateInstance </td> <td> Long </td> <td> 按地域对云主机、磁盘等进行分组统计的数量 </td> <td>   </td> </tr> <tr> <td> SeparateRegionInstance </td> <td> List<InstanceOverviewBean> </td> <td> 保存根据地域对云主机、磁盘等资源进行分组统计的数量值 </td> <td>   </td> </tr> </tbody> </table>   GetEcsSummary 接口描述 获取云主机概览信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceSum </td> <td> Long </td> <td> 云主机总数 </td> <td>   </td> </tr> <tr> <td> DiskSum </td> <td> Long </td> <td> 云磁盘总数 </td> <td>   </td> </tr> <tr> <td> SnapshotSum </td> <td> Long </td> <td> 快照总数 </td> <td>   </td> </tr> </tbody> </table>   GetHeaderTitleCustom 接口描述 获取云主机自定义表头选项接口 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 是 </td> <td> 产品代码 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> HeaderTitleCustomBean </td> <td> HeaderTitleCustomBean </td> <td> 用户自定义选项返回对象 </td> <td>   </td> </tr> </tbody> </table>   GetInstance 接口描述 获取单个云主机信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceDetail </td> <td> InstanceDetailBean </td> <td> 云主机实例信息 </td> <td>   </td> </tr> </tbody> </table>   GetInstancePassword 接口描述 获取云主机密码 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 需要获取密码的云主机Id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Password </td> <td> String </td> <td> 密码 </td> <td>   </td> </tr> </tbody> </table>   InstallAgent 接口描述 安装agent 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 安装agent的云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> FunctionName </td> <td> String </td> <td> 是 </td> <td> 方法名 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务id </td> <td>   </td> </tr> </tbody> </table>   InstallOrUninstallOracleKsplice 接口描述 安装平安热补丁 1)只有运行中的主机且未安装热补丁才能安装热补丁 2）通过登陆认证获取令牌 3）安装中的主机不能重启或关机 4)只有操作系统中配置支持安装热补丁且为LINUX才支持安装 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 安装热补丁的云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> IsInstall </td> <td> Boolean </td> <td> 否 </td> <td> 是否安装热补丁。 默认为true，安装。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务id </td> <td>   </td> </tr> </tbody> </table>   InstallOracleKsplice 接口描述 安装平安热补丁 1)只有运行中的主机且未安装热补丁才能安装热补丁 2）通过登陆认证获取令牌 3）安装中的主机不能重启或关机 4)只有操作系统中配置支持安装热补丁且为LINUX才支持安装 5）GPU主机不能安装热补丁 6)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 安装热补丁的云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务id </td> <td>   </td> </tr> </tbody> </table>   ListAbleKeyRelateInstancs 接口描述 查询可用关联密钥对的云主机 1)云主机状态必须为运行中状态 2）分页显示 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> 否 </td> <td> 私有网络地址 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 否 </td> <td> 镜像Id 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> 否 </td> <td> 镜像名称 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> 否 </td> <td> 网络域名称 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> 否 </td> <td> 创建人名称 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码，默认为1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小,默认为10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> 否 </td> <td> 云主机状态，取值范围请查看枚举类型InstanceStatus </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 是否为专属云主机，取值范围请查看枚举类型InstanceCategory 默认不传则为共享云主机，取值 InstanceCategory.Ecs | InstanceCategory.Caas </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 否 </td> <td> 计费类型，具体信息查看枚举类型ChargeType </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListAccessoryNicByNetwork 接口描述 查询当前网络域下的所有扩展网卡 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 是 </td> <td> 网络域uuid </td> <td>   </td> </tr> <tr> <td> InstanceName </td> <td> String </td> <td> 否 </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> 否 </td> <td> 私有网络地址主机ip </td> <td>   </td> </tr> <tr> <td> IpAddress </td> <td> String </td> <td> 否 </td> <td> 内网ip地址网卡ip </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> 是 </td> <td> 安全组uuid </td> <td>   </td> </tr> <tr> <td> InstanceStatuses </td> <td> InstanceStatus[] </td> <td> 否 </td> <td> 云主机状态，取值范围请查看枚举类型InstanceStatus </td> <td>   </td> </tr> <tr> <td> NicStatuses </td> <td> NicStatus[] </td> <td> 否 </td> <td> 网卡状态 </td> <td>   </td> </tr> <tr> <td> IsBind </td> <td> Boolean </td> <td> 是 </td> <td> 是否绑定安全组 true为绑定安全组 false为未绑定安全组 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码，默认为1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小，默认是为10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> NicBeans </td> <td> List<AccessoryNicBean> </td> <td> 扩展网卡列表信息 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 网卡总数 </td> <td>   </td> </tr> </tbody> </table>   ListAllEcsScheduledRules 接口描述 获取云主机定时规则 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 分页查询时使用。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 分页查询时使用。 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 分页查询时使用。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域 地域Id决定了用户创建的云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 长度最长36 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 名称 长度最长45 </td> <td>   </td> </tr> <tr> <td> ScheduledType </td> <td> ScheduledType </td> <td> 否 </td> <td> 定时任务类型,枚举类型;取值：Start,Stop </td> <td>   </td> </tr> <tr> <td> RepeatType </td> <td> RepeatType </td> <td> 否 </td> <td> 定时任务重复周期,枚举类型;取值：Once,Weekly </td> <td>   </td> </tr> <tr> <td> WeekType </td> <td> WeekType </td> <td> 否 </td> <td> 星期,枚举类型;取值：MON、TUE、WED、THU、FRI、SAT、SUN </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EcsScheduledRuleBean </td> <td> List<EcsScheduledRuleBean> </td> <td> 定时规则信息列表，定时规则具体详细信息 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数，总共有多少条快照数量 </td> <td>   </td> </tr> </tbody> </table>   ListAllRelatedInstances 接口描述 获取定时规则已经关联的云主机列表 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> 否 </td> <td> 私有网络地址 </td> <td>   </td> </tr> <tr> <td> PublicIpAddress </td> <td> String </td> <td> 否 </td> <td> 公有网络地址 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> 否 </td> <td> 可用区名称 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> VpcId </td> <td> String </td> <td> 否 </td> <td> VPC Id 可以通过ListVpcs接口查询VPC信息。 </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> 否 </td> <td> 云主机类型 </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 安全组Id 可以通过ListSecurityGroups接口查询安全组信息。 </td> <td>   </td> </tr> <tr> <td> NotSecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 在这个安全组id范围之外的安全组id 可以通过ListSecurityGroups接口查询安全组信息。 </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 否 </td> <td> 镜像Id 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> 否 </td> <td> 镜像名称 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> 否 </td> <td> 子网Id 可以通过ListSubnets接口查询子网信息。 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> 否 </td> <td> 网络域名称 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> 否 </td> <td> 创建人名称 </td> <td>   </td> </tr> <tr> <td> NetworkType </td> <td> NetworkType </td> <td> 否 </td> <td> 网络域类型，取值范围请查看枚举类型NetworkType </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码，默认为1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小，默认是为10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> 否 </td> <td> 云主机状态，取值范围请查看枚举类型InstanceStatus </td> <td>   </td> </tr> <tr> <td> ErrorFlag </td> <td> InstanceErrorStatus[] </td> <td> 否 </td> <td> 云主机错误状态，取值范围请查看枚举类型InstanceErrorStatus </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String[] </td> <td> 否 </td> <td> 标签列表 可以通过ListTags接口查询所有标签 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 是否为普通云主机，默认不传则为普通云主机，取值 Ecs和Caas 取值范围为{Ecs，Caas，Dedicated，AutoScaling，GBD，FORTRESS} </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 否 </td> <td> 计费类型，取值范围请查看枚举类型ChargeType </td> <td>   </td> </tr> <tr> <td> VmHostName </td> <td> String </td> <td> 否 </td> <td> 虚拟机主机名 </td> <td>   </td> </tr> <tr> <td> CreateEip </td> <td> boolean </td> <td> 否 </td> <td> 判断主机是否创建eip 若为true，则需对实例根据eip状态进行过滤,否则不过滤 </td> <td>   </td> </tr> <tr> <td> HostId </td> <td> String </td> <td> 否 </td> <td> 专属云主机Id </td> <td>   </td> </tr> <tr> <td> ScheduledRuleId </td> <td> String </td> <td> 否 </td> <td> 定时规则id </td> <td>   </td> </tr> <tr> <td> IsRelated </td> <td> String </td> <td> 否 </td> <td> 是否关联定时规则 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListExpiredInstance 接口描述 查询已到期的云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListExpiringInstance 接口描述 查询即将到期的云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListInstanceDependencies 接口描述 获取云主机依赖资源。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机的uuid。 </td> <td>   </td> </tr> <tr> <td> IsDeleteFollowInstance </td> <td> Boolean </td> <td> 否 </td> <td> 待查询的资源是否随云主机删除而删除。 该值为null时，表示查询出全部的依赖资源。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> DependentInfoList </td> <td> List<DependentInfoBean> </td> <td> 云主机依赖资源列表。 </td> <td>   </td> </tr> <tr> <td> IsDeleteFollowInstance </td> <td> Boolean </td> <td> 查询出的资源是否随云主机删除而删除。 </td> <td>   </td> </tr> </tbody> </table>   ListInstanceProductSeries 接口描述 查询ECS相关的产品系列信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductId </td> <td> String </td> <td> 否 </td> <td> 产品uuid, 产品详细信息参见ListProduct接口描述 </td> <td>   </td> </tr> <tr> <td> ProductName </td> <td> String </td> <td> 否 </td> <td> 产品名称， 产品详细信参见ListProduct接口描述 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域uuid， 地域详细信息参见接口ListRegions说明 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区uuid， 可用区详细信息参见接口ListZones说明 </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 否 </td> <td> 高可用域uuid， 高可用域详细信息参见接口ListPods说明 </td> <td>   </td> </tr> <tr> <td> IsSupportAutoScaling </td> <td> Boolean </td> <td> 否 </td> <td> 待查询ECS产品系列是否支撑弹性伸缩， 取值范围: true:待查询ECS产品系列支撑弹性伸缩 false:待查询ECS产品系列不支撑弹性伸缩 null：不论查询ECS产品系列是否支撑弹性伸缩，全部返回 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceProductSeriesBeanList </td> <td> List<InstanceProductSeriesBean> </td> <td> ECS产品系列信息列表 </td> <td>   </td> </tr> </tbody> </table>   ListInstanceProductSpec 接口描述 获取云主机产品规格信息列表 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 否 </td> <td> 高可用域uuid </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区uuid </td> <td>   </td> </tr> <tr> <td> MemoryCpuScale </td> <td> Integer </td> <td> 否 </td> <td> Cpu倍频 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 产品规格uuid </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 产品规格名称 </td> <td>   </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 产品系列uuid </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> String </td> <td> 否 </td> <td> 付费方式 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceTypeBeanList </td> <td> List<InstanceTypeBean> </td> <td> 云主机类型信息列表 </td> <td>   </td> </tr> </tbody> </table>   ListInstanceTypes 接口描述 查询云主机类型 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 否 </td> <td> 高可用域Id 如果云主机产品规格Id不存在，则ZoneId或PodId必须存在一个，且都存在时只有PodId有效 可以通过ListPods接口查询可用域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 如果云主机产品规格Id不存在，则ZoneId或PodId必须存在一个，且都存在时只有PodId有效 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> MemoryCpuScale </td> <td> Integer </td> <td> 否 </td> <td> Cpu倍频 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 云主机产品规格Id 可以通过ListInstanceTypes接口查询云主机产品规格信息。 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 产品系列名称 可以通过ListProductSeries接口查询产品系列信息。 </td> <td>   </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 产品系列Id 可以通过ListProductSeries接口查询产品系列信息。。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceTypes </td> <td> List<InstanceTypeBean> </td> <td> 云主机类型信息列表 </td> <td>   </td> </tr> </tbody> </table>   ListInstanceTypesByOperation 接口描述 升降配时查询系列下的有效主机类型 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductSeriesId </td> <td> String </td> <td> 是 </td> <td> 产品系列Id 可以通过ListProductSeries接口查询产品系列信息。。 </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 是 </td> <td> 高可用域Id 如果云主机产品规格Id不存在，则ZoneId或PodId必须存在一个，且都存在时只有PodId有效 可以通过ListPods接口查询可用域信息。 </td> <td>   </td> </tr> <tr> <td> ProductSpecId </td> <td> String </td> <td> 是 </td> <td> 云主机产品规格Id 可以通过ListInstanceTypes接口查询云主机产品规格信息。 </td> <td>   </td> </tr> <tr> <td> IsUpgrade </td> <td> Boolean </td> <td> 是 </td> <td> 是否是升配 </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 是 </td> <td> 云主机计费方式 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceTypes </td> <td> List<InstanceTypeBean> </td> <td> 云主机类型信息列表 </td> <td>   </td> </tr> </tbody> </table>   ListInstances 接口描述 查询云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 云主机ip 云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> 否 </td> <td> 私有网络地址 </td> <td>   </td> </tr> <tr> <td> PublicIpAddress </td> <td> String </td> <td> 否 </td> <td> 公有网络地址 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> 否 </td> <td> 可用区名称 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> VpcId </td> <td> String </td> <td> 否 </td> <td> VPC Id 可以通过ListVpcs接口查询VPC信息。 </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> 否 </td> <td> 云主机类型 </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 安全组Id 可以通过ListSecurityGroups接口查询安全组信息。 </td> <td>   </td> </tr> <tr> <td> NotSecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 在这个安全组id范围之外的安全组id 可以通过ListSecurityGroups接口查询安全组信息。 </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 否 </td> <td> 镜像Id 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> 否 </td> <td> 镜像名称 可以通过ListImages接口查询镜像信息。 </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> 否 </td> <td> 子网Id 可以通过ListSubnets接口查询子网信息。 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> 否 </td> <td> 网络域名称 可以通过ListNetworks接口查询网络域信息。 </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> 否 </td> <td> 创建人名称 </td> <td>   </td> </tr> <tr> <td> NetworkType </td> <td> NetworkType </td> <td> 否 </td> <td> 网络域类型，取值范围请查看枚举类型NetworkType </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码，默认为1 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小，默认是为10 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> 否 </td> <td> 云主机状态，取值范围请查看枚举类型InstanceStatus </td> <td>   </td> </tr> <tr> <td> ErrorFlag </td> <td> InstanceErrorStatus[] </td> <td> 否 </td> <td> 云主机错误状态，取值范围请查看枚举类型InstanceErrorStatus </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String[] </td> <td> 否 </td> <td> 标签列表 可以通过ListTags接口查询所有标签 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 是否为普通云主机，默认不传则为普通云主机，取值 Ecs和Caas 取值范围为{Ecs，Caas，Dedicated，AutoScaling，GBD，FORTRESS} </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 否 </td> <td> 计费类型，取值范围请查看枚举类型ChargeType </td> <td>   </td> </tr> <tr> <td> VmHostName </td> <td> String </td> <td> 否 </td> <td> 虚拟机主机名 </td> <td>   </td> </tr> <tr> <td> CreateEip </td> <td> boolean </td> <td> 否 </td> <td> 判断主机是否创建eip 若为true，则需对实例根据eip状态进行过滤,否则不过滤 </td> <td>   </td> </tr> <tr> <td> HostId </td> <td> String </td> <td> 否 </td> <td> 专属云主机Id </td> <td>   </td> </tr> <tr> <td> ScheduledRuleId </td> <td> String </td> <td> 否 </td> <td> 定时规则id </td> <td>   </td> </tr> <tr> <td> IsRelated </td> <td> String </td> <td> 否 </td> <td> 是否关联定时规则 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListKeyRelatedInstance 接口描述 查询可用删除绑定密钥对的云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 是 </td> <td> key id </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 云主机名称 </td> <td>   </td> </tr> <tr> <td> PrivateIpAddress </td> <td> String </td> <td> 否 </td> <td> 私有网络地址 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 否 </td> <td> 地域Id </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 否 </td> <td> 镜像Id </td> <td>   </td> </tr> <tr> <td> ImageName </td> <td> String </td> <td> 否 </td> <td> 镜像名称 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id </td> <td>   </td> </tr> <tr> <td> NetworkName </td> <td> String </td> <td> 否 </td> <td> 网络域名称 </td> <td>   </td> </tr> <tr> <td> CreateName </td> <td> String </td> <td> 否 </td> <td> 创建人名称 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceStatus[] </td> <td> 否 </td> <td> 云主机状态 如果要按状态查询那必须展示所有(即showAll设置为true)，否则只会默认查询运行中的。 </td> <td>   </td> </tr> <tr> <td> InstanceCategory </td> <td> InstanceCategory[] </td> <td> 否 </td> <td> 是否为专属云主机，默认不传则为共享云主机，取值 InstanceCategory.Ecs | InstanceCategory.Caas </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> String </td> <td> 否 </td> <td> 计费类型 </td> <td>   </td> </tr> <tr> <td> ShowAll </td> <td> Boolean </td> <td> 否 </td> <td> 是否展示所有 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> 云主机实例信息列表。 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 云主机实例总数。 </td> <td>   </td> </tr> </tbody> </table>   ListProductDynamicConfig 接口描述 Created by EX-YANGZHIWEI004 on 2019-7-16. 产品动态可配置列表 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ListObject </td> <td> List<Object> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   ModifyChargeType 接口描述 按量转包月 1)只有按量才能转包月 2）创建中、创建失败、取消、释放、释放中状态都不能按量转包月 3)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 是 </td> <td> 期数，最小1,最大36 </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> 是 </td> <td> 是否自动续费 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   ModifyEcsScheduledRule 接口描述 修改云主机定时规则 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 云主机规则Id 可通过ListAllEcsScheduledRulesAction接口查询云主机规则信息。 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id 地域Id决定了用户创建的云主机分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长 128 个字符 </td> <td>   </td> </tr> <tr> <td> ScheduledType </td> <td> ScheduledType </td> <td> 是 </td> <td> 定时任务类型,枚举类型;取值：Start,Stop </td> <td>   </td> </tr> <tr> <td> RepeatType </td> <td> RepeatType </td> <td> 是 </td> <td> 定时任务重复周期,枚举类型;取值：Once,Daily,Weekly,Monthly </td> <td>   </td> </tr> <tr> <td> ScheduledDate </td> <td> String </td> <td> 是 </td> <td> 定时日期 </td> <td>   </td> </tr> <tr> <td> ScheduledTime </td> <td> String </td> <td> 是 </td> <td> 定时时间 </td> <td>   </td> </tr> <tr> <td> BeginTime </td> <td> String </td> <td> 否 </td> <td> 定时任务开始时间，时间格式：Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] </td> <td>   </td> </tr> <tr> <td> EndTime </td> <td> String </td> <td> 否 </td> <td> 定时任务结束时间，时间格式：Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] </td> <td>   </td> </tr> <tr> <td> WeekType </td> <td> WeekType </td> <td> 否 </td> <td> 星期 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   ModifyInstanceAttribute 接口描述 修改云主机的属性 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 云主机显示名称 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   OpenConsole 接口描述 打开控制台 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceId </td> <td> String </td> <td> 是 </td> <td> 云主机Id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ConsoleHttpUrl </td> <td> String </td> <td> 云主机控制台地址 </td> <td>   </td> </tr> </tbody> </table>   RelateInstance 接口描述 关联云主机定时规则 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 定时规则唯一标识：定时规则Id </td> <td>   </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> 是 </td> <td> 关联的实例id(id以“，”分割) </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> EcsInstanceScheduledRule </td> <td> List<EcsInstanceScheduledRule> </td> <td> 关联的实例 </td> <td>   </td> </tr> </tbody> </table>   RenewInstance 接口描述 云主机续费 1)只有包月云主机才能续费 2）创建中、创建失败、释放、释放中状态都不能续费 3）主机下挂载的包月磁盘只能是可用状态。 4)此操作为异步进行，需要一定时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 是 </td> <td> 续费期数，最小1，最大36 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   ResetPasswordForInstance 接口描述 重置云主机密码 1）到期的包月云主机不能重置密码 2）只有关机状态才能重置密码 3）重置密码为异步操作 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id </td> <td>   </td> </tr> <tr> <td> GeneratePasswordType </td> <td> GeneratePasswordType </td> <td> 否 </td> <td> 云主机生成密码方式，默认为随机生成 取值范围请查看枚举类型GeneratePasswordType,默认为Random（随机） 目前不支持密钥对 </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> 否 </td> <td> 自定义密码，若密码生成方式为Custom(自定义) </td> <td>   </td> </tr> <tr> <td> DisableRootFlag </td> <td> Boolean </td> <td> 否 </td> <td> 是否禁用Root或Administrator账号 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   RestartInstance 接口描述 重启云主机 1）必须运行中的主机才能重启 2）安装热补丁时不能重启 3）此操作为异步进行，需要一定时间 4)重启会对费用进行一次结算 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 重启云主机 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   RestoreInstance 接口描述 云主机重装系统 1)此操作为异步进行，需要一定时间 2）包月云主机过期或按量云主机欠费不能重装系统 3）只有关机云主机才能重装 4）该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能重装云主机 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 重装镜像ID </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> 是 </td> <td> 自定义密码，若密码生成方式为Custom(自定义),则keyId为必传参数 </td> <td>   </td> </tr> <tr> <td> DisableRootFlag </td> <td> Boolean </td> <td> 否 </td> <td> 是否禁用Root或Administrator账号 </td> <td>   </td> </tr> <tr> <td> InitUsername </td> <td> String </td> <td> 否 </td> <td> 自定义账户 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   ResumeInstance 接口描述   请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td>   </td> </tr> </tbody> </table>   RunInstances 接口描述 创建云主机 1)资源售罄则不可创建云主机 2）云主机类型与磁盘类型匹配才能创建 3）创建的主机数不能大于可用ip数 4）如果安装安全组，则必须云主机与安全组在同一个网络域 5）所用的镜像必须为可用状态   说明：该接口已过期，不建议继续使用，创建主机请使用新接口RunInstancesByStep 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> 否 </td> <td> 磁盘类型 </td> <td>   </td> </tr> <tr> <td> DiskSizes </td> <td> Integer[] </td> <td> 否 </td> <td> 磁盘大小列表 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 可用区Id </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 是 </td> <td> 高可用域Id </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> 是 </td> <td> 产品规格 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> 否 </td> <td> 子网Id </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 镜像Id </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 云主机显示名 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> <tr> <td> ResourceGroupId </td> <td> String </td> <td> 否 </td> <td> 资源组Id </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> 否 </td> <td> 数量 </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 否 </td> <td> 计费类型 </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 否 </td> <td> 期数 </td> <td>   </td> </tr> <tr> <td> FunctionNames </td> <td> String </td> <td> 否 </td> <td> 方法名 </td> <td>   </td> </tr> <tr> <td> Userdata </td> <td> String </td> <td> 否 </td> <td> 用户数据 </td> <td>   </td> </tr> <tr> <td> UserdataBase64Encoded </td> <td> Boolean </td> <td> 否 </td> <td> 64位用户数据 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> 否 </td> <td> 标签 </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 安全组Id </td> <td>   </td> </tr> <tr> <td> VmhostNames </td> <td> String[] </td> <td> 否 </td> <td> 用户云主机主机名 </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> 否 </td> <td> 是否自动续费 </td> <td>   </td> </tr> <tr> <td> GeneratePasswordType </td> <td> GeneratePasswordType </td> <td> 否 </td> <td> 云主机生成密码方式，默认为随机生成 </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 否 </td> <td> 密钥对id，若密码生成方式为Key(密钥对),则keyId为必传参数 </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> 否 </td> <td> 自定义密码，若密码生成方式为Custom(自定义),则keyId为必传参数 请输入8 - 16 个字符，必须同时包含三项（大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^& 中的特殊符号） </td> <td>   </td> </tr> <tr> <td> IsInstallOracleKsplice </td> <td> Boolean </td> <td> 否 </td> <td> 是否安装OracleKsplice插件 </td> <td>   </td> </tr> <tr> <td> PrivateKey </td> <td> String </td> <td> 否 </td> <td> 私钥 </td> <td>   </td> </tr> <tr> <td> Ip </td> <td> String </td> <td> 否 </td> <td> 指定ip, 多个ip需进行字符串拼接，ip之间使用英文逗号(,)进行分隔 </td> <td>   </td> </tr> <tr> <td> IsSpecifyIp </td> <td> Boolean </td> <td> 否 </td> <td> 是否指定ip true:表示指定   false:表示不指定 </td> <td>   </td> </tr> <tr> <td> RootSize </td> <td> Integer </td> <td> 否 </td> <td> root盘扩容后的大小 </td> <td>   </td> </tr> <tr> <td> RootDiskType </td> <td> String </td> <td> 否 </td> <td> root盘类型 </td> <td>   </td> </tr> <tr> <td> IsRootUpgrade </td> <td> Boolean </td> <td> 否 </td> <td> 是否root扩容 </td> <td>   </td> </tr> <tr> <td> InstanceSourceType </td> <td> InstanceSourceType </td> <td> 否 </td> <td> 主机来源 </td> <td>   </td> </tr> <tr> <td> DisableRootFlag </td> <td> Boolean </td> <td> 否 </td> <td> 是否禁用Root或Administrator账号 </td> <td>   </td> </tr> <tr> <td> InitUsername </td> <td> String </td> <td> 否 </td> <td> 自定义账户 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   RunInstancesByStep 接口描述 创建云主机 1)资源售罄则不可创建云主机 2）云主机类型与磁盘类型匹配才能创建 3）创建的主机数不能大于可用ip数 4）如果安装安全组，则必须云主机与安全组在同一个网络域 5）所用的镜像必须为可用状态 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Disks </td> <td> String </td> <td> 否 </td> <td> 磁盘信息 </td> <td>   </td> </tr> <tr> <td> PayableAmounts </td> <td> String </td> <td> 否 </td> <td> 应付金额 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 是 </td> <td> 可用区Id </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> 是 </td> <td> 高可用域Id </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> 是 </td> <td> 产品规格 </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> 否 </td> <td> 网络域Id </td> <td>   </td> </tr> <tr> <td> SubnetId </td> <td> String </td> <td> 否 </td> <td> 子网Id </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> 是 </td> <td> 镜像Id </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 云主机显示名 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> <tr> <td> ResourceGroupId </td> <td> String </td> <td> 否 </td> <td> 资源组Id </td> <td>   </td> </tr> <tr> <td> Count </td> <td> Integer </td> <td> 否 </td> <td> 数量 </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> 否 </td> <td> 计费类型 </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 否 </td> <td> 期数 </td> <td>   </td> </tr> <tr> <td> FunctionNames </td> <td> String </td> <td> 否 </td> <td> 方法名 </td> <td>   </td> </tr> <tr> <td> Userdata </td> <td> String </td> <td> 否 </td> <td> 用户数据 </td> <td>   </td> </tr> <tr> <td> UserdataBase64Encoded </td> <td> Boolean </td> <td> 否 </td> <td> 64位用户数据 </td> <td>   </td> </tr> <tr> <td> Tags </td> <td> String </td> <td> 否 </td> <td> 标签 </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> 否 </td> <td> 安全组Id </td> <td>   </td> </tr> <tr> <td> VmhostNames </td> <td> String[] </td> <td> 否 </td> <td> 用户云主机主机名 </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> 否 </td> <td> 是否自动续费 </td> <td>   </td> </tr> <tr> <td> GeneratePasswordType </td> <td> GeneratePasswordType </td> <td> 否 </td> <td> 云主机生成密码方式，默认为随机生成 </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 否 </td> <td> 密钥对id，若密码生成方式为Key(密钥对),则keyId为必传参数 </td> <td>   </td> </tr> <tr> <td> CustomPassword </td> <td> String </td> <td> 否 </td> <td> 自定义密码，若密码生成方式为Custom(自定义),则keyId为必传参数 请输入8 - 16 个字符，必须同时包含三项（大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^& 中的特殊符号） </td> <td>   </td> </tr> <tr> <td> IsInstallOracleKsplice </td> <td> Boolean </td> <td> 否 </td> <td> 是否安装OracleKsplice插件 </td> <td>   </td> </tr> <tr> <td> PrivateKey </td> <td> String </td> <td> 否 </td> <td> 私钥 </td> <td>   </td> </tr> <tr> <td> Ip </td> <td> String </td> <td> 否 </td> <td> 指定ip, 多个ip需进行字符串拼接，ip之间使用英文逗号(,)进行分隔 </td> <td>   </td> </tr> <tr> <td> IsSpecifyIp </td> <td> Boolean </td> <td> 否 </td> <td> 是否指定ip true:表示指定   false:表示不指定 </td> <td>   </td> </tr> <tr> <td> RootSize </td> <td> Integer </td> <td> 否 </td> <td> root盘扩容后的大小 </td> <td>   </td> </tr> <tr> <td> RootDiskType </td> <td> String </td> <td> 否 </td> <td> root盘类型 </td> <td>   </td> </tr> <tr> <td> IsRootUpgrade </td> <td> Boolean </td> <td> 否 </td> <td> 是否root扩容 </td> <td>   </td> </tr> <tr> <td> InstanceSourceType </td> <td> InstanceSourceType </td> <td> 否 </td> <td> 主机来源 </td> <td>   </td> </tr> <tr> <td> DisableRootFlag </td> <td> Boolean </td> <td> 否 </td> <td> 是否禁用Root或Administrator账号 </td> <td>   </td> </tr> <tr> <td> InitUsername </td> <td> String </td> <td> 否 </td> <td> 自定义账户 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   SaveHeaderTitleCustom 接口描述 保存自定义表头选项接口 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 是 </td> <td> 产品代码 </td> <td>   </td> </tr> <tr> <td> TitleKeys </td> <td> String </td> <td> 是 </td> <td> 自定义选项集合，多个key需进行字符串拼接，key之间使用英文逗号(,)进行分隔 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   StartInstance 接口描述 启动云主机 1)非关机状态不能启动云主机 2）包月云主机或者按量云主机欠费不能启动云主机 3）开机会对费用进行结算 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td> 需要调用QueryAsyncJob接口查询具体执行情况，参考<a href="http://pinganyun.com/ssr/help/api_center/API_DOC/BASE_API.API_Description" target="_blank">通用基础API描述</a>。 </td> </tr> </tbody> </table>   StopInstance 接口描述 云主机关机 1)该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能关机云主机 2）只有运行中的云主机才能关机 3）安装热补丁时不能关机 4）关机会对费用进行一次结算 5）该操作异步进行，需要一定的时间 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td> 需要调用QueryAsyncJob接口查询具体执行情况，参考<a href="https://pinganyun.com/ssr/help/api_center/API_DOC/BASE_API.API_Description" target="_blank">通用基础API描述</a>。 </td> </tr> </tbody> </table>   SuspendInstance 接口描述   请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td> 需要调用QueryAsyncJob接口查询具体执行情况，参考<a href="https://pinganyun.com/ssr/help/api_center/API_DOC/BASE_API.API_Description" target="_blank">通用基础API描述</a>。 </td> </tr> </tbody> </table>   UpdateInstanceAutoRenewFlag 接口描述 修改云主机是否自动续费 1)主机是包月的条件下才能修改。 2）已到期或者今天到期的云主机不能修改是否自动续费 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> AutoRenewflag </td> <td> Boolean </td> <td> 是 </td> <td> 是否自动续费 true为自动续费 false为非自动续费 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> </tbody> </table>   UpdateInstanceName 接口描述 修改用户自定义云主机名称 1）只有在主机关机的状态下才能修改。 2)已到期云主机不能修改云主机名 3）操作状态为无才能修改主机名 4）该操作为异步进行 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 是 </td> <td> 云主机名称 每个主机名以字母开头, 允许字母, 数字, -, 最长64个字符,多个主机名称以英文逗号隔开 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td> 需要调用QueryAsyncJob接口查询具体执行情况，参考<a href="https://pinganyun.com/ssr/help/api_center/API_DOC/BASE_API.API_Description" target="_blank">通用基础API描述</a>。 </td> </tr> </tbody> </table>   UpgradeInstance 接口描述 云主机升配 1)有未支付订单的主机不能升配 2）关机且未过期的主机才能升配 3)升配时,必须与原主机类型不同 4)GPU主机不能升配 5)必须有足够的CPU和内存的配额才能升配 6）升配会对费用进行一次结算 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstance接口可以查看所有的云主机的id </td> <td>   </td> </tr> <tr> <td> NewInstanceType </td> <td> String </td> <td> 是 </td> <td> 更改配置后的云主机类型 可以通过ListProductSeries接口查询产品系列信息。 </td> <td>   </td> </tr> <tr> <td> CouponId </td> <td> Long </td> <td> 否 </td> <td> 代金券Id 可以通过支付服务里的listAvailableCoupons方法查询 </td> <td>   </td> </tr> <tr> <td> Period </td> <td> Integer </td> <td> 否 </td> <td> 期数,最小1，最大36 仅包月主机才需要传，通过GetRemainMonth接口查询期数 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品编码 </td> <td>   </td> </tr> <tr> <td> OrderId </td> <td> String </td> <td> 订单Id </td> <td>   </td> </tr> <tr> <td> Status </td> <td> OrderStatus </td> <td> 订单状态 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 产品编码 </td> <td>   </td> </tr> </tbody> </table>   CreateKey 接口描述 创建密钥对 创建密钥对需要通过登陆认证获取令牌。 应用对应的DTO调用createKey方法来创建密钥对。 创建密钥对后可进行关联实例的操作。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> 否 </td> <td> 显示名 请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符 </td> <td>   </td> </tr> <tr> <td> KeyType </td> <td> KeyType </td> <td> 是 </td> <td> 生成类型 当KeyType为IMPORT时,PublicKey为必填 类型分为两种： IMPORT：导入已有 AUTO：自动 </td> <td>   </td> </tr> <tr> <td> PublicKey </td> <td> String </td> <td> 否 </td> <td> 公钥内容 当KeyType为IMPORT时,PublicKey为必填 长度不得超过1024位 需要导入符合Base64编码格式的公钥 </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域Id 地域Id决定了用户创建的秘钥对分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Key </td> <td> KeyBean </td> <td> 密钥对信息 </td> <td>   </td> </tr> </tbody> </table>   CreateKeyRelatedInstance 接口描述 创建云主机关系密钥对 创建云主机关系密钥对需要通过登陆认证获取令牌。 可通过ListAbleKeyRelateInstancs接口来查询可关联的实例。 关联时需要发送短信验证。 创建时需要注意如果已到期云主机，到达强制关机时间，包月的云主机一旦关机，不允许云主机关系密钥对 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> 是 </td> <td> 云主机Id、对应的云主机的uuid 可以通过ListInstances接口查询到云主机信息。 </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 是 </td> <td> key id 可以通过ListKey接口查询到密钥对的信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobIds </td> <td> List<String> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   DeleteKey 接口描述 删除密钥对 删除密钥对需要通过登陆认证获取令牌。 通过获取密钥对的id得到所属的密钥对再调用deleteKey方法删除密钥对。 接口为异步job 创建  查看删除密钥对是否成功 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 是 </td> <td> key id、密钥对的id值 可以通过ListKey接口查询到密钥对的信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> 任务 Id </td> <td> 需要调用QueryAsyncJob接口查询具体执行情况，参考<a href="https://pinganyun.com/ssr/help/api_center/API_DOC/BASE_API.API_Description" target="_blank">通用基础API描述</a>。 </td> </tr> </tbody> </table>   DeleteKeyRelatedInstance 接口描述 删除云主机关系密钥对 可通过ListKeyRelatedInstance接口来查询可取消关联的实例。 删除云主机关系密钥对需要通过登陆认证获取令牌。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> 是 </td> <td> 云主机Id 可以通过ListInstances接口查询到云主机信息。 </td> <td>   </td> </tr> <tr> <td> KeyId </td> <td> String </td> <td> 是 </td> <td> key id 可以通过ListKey接口查询到密钥对的信息。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> JobIds </td> <td> List<String> </td> <td>   </td> <td>   </td> </tr> </tbody> </table>   ListKey 接口描述 分页查询租户下的密钥对信息 分页查询租户下的密钥对信息需要通过登陆认证获取令牌。 通过对应的DTO调用findAllByTenant查询信息 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示1000条数据。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> 是 </td> <td> 地域 地域Id决定了用户创建的云磁盘分布在哪里。 可以通过ListRegions接口查询区域信息。 </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> 否 </td> <td> 名称 通过CreateKey接口自动生成的秘钥名称 </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> 否 </td> <td> 排序关键字 分页查询时使用。 默认按时间排序 </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> 否 </td> <td> 排序方式 分页查询时使用。 排序方式有DESC和ASC,默认按DESC排序 </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> 否 </td> <td> 分页页码 分页查询时使用。 不传会默认为1。 </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> 否 </td> <td> 分页大小 分页查询时使用。 不传默认为1000。 </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Keys </td> <td> List<KeyBean> </td> <td> key信息列表 </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> 总数 </td> <td>   </td> </tr> </tbody> </table>   ListPods 接口描述 查询高可用域 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 是否必须 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> 否 </td> <td> 可用区Id 可以通过ListZones接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> 否 </td> <td> 高可用域Id 可以通过ListPods接口查询可用区信息。 </td> <td>   </td> </tr> <tr> <td> ProductCode </td> <td> String </td> <td> 否 </td> <td> 产品Code 可以通过ListProducts接口可以查询所有的产品的code </td> <td>   </td> </tr> </tbody> </table> 响应参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> 参数名称 </td> <td> 参数类型 </td> <td> 参数描述 </td> <td> 备注 </td> </tr> <tr> <td> Pods </td> <td> List<PodBean> </td> <td> 高可用域信息列表 </td> <td>   </td> </tr> </tbody> </table>

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