API 概览

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

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题