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

API 概览

<table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> API </td> <td style="background-color:#ededed"> 描述 </td> </tr> <tr> <td> CancelShareImage </td> <td> 取消共享镜像 </td> </tr> <tr> <td> CreateImage </td> <td> 创建镜像 创建镜像需要通过登陆认证获取令牌 调用接口应注意： 1)云磁盘或者云主机必须存在一个，否则抛ParameterRequiredException异常 </td> </tr> <tr> <td> DeleteImage </td> <td> 根据镜像id删除镜像 需要通过登陆认证获取令牌 调用接口注意： 1)只有状态为Available、Unavailable、CreateFailed、DeleteFailed的镜像才能被删除 </td> </tr> <tr> <td> GetImage </td> <td>   </td> </tr> <tr> <td> ListImageShareTenants </td> <td> 查询镜像共享的租户列表 </td> </tr> <tr> <td> ListImages </td> <td> 查询所有镜像 需要通过登陆认证获取令牌 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示100条数据。 </td> </tr> <tr> <td> ListOsMappingCsOs </td> <td> 根据地域和可用区筛选出所有操作系统映射到CS操作系统对应关系 需要通过登陆认证获取令牌 可以通过ListRegions接口查询区域信息 通过ListZones接口查询可用区信息 </td> </tr> <tr> <td> ListOsTypes </td> <td> 查询操作系统类型 需要通过登陆认证获取令牌 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示10条数据，排序为升序排列。 2、如果分页大小超过3000，则设置为3000 </td> </tr> <tr> <td> ManualUploadImage </td> <td> 手动上传镜像 需要通过登陆认证获取令牌 通过ListImages接口可以查询所有镜像 </td> </tr> <tr> <td> ManualUploadImageCheck </td> <td> 手动上传镜像时校验URL 该接口只针对上传镜像时对URL的路径校验是否符合规范 </td> </tr> <tr> <td> ModifyImageAttribute </td> <td> 根据镜像的id修改镜像的属性 需要通过登陆认证获取令牌 通过ListImages接口可以查询所有镜像 </td> </tr> <tr> <td> ShareImage </td> <td> 共享镜像 </td> </tr> <tr> <td> SyncImage </td> <td>   </td> </tr> <tr> <td> BatchDestroyInstance </td> <td> 批量删除云主机 1）起多个job进行删除，一个主机对应一个job 2）只有关机和创建失败状态的主机才能执行此操作 3）单个主机的删除失败不会影响其他主机的删除 4）有安全产品、有依赖资源的云主机不能删除 5)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> BatchRenewInstance </td> <td> 批量续费云主机 </td> </tr> <tr> <td> BatchStartInstance </td> <td> 批量开启云主机 1）起多个job进行开机，一个主机对应一个job 2）只有关机状态的主机才能执行此操作 3）单个主机的启动失败不会影响其他主机的启动 4）过期的包月云主机不支持开机操作 5）租户欠费不能进行开机操作 6）批量开机会进行费用结算 7)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> BatchStopInstance </td> <td> 批量关闭云主机 1）起多个job进行关机，一个主机对应一个job 2）只有运行中状态的主机才能执行此操作 3）单个主机的关机失败不会影响其他主机的关机操作 4）批量关机会对费用进行一次结算 5)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> BatchUpdateAutoRenewFlag </td> <td> 修改云主机是否自动续费 1)主机是包月的条件下才能修改。 2）已到期或者今天到期的云主机不能修改是否自动续费 </td> </tr> <tr> <td> CancelRelateInstance </td> <td> 取消定时规则关联的实例 </td> </tr> <tr> <td> CheckInstanceName </td> <td> 检查用户自定义云主机名称的唯一性 </td> </tr> <tr> <td> CheckIpForCreateEcs </td> <td> 校验指定ip有效性 </td> </tr> <tr> <td> CreateEcsScheduledRule </td> <td> 创建云主机定时规则 </td> </tr> <tr> <td> DeleteEcsScheduledRule </td> <td> 删除云主机定时规则 </td> </tr> <tr> <td> DestroyInstance </td> <td> 删除云主机 1)只有关机或者创建失败的云主机才能删除 2）有未支付的订单的主机不能删除 3）该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能删除云主机 4)checkDependency为true:释放云主机时，校验资源依赖关系，如存在依赖资源，需先删除依赖资源，才能释放云主机 checkDependency为false:释放云主机时，不校验资源依赖关系 5)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> DowngradeInstance </td> <td> 云主机降配 a.降配做的校验： 1）未支付订单 2）云主机必须关机,且不为包月过期云主机 3）操作状态为 None 4)必须与原实例类型不同，同时必须在同一个tag内 5）价格不能高于原价格 6）必须有足够的CPU和内存的配额 b.此接口是同步调用的 </td> </tr> <tr> <td> GetAllEcsSummary </td> <td> 获取所有区域云主机概览信息 </td> </tr> <tr> <td> GetEcsSummary </td> <td> 获取云主机概览信息 </td> </tr> <tr> <td> GetHeaderTitleCustom </td> <td> 获取实例自定义表头选项 </td> </tr> <tr> <td> GetInstance </td> <td> 获取单个云主机信息 </td> </tr> <tr> <td> GetInstancePassword </td> <td> 获取云主机密码 </td> </tr> <tr> <td> InstallAgent </td> <td>   </td> </tr> <tr> <td> InstallOrUninstallOracleKsplice </td> <td> 安装平安热补丁 1)只有运行中的主机且未安装热补丁才能安装热补丁 2）通过登陆认证获取令牌 3）安装中的主机不能重启或关机 4)只有操作系统中配置支持安装热补丁且为LINUX才支持安装 </td> </tr> <tr> <td> InstallOracleKsplice </td> <td> 安装平安热补丁 1)只有运行中的主机且未安装热补丁才能安装热补丁 2）通过登陆认证获取令牌 3）安装中的主机不能重启或关机 4)只有操作系统中配置支持安装热补丁且为LINUX才支持安装 5）GPU主机不能安装热补丁 6)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> ListAbleKeyRelateInstancs </td> <td> 查询可用关联密钥对的云主机 1)云主机状态必须为运行中状态 2）分页显示 </td> </tr> <tr> <td> ListAccessoryNicByNetwork </td> <td> 查询当前网络域下的所有扩展网卡 </td> </tr> <tr> <td> ListAllEcsScheduledRules </td> <td> 获取云主机定时规则 </td> </tr> <tr> <td> ListAllRelatedInstances </td> <td> 获取定时规则已经关联的云主机列表 </td> </tr> <tr> <td> ListExpiredInstance </td> <td> 查询已到期的云主机 </td> </tr> <tr> <td> ListExpiringInstance </td> <td> 查询即将到期的云主机 </td> </tr> <tr> <td> ListInstanceDependencies </td> <td> 获取云主机依赖资源。 </td> </tr> <tr> <td> ListInstanceProductSeries </td> <td> 查询ECS相关的产品系列信息 </td> </tr> <tr> <td> ListInstanceProductSpec </td> <td> 获取云主机产品规格信息列表 </td> </tr> <tr> <td> ListInstanceTypes </td> <td> 查询云主机类型 </td> </tr> <tr> <td> ListInstanceTypesByOperation </td> <td> 升降配时查询系列下的有效主机类型 </td> </tr> <tr> <td> ListInstances </td> <td> 查询云主机 </td> </tr> <tr> <td> ListKeyRelatedInstance </td> <td> 查询可用删除绑定密钥对的云主机 </td> </tr> <tr> <td> ListProductDynamicConfig </td> <td> 查询产品动态可配置列表 </td> </tr> <tr> <td> ModifyChargeType </td> <td> 按量转包月 1)只有按量才能转包月 2）创建中、创建失败、取消、释放、释放中状态都不能按量转包月 3)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> ModifyEcsScheduledRule </td> <td> 修改云主机定时规则 </td> </tr> <tr> <td> ModifyInstanceAttribute </td> <td> 修改云主机的属性 </td> </tr> <tr> <td> OpenConsole </td> <td> 打开控制台 </td> </tr> <tr> <td> RelateInstance </td> <td> 定时规则关联实例 </td> </tr> <tr> <td> RenewInstance </td> <td> 云主机续费 1)只有包月云主机才能续费 2）创建中、创建失败、释放、释放中状态都不能续费 3）主机下挂载的包月磁盘只能是可用状态。 4)此操作为异步进行，需要一定时间 </td> </tr> <tr> <td> ResetPasswordForInstance </td> <td> 重置云主机密码 1）到期的包月云主机不能重置密码 2）只有关机状态才能重置密码 3）重置密码为异步操作 </td> </tr> <tr> <td> RestartInstance </td> <td> 重启云主机 1）必须运行中的主机才能重启 2）安装热补丁时不能重启 3）此操作为异步进行，需要一定时间 4)重启会对费用进行一次结算 </td> </tr> <tr> <td> RestoreInstance </td> <td> 云主机重装系统 1)此操作为异步进行，需要一定时间 2）包月云主机过期或按量云主机欠费不能重装系统 3）只有关机云主机才能重装 4）该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能重装云主机 </td> </tr> <tr> <td> ResumeInstance </td> <td>   </td> </tr> <tr> <td> RunInstances </td> <td> 创建云主机 1)资源售罄则不可创建云主机 2）云主机类型与磁盘类型匹配才能创建 3）创建的主机数不能大于可用ip数 4）如果安装安全组，则必须云主机与安全组在同一个网络域 5）所用的镜像必须为可用状态 </td> </tr> <tr> <td> RunInstancesByStep </td> <td> 创建云主机 1)资源售罄则不可创建云主机 2）云主机类型与磁盘类型匹配才能创建 3）创建的主机数不能大于可用ip数 4）如果安装安全组，则必须云主机与安全组在同一个网络域 5）所用的镜像必须为可用状态 </td> </tr> <tr> <td> SaveHeaderTitleCustom </td> <td> 保存实例自定义表头选项 </td> </tr> <tr> <td> StartInstance </td> <td> 启动云主机 1)非关机状态不能启动云主机 2）包月云主机或者按量云主机欠费不能启动云主机 3）开机会对费用进行结算 </td> </tr> <tr> <td> StopInstance </td> <td> 云主机关机 1)该主机下如果磁盘正在创建、扩容、挂载、卸载或者释放，则不能关机云主机 2）只有运行中的云主机才能关机 3）安装热补丁时不能关机 4）关机会对费用进行一次结算 5）该操作异步进行，需要一定的时间 </td> </tr> <tr> <td> SuspendInstance </td> <td>   </td> </tr> <tr> <td> UpdateInstanceAutoRenewFlag </td> <td> 修改云主机是否自动续费 1)主机是包月的条件下才能修改。 2）已到期或者今天到期的云主机不能修改是否自动续费 </td> </tr> <tr> <td> UpdateInstanceName </td> <td> 修改用户自定义云主机名称 1）只有在主机关机的状态下才能修改。 2)  已到期云主机不能修改云主机名 3）操作状态为无才能修改主机名 4）该操作为异步进行 </td> </tr> <tr> <td> UpgradeInstance </td> <td> 云主机升配 1)有未支付订单的主机不能升配 2）关机且未过期的主机才能升配 3)升配时,必须与原主机类型不同 4)GPU主机不能升配 5)必须有足够的CPU和内存的配额才能升配 6）升配会对费用进行一次结算 </td> </tr> <tr> <td> CreateKey </td> <td> 创建密钥对 创建密钥对需要通过登陆认证获取令牌。 应用对应的DTO调用createKey方法来创建密钥对。 创建密钥对后可进行关联实例的操作。 接口只适用于华南、香港地区，华东未上密钥对功能 </td> </tr> <tr> <td> CreateKeyRelatedInstance </td> <td> 创建云主机关系密钥对 创建云主机关系密钥对需要通过登陆认证获取令牌。 可通过ListAbleKeyRelateInstancs接口来查询可关联的实例。 关联时需要发送短信验证。 创建时需要注意如果已到期云主机，到达强制关机时间，包月的云主机一旦关机，不允许云主机关系密钥对 </td> </tr> <tr> <td> DeleteKey </td> <td> 删除密钥对 删除密钥对需要通过登陆认证获取令牌。 通过获取密钥对的id得到所属的密钥对再调用deleteKey方法删除密钥对。 接口为异步job 创建  查看删除密钥对是否成功 </td> </tr> <tr> <td> DeleteKeyRelatedInstance </td> <td> 删除云主机关系密钥对 可通过ListKeyRelatedInstance接口来查询可取消关联的实例。 删除云主机关系密钥对需要通过登陆认证获取令牌。 </td> </tr> <tr> <td> ListKey </td> <td> 分页查询租户下的密钥对信息 分页查询租户下的密钥对信息需要通过登陆认证获取令牌。 通过对应的DTO调用findAllByTenant查询信息 调用接口时，需要注意： 1、接口采用分页查询的方式，默认页码为1，每页显示1000条数据。 </td> </tr> <tr> <td> ListPods </td> <td> 查询高可用域 </td> </tr> </tbody> </table>

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