FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 1、云主机服务描述 云主机服务能够在服务器上创建独立的虚拟机,自动安装操作系统、配置网络环境、弹性增加配置、开机、关机、重启、远程管理、修改管理员密码、远程管理端口等操作 # 2、运行平台 系统支持管理多平台创建的云主机,如:Hyper-V、VMWare等虚拟机平台 当前支持平台对应表格如下: |平台名称|简称| | ------------ | ------------ | |Microsoft Hyper-V|Hyper-V| ## 2.1、Hyper-V使用前准备 ### 2.1.1 运行环境 Windows Server 2016及以上版本,服务操作系统需[安装Hyper-V服务](/doc/course/setuphyperv.html "安装Hyper-V服务") ### 2.1.2 网卡硬件 云主机服务在提供网络支撑时,建议服务器有两张网卡,一张宿主机独立占用,另外一张提供云主机使用。 ### 2.1.3 虚拟交换机 云主机服务在创建时需要配置虚拟交换机以提供网络支持,FastOSAPI使用的网络交换机名称是固定的,不可改变的,其中内网交换机名称命名为**fastosapi_intranet_vmswitch**,外网交换机名称命名为**fastosapi_extranet_vmswitch**。 [点击此处查看如何创建内网虚拟交换机](http://www.fastosapi.com/doc/course/vmswtich.html#1%E3%80%81%E5%88%9B%E5%BB%BA%E5%86%85%E7%BD%91%E8%99%9A%E6%8B%9F%E4%BA%A4%E6%8D%A2%E6%9C%BA "点击此处查看如何创建内网虚拟交换机"); [点击此处查看如何创建外网虚拟交换机](http://www.fastosapi.com/doc/course/vmswtich.html#2%E3%80%81%E5%88%9B%E5%BB%BA%E5%A4%96%E7%BD%91%E8%99%9A%E6%8B%9F%E4%BA%A4%E6%8D%A2%E6%9C%BA "点击此处查看如何创建外网虚拟交换机")。 # 3、接口目录 |接口名称|接口描述| | ------------ | ------------ | |[CVM.CreateCVM](#4、CVM.CreateCVM "CVM.CreateCVM")|创建云主机,由于本接口在服务端操作时间比较长,因此建议采用异步请求| |[CVM.StopCVM](#5、CVM.StopCVM "CVM.StopCVM")|关闭云主机,仅实例处于开机状态下有效| |[CVM.StartCVM](#6、CVM.StartCVM "CVM.StartCVM")|启动云主机,仅实例处于关机状态下有效| |[CVM.ReStartCVM](#7、CVM.ReStartCVM "CVM.ReStartCVM")|重启云主机,仅实例在已启动状态下有效| |[CVM.SetSecurityGroupRules](#8、CVM.SetSecurityGroupRules "CVM.SetSecurityGroupRules")|保存安全组规则| |[CVM.GetVMResStats](#9、CVM.GetVMResStats "CVM.GetVMResStats")|获取云主机当前资源用量| |[CVM.GetVNCData](#10、CVM.GetVNCData "CVM.GetVNCData")|获取云主机远程管理地址| |[CVM.Reinstall](#11、CVM.Reinstall "CVM.Reinstall")|实例重装操作系统| |[CVM.SetExpDate](#12、CVM.SetExpDate "CVM.SetExpDate")|设置实例到期日期| |[CVM.SetPWD](#13、CVM.SetPWD "CVM.SetPWD")|修改实例操作系统管理员密码| |[CVM.SetRemotePort](#14、CVM.SetRemotePort "CVM.SetRemotePort")|修改实例远程管理端口,Windows为远程桌面端口,Linux为SSH的登陆端口| |[CVM.SetProcessor](#15、CVM.SetProcessor "CVM.SetProcessor")|配置实例CPU,需实例关机状态下才可操作| |[CVM.SetMemory](#16、CVM.SetMemory "CVM.SetMemory")|修改内存,单位:GB,需实例关机状态下才可操作| |[CVM.SetIP](#17、CVM.SetIP "CVM.SetIP")|设置实例IP| |[CVM.ResizeVHD](#18、CVM.ResizeVHD "CVM.ResizeVHD")|磁盘扩容,用户应进入操作系统手动为分区扩展| |[CVM.AddSnapshot](#19、CVM.AddSnapshot "CVM.AddSnapshot")|创建云主机快照| |[CVM.RemoveSnapshot](#20、CVM.RemoveSnapshot "CVM.RemoveSnapshot")|删除云主机快照| |[CVM.RestoreSnapshot](#21、CVM.RestoreSnapshot "CVM.RestoreSnapshot")|还原云主机快照| |[CVM.GetSnapshot](#22、CVM.GetSnapshot "CVM.GetSnapshot")|获取云主机快照| |[CVM.RemoveCVM](#23、CVM.RemoveCVM "CVM.RemoveCVM")|删除云主机| |[CVM.SetIOPS](#24、CVM.SetIOPS "CVM.SetIOPS")|设置云主机IOPS| |[CVM.AddDataVHD](#25、CVM.AddDataVHD "CVM.AddDataVHD")|添加数据磁盘| |[CVM.SetBandWidth](#26、CVM.SetBandWidth "CVM.SetBandWidth")|设置云主机带宽| |[CVM.SetResLimit](#27、CVM.SetResLimit "CVM.SetResLimit")|快速设置资源限制,应注意所有参数都需填写| |[CVM.GetObjectSetting](#28、CVM.GetObjectSetting "CVM.GetObjectSetting")|获取实例当前配置数据| |[CVM.GetVMNetTrafficData](#29、CVM.GetVMNetTrafficData "CVM.GetVMNetTrafficData")|获取网络流量统计数据,可根据月份、日期进行查询| |[CVM.GetAllVM](#30、CVM.GetAllVM "CVM.GetAllVM")|获取宿主机下所有虚拟机| |[CVM.ReBuildVHDAccess](#31、CVM.ReBuildVHDAccess "CVM.ReBuildVHDAccess")|重建虚拟硬盘权限| |[CVM.GetVMMeter](#32、CVM.GetVMMeter "CVM.GetVMMeter")|获取资源计量器,通过本接口可根据时间段查询资源使用计量信息,包括:网络流量、磁盘I/O次数、内存分配、CPU占比、主机状态| |[CVM.Export](#33、CVM.Export "CVM.Export")|导出实例| |[CVM.Import](#34、CVM.Import "CVM.Import")|导入实例| |[CVM.GetHostMeter](#35、CVM.GetHostMeter "CVM.GetHostMeter")|获取宿主机资源计量器,通过本接口可根据时间段查询资源使用计量信息,包括:网络流量、磁盘I/O次数、已使用内存、CPU占比| |[CVM.GetHostResStats](#36、CVM.GetHostResStats "CVM.GetHostResStats")|获取宿主机当前资源计量| |[CVM.ColdMove](#37、CVM.ColdMove "CVM.ColdMove")|冷迁移实例| |[CVM.SetNotes](#38、CVM.SetNotes "CVM.SetNotes")|设置实例注释| |[CVM.GetVMThumbnailImage](#39、CVM.GetVMThumbnailImage "CVM.GetVMThumbnailImage")|获取实例当前屏幕缩略图| |[CVM.SetVlanId](#40、CVM.SetVlanId "CVM.SetVlanId")|设置虚拟Vlan标识| |[CVM.AddClusterVirtualMachineRole](#41、CVM.AddClusterVirtualMachineRole "CVM.AddClusterVirtualMachineRole")|添加到集群虚拟机角色| |[CVM.RemoveExport](#42、CVM.RemoveExport "CVM.RemoveExport")|删除导出实例| |[CVM.MoveClusterVirtualMachineRole](#43、CVM.MoveClusterVirtualMachineRole "CVM.MoveClusterVirtualMachineRole")|集群移除虚拟机角色| |[CVM.ReCreateNetworkAdapter](#44、CVM.ReCreateNetworkAdapter "CVM.ReCreateNetworkAdapter")|重建实例网卡| |[CVM.BatchSetVHDIOPS](#45、CVM.BatchSetVHDIOPS "CVM.BatchSetVHDIOPS")|批量设置云主机IOPS| # 4、CVM.CreateCVM ### 4.1 接口描述 创建云主机方法,由于本接口在服务端操作时间比较长,因此**建议采用异步请求**。 ### 4.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。与其它云主机不能重名,建议使用您的系统数据库记录值Id| |ExtranetSwitchName|String|-|必填|实例所属外网交换机名称,如放空则使用默认值:fastosapi_extranet_vmswitch| |ExpDate|Int|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| |VMSavePath|String|-|必填|云主机存放目录位置,该目录在磁盘上必须存在,如:d:\cvm,那么实例创建后将存放在d:\\cvm\\**VMName**| |VHDSystemSavePath|String|-|必填|云主机**系统盘**存放位置,如填写d:\\osvhd(该目录在磁盘上必须存在),那么最终存储在d:\\osvhd\\**VMName**| |VHDDataSavePath|String|-|必填|云主机**数据盘**存放位置,如填写d:\\datavhd(该目录在磁盘上必须存在),那么最终存储在d:\\datavhd\\**VMName**| |ImageFile|String|-|必填|操作系统镜像文件位置,云主机创建后会复制该镜像文件做为云主机的系统盘| |Disks|JsonArray|-|必填|云主机欲挂载的磁盘集合,类型为Disk对象集合,[点击查看Disk对象](#4.2.1 Disk对象 "点击查看Disk对象")| |MemoryStartupBytes|Decimal|-|必填|云主机启动内存,单位:GB| |MemoryMaximumBytes|Decimal|-|必填|云主机最大内存,单位:GB,当启动内存与最大内存相等时,表示实例采用固定内存,反之表示动态内存| |MemoryBuffer|Int|-|必填|实例内存保留为缓冲区的内存百分比,允许的值范围从 5 到 2000| |MemoryPriority|Int|-|必填|设置实例相对于其它实例的内存可用性优先级,允许的值范围从 0 到 100| |Processor|Int|-|必填|实例CPU数量| |ProcessorMaximum|Int|-|必填|实例CPU可用资源的最大百分比,允许的值范围从 0 到 100| |ProcessorReserve|Int|-|必填|指定要为实例保留的CPU资源百分比,允许的值范围从 0 到 100| |ProcessorRelativeWeight|Int|-|必填|相对权重,指定将物理计算机的处理能力分配给该实例相对于其他实例的优先级,允许的值范围从 1 到 10000| |ProcessorVirtualizationEnabled|Int|0|非必填|CPU是否支持虚拟化,0不支持,1支持| |ExtranetVlanId|Int|-|必填|外网VlanId,≤0表示不启用虚拟LAN标识| |ExtranetBandWidth|Decimal|-|必填|外网带宽,单位:Mbps(1Mbps=1000Kbit/s)| |ExtranetMACAddress|String|-|必填|外网MAC地址,建议根据系统数据库存储Id值生成MAC地址,防止造成重复,[点击此处查看MAC生成算法](#4.2.3 MACAddress算法 "点击此处查看MAC生成算法")| |ExtranetIP|JsonArray|-|必填|外网IP对象集合,[点击此处查看IP对象](#4.2.5 IP对象 "点击此处查看IP对象")| |ExtranetIPV6|JsonArray|-|必填|外网IPV6对象集合,[点击此处查看IP对象](#4.2.5 IP对象 "点击此处查看IP对象")| |ExtranetDNS|String|-|必填|外网DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"8.8.8.8,8.8.4.4"| |ExtranetDNSV6|JsonArray|-|必填|外网IPV6 DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"2001:4860:4860::8888,2001:4860:4860::8844"| |IntranetVlanId|Int|-|必填|内网VlanId,≤0表示不启用虚拟LAN标识| |IntranetBandWidth|Decimal|-|必填|内网带宽,单位:Mbps(1Mbps=1000Kbit/s)| |IntranetMACAddress|String|-|必填|内MAC地址,建议根据系统数据库存储Id值生成MAC地址,防止造成重复,[点击此处查看MAC生成算法](#4.2.3 MACAddress算法 "点击此处查看MAC生成算法")| |IntranetIPAddress|String|-|必填|内网IP地址,10.0.0.1以上的不重复IP,应注意10.0.0.1已被网关占用,建议根据系统数据库存储Id值生成内网IP,防止造成重复,[点击此处查看内网IP生成算法](#4.2.4 内网IP生成算法 "点击此处查看内网IP生成算法")| |IntranetDNS|String|-|必填|内网DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"8.8.8.8,8.8.4.4"| |ObjPassword|String|-|必填|实例密码,云主机实例创建成功后操作系统的管理员默认密码| |RemotePort|Int|win3389、linux22|非必填|远程管理端口,Windows为远程桌面端口,Linux为SSH的登陆端口,可用范围:1到65535| |SecurityGroupRules|JsonArray|-|非必填|网络安全组规则集合,若该参数无传值,则表示允许所有网络进出;若该参数有传值,则系统默认禁止所有TCP/UPD的端口进出及禁止ICMP(用于PING命令),那么需要注意远程桌面、WEB等常见端口的增加。[点击查看SecurityGroupRule对象](#4.2.2 SecurityGroupRule对象 "点击查看SecurityGroupRule对象")。| |MinimumIOPS|long|-|非必填|最小IOPS,1M=128IOPS| |MaximumIOPS|long|-|非必填|最大IOPS,1M=128IOPS,如MinimumIOPS与MaximumIOPS其中一个大于0,则表示启用IOPS限制;如MinimumIOPS与MaximumIOPS均等于0,则表示关闭IOPS限制,使用系统默认值| |Notes|String|-|非必填|实例注释内容| #### 4.2.1 Disk对象 Disk对象为虚拟磁盘对象,以下为对象字段 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |Id|String|磁盘ID,限英文字母+数字+下划线,建议使用您的系统数据库记录值Id| |IsSystem|Int|是否为系统盘,1为是,0为否| |Size|Int|磁盘大小,单位:GB,如果是系统盘且大于40GB,用户应进入操作系统手动为分区扩展| Json示例 ```json {"Id":1001,"IsSystem":0,"Size":100} ``` Disk集合Json示例 ```json [ { "Id":1001, "IsSystem":1, "Size":40 }, { "id":1002, "IsSystem":0, "Size":100 } ] ``` #### 4.2.2 SecurityGroupRule对象 SecurityGroupRule对象为云主机网络安全组规则对象,以下为对象字段 Json示例 ```json {"Action":"Allow","Direction":"Inbound","Weight":5,"Protocol":"TCP","PortRange":"3389"} ``` SecurityGroupRule集合示例 ```json [{"Action":"Allow","Direction":"Inbound","Weight":4,"Protocol":"TCP","PortRange":"80-82"},{"Action":"Allow","Direction":"Inbound","Weight":5,"Protocol":"TCP","PortRange":"3389"}] ``` |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |Action|String|Allow为通过,Deny为禁止| |Direction|String|Inbound为入方向(外部访问本机为入方向),Outbound为出方向(本机访问外部网络为出方向)| |Weight|Int|权重,每台实例的规则,相同方向权重不能重复,权重需大于3,可选范围:4到100| |Protocol|String|协议类型,可选值:TCP、UDP、ICMP| |PortRange|String|端口范围,格式:端口1-端口2,如:5688-5700,端口2需≥端口1;也可输入单个端口,端口可选值1到65535| |RemoteIPAddress|String|指定防火墙的远程IP地址。对于入站数据包,远程地址是源 IP 地址。对于出站数据包,远程地址是目标 IP 地址。您可以指定主机地址或子网地址,或指定通配符,例如 0.0.0.0/0 表示所有 IPv4 地址,::/0 表示所有 IPv6 地址,或 ANY 表示所有 IPv4 和 IPv6 地址| #### 4.2.3 MACAddress算法 **一、快速对接,将数字转为MAC地址** 由于算法比较复杂,如果觉得使用起来困难,本站也有提供快速转换接口: `http://www.fastosapi.com/api/plc/quick.IntToMacAddress?id=数值` 调用例子 `http://www.fastosapi.com/api/plc/quick.IntToMacAddress?id=1` **二、算法参考,SQL版** [点击跳转到MACAddress生成算法](/doc/api/sourcecode.html#2%E3%80%81MACAddress%E7%AE%97%E6%B3%95%EF%BC%8CSQL%E7%89%88 "点击跳转到MACAddress生成算法") #### 4.2.4 内网IP生成算法 **一、快速对接,将数字转为IP地址** 由于算法比较复杂,如果觉得使用起来困难,本站也有提供快速转换接口: `http://www.fastosapi.com/api/plc/quick.GetIntranetIP?id=数值` 调用例子 `http://www.fastosapi.com/api/plc/quick.GetIntranetIP?id=1` **二、算法参考,SQL版** [点击跳转到IP地址生成算法](/doc/api/sourcecode.html#1%E3%80%81%E5%86%85%E7%BD%91IP%E7%94%9F%E6%88%90%E7%AE%97%E6%B3%95%EF%BC%8CSQL%E7%89%88 "点击跳转到IP地址生成算法") #### 4.2.5 IP对象 IP对象用于云主机使用网络对象,以下为对象字段 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |IP|String|IP地址,正确格式为:255.255.255.255,IPV6为:xxx:xxx:xxx:xxx:xxx:xxx:xxx:xxx| |Mask|String|子网掩码,IPV4为:255.000.000.000,IPV6为:64| |Gateway|String|网关地址| Json示例 ```json {"IP":"156.227.31.20","Mask":"255.255.255.128"} ``` IP集合示例 ```json [{"IP":"156.227.31.20","Mask":"255.255.255.128"},{"IP":"156.227.31.21","Mask":"255.255.255.128"}] ``` ### 4.3 接口示例 ` http://yourhost:2390/api/service/CVM.CreateCVM?ExtranetBandWidth=10&ExtranetMACAddress=02%3ABA%3A7D%3AEF%3A30%3A01&VMName=cvm_1&SecurityGroupRules=%5B%7B%22Action%22%3A%22Allow%22%2C%22Direction%22%3A%22Inbound%22%2C%22Weight%22%3A4%2C%22Protocol%22%3A%22TCP%22%2C%22PortRange%22%3A%2280-82%22%7D%2C%7B%22Action%22%3A%22Allow%22%2C%22Direction%22%3A%22Inbound%22%2C%22Weight%22%3A5%2C%22Protocol%22%3A%22TCP%22%2C%22PortRange%22%3A%223389%22%7D%5D&IntranetMACAddress=02%3ABA%3A7D%3AEF%3A30%3A02&ObjPassword=Test123&VMSavePath=D%3A%5Ccvm%5Cbase&Disks=%5B%7B%22Id%22%3A%221%22%2C%22IsSystem%22%3A1%2C%22Size%22%3A40%7D%2C%7B%22Id%22%3A%222%22%2C%22IsSystem%22%3A0%2C%22Size%22%3A100%7D%2C%7B%22Id%22%3A%223%22%2C%22IsSystem%22%3A0%2C%22Size%22%3A100%7D%5D&Processor=4&ProcessorMaximum=100&ProcessorReserve=100&ProcessorRelativeWeight=100&IntranetBandWidth=100&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&ExtranetIP=%5B%7B%22IP%22%3A%22156.227.31.20%22%2C%22Mask%22%3A%22255.255.255.128%22%7D%2C%7B%22IP%22%3A%22156.227.31.21%22%2C%22Mask%22%3A%22255.255.255.128%22%7D%5D&RemotePort=2166&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&MemoryMaximumBytes=1&MemoryStartupBytes=1&MemoryBuffer=1000&MemoryPriority=10&_RPW_QueueId=20220829193617860&ImageFile=E%3A%5Csysimg%5Cwin2008r2chee64.vhdx&ExtranetGateway=156.227.31.1&IntranetIPAddress=10.0.0.2` ### 4.4 错误代码列表 |代码|描述| | ------------ | ------------ | |600201|请输入云主机名称| |600202|请输入云主机存放目录| |600203|云主机存放目录不存在| |600205|需为云主机添加磁盘| |600206|需为云主机设置系统镜像文件| |600207|系统镜像文件不存在| |600208|请设置云主机内存,单位:MB| |600209|请设置云主机CPU核心数| |600211|请设置云主机外网带宽,单位:Mbps| |600212|请设置云主机内网带宽,单位:Mbps| |600213|外网MAC地址格式错误,正确格式:ff:ff:ff:ff:ff:ff| |600214|至少需要设置一个外网| |600215|外网网关格式不正确| |600216|外网IP地址格式不正确,正确格式:255.255.255.255| |600217|内网MAC地址格式错误,正确格式:ff:ff:ff:ff:ff:ff| |600218|内网IP地址格式不正确,正确格式:255.255.255.255| |600219|实例初始密码格式有误,正确格式:英文大小写字母及数字组合,4至15位,不能带特殊字符| |600221|安全组规则出现重复,key=(Direction+Weight)不能出现重复| |600223|安全组规则集合中,有Action值不规范,Action值只能是Allow或Deny| |600224|安全组规则集合中,有Direction值不规范,Direction值只能是Inbound或Outbound| |600225|安全组规则集合中,有Weight值不规范,Weight可选值:4到100| |600226|安全组规则集合中,有Protocol值不规范,Protocol值只能是TCP、UDP、ICMP其中一个| |600227|安全组规则集合中,有PortRange值不规范,PortRange值格式:端口1-端口2,如:5688-5700,端口2需≥端口1;也可输入单个端口,端口可选值1到65535| |600228|内网虚拟交换机不存在| |600229|外网虚拟交换机不存在| |600230|云主机已经存在,请更换其它名称创建| |600231|云主机存放已经存在,请检查是否目下的主机名称文件夹是否为历史遗留数据| |600232|实例到期日期不能≤创建日期| |600233|外网子网掩码格式不正确| # 5、CVM.StopCVM ### 5.1接口描述 关闭云主机,仅实例处于关机状态下有效 ### 5.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| |CVMCloseType|int|-|必填|关闭方式,1为正常关机,如有任务在执行可能无法正常关闭;2延时关机,5分钟内等待任务结束,结束后正常关闭;3强制关机,无论是否有正在运行的任务直接关闭,相当于拔掉电源| ### 5.3接口示例 ` http://yourhost:2390/api/service/CVM.StopCVM?_RPW_Sign=F3F73C3087B03053570E6F0B9964D898&_RPW_IsAsyn=0&VMName=cvm_1&CVMCloseType=2&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220902131249681` ### 5.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 5.5错误代码 |代码|描述| | ------------ | ------------ | |602604|实例当前状态无法执行本操作,需在开机状态下执行| |602605|关机方式错误| # 6、CVM.StartCVM ### 6.1接口描述 启动云主机,仅实例处于关机状态下有效 ### 6.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| ### 6.3接口示例 ` http://yourhost:2390/api/service/CVM.StartCVM?_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220902144038032&_RPW_Sign=0268F4D06926D480B1F03B79C47E5DAF&VMName=cvm_1` ### 6.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 6.5错误代码 |代码|描述| | ------------ | ------------ | |602504|实例当前状态无法执行本操作,需在关机状态下执行| # 7、CVM.ReStartCVM ### 7.1接口描述 重启云主机,仅实例在已启动状态下有效 ### 7.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| ### 7.3接口示例 ` http://yourhost:2390/api/service/CVM.ReStartCVM?_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220902144642822&_RPW_Sign=85FE60727C7E91EBF30D3BA0B9312737&VMName=cvm_1` ### 7.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 7.5错误代码 |代码|描述| | ------------ | ------------ | |602704|实例当前状态无法执行本操作,需在开机状态下执行| # 8、CVM.SetSecurityGroupRules ### 8.1接口描述 保存云主机安全组 ### 8.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| |SecurityGroupRules|JsonArray|-|必填|网络安全组规则集合,若参数值为“[]”,则表示表示清空现有规则;若该参数有传值,则系统默认禁止所有TCP/UPD的端口进出及禁止ICMP(用于PING命令),那么需要注意远程桌面、WEB等常见端口的增加。[点击查看SecurityGroupRule对象](#4.2.2 SecurityGroupRule对象 "点击查看SecurityGroupRule对象")。| ### 8.3接口示例 ` http://yourhost:2390/api/service/CVM.SetSecurityGroupRules?_RPW_Sign=2EA8AF8A2539DCE555DCB3FA753967EF&_RPW_IsAsyn=0&VMName=cvm_1&SecurityGroupRules=%5b%7b%22Action%22%3a%22Allow%22%2c%22Direction%22%3a%22Inbound%22%2c%22Weight%22%3a4%2c%22Protocol%22%3a%22TCP%22%2c%22PortRange%22%3a%2280-82%22%7d%2c%7b%22Action%22%3a%22Allow%22%2c%22Direction%22%3a%22Inbound%22%2c%22Weight%22%3a5%2c%22Protocol%22%3a%22TCP%22%2c%22PortRange%22%3a%223389%22%7d%5d&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220904143512012` ### 8.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 8.5错误代码 |代码|描述| | ------------ | ------------ | |600301|实例不存在| |600302|实例名称格式错误,由字母+数字+下划线组成,4-12位| |600303|读取实例配置文件失败| # 9、CVM.GetVMResStats ### 9.1接口描述 获取云主机当前资源用量 ### 9.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| ### 9.3接口示例 ` http://yourhost:2390/api/service/CVM.GetVMResStats?_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220904144949595&_RPW_Sign=1B9BC333534DC40C9232E19F8CB1383E` ### 9.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":{"NetStats":{"Extranet":{"BytesPersec":0,"BytesSentPersec":0,"BytesReceivedPersec":0,"MonthBytesSend":187071,"MonthBytesReceive":282980,"MonthDate":202212},"Intranet":{"BytesPersec":0,"BytesSentPersec":0,"BytesReceivedPersec":0,"MonthBytesSend":187071,"MonthBytesReceive":276307,"MonthDate":202212}},"CPUUSE":1,"State":2,"MemoryAssigned":8589934592}} ``` ### 9.5返回data数据字段说明 |字段名|数据类型|字段描述| | ------------ | ------------ | ------------ | |NetStats|JsonObject|网络状态对象,包含Extranet和Intranet字段| |NetStats.Extranet|JsonObject|外网网络统计对象| |NetStats.Extranet.BytesSentPersec|long|当前网络发送数量/秒,单位:字节(btye)| |NetStats.Extranet.BytesReceivedPersec|long|当前网络接收数量/秒,单位:字节(btye)| |NetStats.Extranet.BytesPersec|long|当前网络收发数量/秒,单位:字节(btye)| |NetStats.Extranet.MonthBytesSend|long|查询的月份总发送数量,单位:字节(byte)| |NetStats.Extranet.MonthBytesReceive|long|查询的月份总发送数量,单位:字节(byte)| |NetStats.Extranet.MonthDate|Int|流量查询月份,字段类型为Int,格式:yyyyMM| |NetStats.Intranet|JsonObject|内网网络统计对象| |CPUUSE|Decimal|CPU占用率| |MemoryAssigned|long|实例已分配内存,单位:字节(byte)| |IOPS.ReadBytes|long|读取字节数,单位:字节(byte)| |IOPS.WriteBytes|long|写入字节数,单位:字节(byte)| |IOPS.DiskUsedBytes|long|磁盘已使用容量,单位:字节(byte)| |IOPS.AcquisitionTime|long|采集时间| |State|Int|实例当前状态| # 10、CVM.GetVNCData ### 10.1接口描述 获取云主机VNC远程管理地址 ### 10.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称| |VNC_IP|String|-|必填|VNC的服务IP或域名,一般为宿主机的IP| |WebHost|String|-|非必填|VNC的WEB访问地址,如不填,则使用系统自带的WEB服务地址,无须输入“http://”,如:yourdomain.com/vnc| |DTWidth|int|800|非必填|远程桌面画面宽度| |DTHeight|int|600|非必填|远程桌面画面高度| |VMServerRemotePort|int|2179|非必填|Hyper-V虚拟机远程桌面服务端口,系统默认2179| ### 10.3接口示例 ` http://yourhost:2390/api/service/CVM.GetVNCData? VNC_IP=156.227.31.38&_RPW_Sign=8830C91CA688D42475BD0F9A3CE3D00F&_RPW_IsAsyn=0&VMName=cvm_1&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220914100359318` ### 10.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"http://156.227.31.38:32727?sid=5%2c124%2c35%2c111%2c112%2c110%2c98%2c111%2c106%2c35%2c59%2c35%2c50%2c35%2c45%2c35%2c111%2c112%2c111%2c109%2c98%2c35%2c59%2c35%2c49%2c35%2c45%2c35%2c103%2c111%2c117%2c109%2c110%2c35%2c59%2c35%2c49%2c35%2c45%2c35%2c118%2c116%2c102%2c115%2c35%2c59%2c35%2c119%2c110%2c104%2c118%2c102%2c116%2c117%2c96%2c100%2c119%2c110%2c96%2c50%2c35%2c45%2c35%2c113%2c102%2c115%2c103%2c35%2c59%2c35%2c49%2c35%2c45%2c35%2c113%2c98%2c116%2c116%2c35%2c59%2c35%2c69%2c69%2c49%2c68%2c56%2c53%2c71%2c51%2c66%2c55%2c70%2c68%2c69%2c69%2c50%2c54%2c58%2c70%2c68%2c68%2c69%2c53%2c57%2c49%2c54%2c51%2c67%2c66%2c66%2c58%2c54%2c69%2c35%2c45%2c35%2c111%2c112%2c120%2c98%2c109%2c109%2c113%2c35%2c59%2c35%2c50%2c35%2c45%2c35%2c101%2c117%2c116%2c106%2c123%2c102%2c35%2c59%2c35%2c57%2c49%2c49%2c121%2c55%2c49%2c49%2c35%2c45%2c35%2c111%2c112%2c117%2c105%2c102%2c110%2c102%2c35%2c59%2c35%2c50%2c35%2c45%2c35%2c105%2c112%2c116%2c117%2c35%2c59%2c35%2c50%2c51%2c56%2c47%2c49%2c47%2c49%2c47%2c50%2c35%2c45%2c35%2c113%2c112%2c115%2c117%2c35%2c59%2c51%2c50%2c56%2c58%2c45%2c35%2c113%2c100%2c99%2c35%2c59%2c35%2c57%2c56%2c55%2c71%2c66%2c68%2c53%2c54%2c46%2c51%2c53%2c68%2c57%2c46%2c53%2c57%2c70%2c71%2c46%2c66%2c53%2c50%2c51%2c46%2c58%2c69%2c55%2c66%2c53%2c70%2c52%2c53%2c58%2c71%2c70%2c67%2c35%2c45%2c35%2c111%2c112%2c120%2c101%2c115%2c98%2c104%2c35%2c59%2c35%2c50%2c35%2c45%2c35%2c111%2c112%2c117%2c109%2c116%2c35%2c59%2c35%2c49%2c35%2c126"} ``` ### 10.5 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |600801|云主机名称格式错误,由字母+数字+下划线组成,4-12位| |600802|读取实例配置文件失败,请检查实例名称输入是否正确| |600803|请输入VNC的服务IP或域名,一般为宿主机的IP| # 11、CVM.Reinstall ### 11.1 接口描述 重装实例操作系统,由于本接口在服务端操作时间比较长,因此**建议采用异步请求**。 ### 11.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ImageFile|String|-|必填|操作系统镜像文件位置,云主机创建后会复制该镜像文件做为云主机的系统盘| |ObjPassword|String|-|必填|实例密码,实例系统重装成功后操作系统的管理员默认密码| |RemotePort|Int|win3389、linux22|非必填|远程管理端口,Windows为远程桌面端口,Linux为SSH的登陆端口,可用范围:1到65535| |FormatDataDisk|Int|0|非必填|是否格式化数据盘,1为是,0为否,不填为默认值0,请若为1将格式化实例下的所有磁盘数据,请审慎操作| ### 11.3 接口示例 ` http://yourhost:2390/api/service/CVM.Reinstall?VMName=cvm_1&ObjPassword=Test123&VMSavePath=D%3a%5ccvm%5cbase&Processor=4&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&RemotePort=2166&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860&ImageFile=E%3a%5csysimg%5cwin2008r2chee64.vhdx` ### 11.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |601103|实例名称格式错误,由字母+数字+下划线组成,4-12位| |601104|实例当前状态无法执行本操作| |601105|找不到实例系统盘| |601106|系统镜像文件不存在| |601107|删除旧系统磁盘文件时失败| |601114|实例初始密码格式有误,正确格式:英文大小写字母及数字组合,4至15位,不能带特殊字符| # 12、CVM.SetExpDate ### 12.1 接口描述 设置实例到期日期 ### 12.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ExpDate|String|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| ### 12.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetExpDate?VMName=cvm_1&ExpDate=20251108&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 13、CVM.SetPWD ### 13.1 接口描述 修改实例操作系统管理员密码 ### 13.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ObjPassword|String|-|必填|英文大小写字母及数字组合,4至15位,不能带特殊字符| ### 13.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetPWD?VMName=cvm_1&ObjPassword=newPWD888&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 13.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |601904|操作系统密码格式有误,正确格式:英文大小写字母及数字组合,4至15位,不能带特殊字符| # 14、CVM.SetRemotePort ### 14.1 接口描述 修改实例远程管理端口,Windows为远程桌面端口,Linux为SSH的登陆端口 ### 14.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |RemotePort|Int|-|必填|远程管理端口,Windows为远程桌面端口,Linux为SSH的登陆端口,可用范围:1到65535| ### 14.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetRemotePort?VMName=cvm_1&RemotePort=3389&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 14.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |602001|实例不存在| |602002|实例名称格式错误,由字母+数字+下划线组成,4-12位| |602003|读取实例配置文件失败| # 15、CVM.SetProcessor ### 15.1 接口描述 配置实例CPU,需实例关机状态下才可操作 ### 15.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Processor|Int|-|必填|CPU核心数量| |ProcessorMaximum|Int|-|必填|实例CPU可用资源的最大百分比,允许的值范围从 0 到 100| |ProcessorReserve|Int|-|必填|指定要为实例保留的CPU资源百分比,允许的值范围从 0 到 100| |ProcessorRelativeWeight|Int|-|必填|相对权重,指定将物理计算机的处理能力分配给该实例相对于其他实例的优先级,允许的值范围从 1 到 10000| |ProcessorVirtualizationEnabled|Int|0|必填|CPU是否支持虚拟化,0为不支持,1为支持| ### 15.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetProcessor?VMName=cvm_1&Processor=4&ProcessorMaximum=100&ProcessorReserve=100&ProcessorRelativeWeight=100&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 15.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |602404|实例当前状态无法执行本操作| |602405|CPU核心数必须大于0| # 16、CVM.SetMemory ### 16.1 接口描述 修改实例内存,单位:GB,需实例关机状态下才可操作 ### 16.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |MemoryStartupBytes|Decimal|-|必填|云主机内存,单位:GB| |MemoryMaximumBytes|Decimal|-|必填|云主机最大内存,单位:GB,当启动内存与最大内存相等时,表示实例采用固定内存,反之表示动态内存| |MemoryBuffer|Int|-|必填|实例内存保留为缓冲区的内存百分比,允许的值范围从 5 到 2000,**仅动态内存有效**| |MemoryPriority|Int|-|必填|设置实例相对于其它实例的内存可用性优先级,允许的值范围从 0 到 100| ### 16.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetMemory?VMName=cvm_1&MemoryStartupBytes=8&MemoryMaximumBytes=8&MemoryBuffer=1000&MemoryPriority=10&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 16.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |602304|实例当前状态无法执行本操作| |602305|内存必须大于0,单位:MB| # 17、CVM.SetIP ### 17.1 接口描述 设置实例IP ### 17.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ExtranetIP|JsonArray|-|必填|外网IP对象集合,[点击此处查看IP对象](#4.2.5 IP对象 "点击此处查看IP对象")| |ExtranetIPV6|JsonArray|-|必填|外网IPV6对象集合,[点击此处查看IP对象](#4.2.5 IP对象 "点击此处查看IP对象")| |ExtranetDNS|String|-|必填|外网DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"8.8.8.8,8.8.4.4"| |ExtranetDNSV6|JsonArray|-|必填|外网IPV6 DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"2001:4860:4860::8888,2001:4860:4860::8844"| |IntranetIPAddress|String|-|必填|内网IP地址,10.0.0.1以上的不重复IP,应注意10.0.0.1已被网关占用,建议根据系统数据库存储Id值生成内网IP,防止造成重复,[点击此处查看内网IP生成算法](#4.2.4 内网IP生成算法 "点击此处查看内网IP生成算法")| |IntranetDNS|String|-|必填|内网DNS服务器地址,多个以英文逗号隔开,最多2个,放空则使用默认:"8.8.8.8,8.8.4.4"| ### 17.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetIP?VMName=cvm_1&IntranetBandWidth=100&ExtranetIP=%5B%7B%22IP%22%3A%22156.227.31.20%22%2C%22Mask%22%3A%22255.255.255.128%22%7D%2C%7B%22IP%22%3A%22156.227.31.21%22%2C%22Mask%22%3A%22255.255.255.128%22%7D%5D&ExtranetGateway=156.227.31.1&IntranetIPAddress=10.0.0.2&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 17.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |602801|至少需要设置一个外网IP| |602804|外网IP地址格式不正确,正确格式:255.255.255.255| |602805|外网网关格式不正确| |602806|外网子网掩码格式不正确| |602807|内网IP地址格式不正确,正确格式:255.255.255.255| # 18、CVM.ResizeVHD ### 18.1 接口描述 磁盘扩容 ### 18.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Size|Int|-|必填|磁盘新容量,单位:GB,需大于磁盘原始大小| |VHDId|String|-|必填|磁盘ID,限英文字母+数字+下划线,建议使用您的系统数据库记录值Id| ### 18.3 接口示例 ` http://yourhost:2390/api/service/CVM.ResizeVHD?VMName=cvm_1&Size=60&VHDId=2&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 18.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |602901|新容量不能≤原始容量| |602902|找不到系统盘| # 19、CVM.AddSnapshot ### 19.1 接口描述 创建云主机快照 ### 19.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |SnapshotName|String|-|必填|正确格式为4~20位字母、数字,建议使用:yyyyMMddHHmmss| ### 19.3 接口示例 ` http://yourhost:2390/api/service/CVM.AddSnapshot?VMName=cvm_1&SnapshotName=20221103100101&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 19.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |603001|创建快照时出错| |603002|实例创建快照时暂停实例出错| |603003|实例创建快照后恢复实例出错| |603004|当时实例状态不允许创建快照| |603005|快照名称格式有误,正确格式为4~20位字母、数字,建议使用:yyyyMMddHHmmss| |603006|快照已经存在,请更换其它名称| # 20、CVM.RemoveSnapshot ### 20.1 接口描述 删除云主机快照 ### 20.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |SnapshotName|String|-|必填|正确格式为4~20位字母、数字| ### 20.3 接口示例 ` http://yourhost:2390/api/service/CVM.RemoveSnapshot?VMName=cvm_1&SnapshotName=20221103100101&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 21、CVM.RestoreSnapshot ### 21.1 接口描述 还原云主机快照 ### 21.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |SnapshotName|String|-|必填|正确格式为4~20位字母、数字| ### 21.3 接口示例 ` http://yourhost:2390/api/service/CVM.RestoreSnapshot?VMName=cvm_1&SnapshotName=20221103100101&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 21.4 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |603101|还原快照时出错| |603102|实例还原快照时暂停实例出错| |603103|实例还原快照后启动实例出错| |603104|当时实例状态不允许还原快照| |603105|快照不存在,请检查快照名称是否正确| # 22、CVM.GetSnapshot ### 22.1 接口描述 还原云主机快照 ### 22.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| ### 22.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetSnapshot?VMName=cvm_1&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 23、CVM.RemoveCVM ### 22.1 接口描述 删除云主机 ### 22.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| ### 23.3 错误代码列表 |接口名称|接口描述| | ------------ | ------------ | |603201|实例当前状态无法执行本操作,需在关机状态下执行| ### 23.4 接口示例 ` http://yourhost:2390/api/service/CVM.RemoveCVM?VMName=cvm_1&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 24、CVM.SetIOPS ### 24.1 接口描述 设置IOPS ### 24.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |MinimumIOPS|long|-|非必填|最小IOPS,1M=128IOPS| |MaximumIOPS|long|-|非必填|最大IOPS,1M=128IOPS,如MinimumIOPS与MaximumIOPS其中一个大于0,则表示启用IOPS限制;如MinimumIOPS与MaximumIOPS均等于0,则表示关闭IOPS限制,使用系统默认值| ### 24.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetIOPS?VMName=cvm_1&MinimumIOPS=1024&MaximumIOPS=2048&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 25、CVM.AddDataVHD ### 25.1 接口描述 添加数据磁盘 ### 25.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Disks|JsonArray|-|必填|云主机欲添加的数据磁盘集合,其中磁盘类型必须为数据盘,类型为Disk对象集合,[点击查看Disk对象](#4.2.1 Disk对象 "点击查看Disk对象")| ### 25.4 接口示例 ` http://yourhost:2390/api/service/CVM.AddDataVHD?VMName=cvm_1&Disks=%5B%7B%22Id%22%3A%224%22%2C%22IsSystem%22%3A0%2C%22Size%22%3A40%7D%2C%7B%22Id%22%3A%225%22%2C%22IsSystem%22%3A0%2C%22Size%22%3A100%7D%2C%7B%22Id%22%3A%226%22%2C%22IsSystem%22%3A0%2C%22Size%22%3A100%7D%5D&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 26、CVM.SetBandWidth ### 26.1 接口描述 设置带宽 ### 26.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ExtranetBandWidth|Decimal|-|必填|外网带宽,单位:Mbps(1Mbps=1000Kbit/s)| |IntranetBandWidth|Decimal|-|必填|内网带宽,单位:Mbps(1Mbps=1000Kbit/s)| ### 26.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetBandWidth?VMName=cvm_1&ExtranetBandWidth=10&IntranetBandWidth=100&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 27、CVM.SetResLimit ### 27.1 接口描述 快速设置资源限制,应注意所有参数都需填写 ### 27.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Processor|Int|-|必填|实例CPU核心数量| |ProcessorMaximum|Int|-|必填|实例CPU可用资源的最大百分比,允许的值范围从 0 到 100| |ProcessorReserve|Int|-|必填|指定要为实例保留的CPU资源百分比,允许的值范围从 0 到 100| |ProcessorRelativeWeight|Int|-|必填|相对权重,指定将物理计算机的处理能力分配给该实例相对于其他实例的优先级,允许的值范围从 1 到 10000| |ProcessorVirtualizationEnabled|Int|0|必填|CPU是否支持虚拟化,0不支持,1支持| |MemoryStartupBytes|Decimal|-|必填|云主机启动内存,单位:GB| |MemoryMaximumBytes|Decimal|-|必填|云主机最大内存,单位:GB,当启动内存与最大内存相等时,表示实例采用固定内存,反之表示动态内存| |MemoryBuffer|Int|-|必填|实例内存保留为缓冲区的内存百分比,允许的值范围从 5 到 2000| |MemoryPriority|Int|-|必填|设置实例相对于其它实例的内存可用性优先级,允许的值范围从 0 到 100| |ExtranetBandWidth|Decimal|-|必填|外网带宽,单位:Mbps(1Mbps=1000Kbit/s)| |IntranetBandWidth|Decimal|-|必填|内网带宽,单位:Mbps(1Mbps=1000Kbit/s)| |MinimumIOPS|long|-|必填|最小IOPS,1M=128IOPS |MaximumIOPS|long|-|必填|最大IOPS,1M=128IOPS,如MinimumIOPS与MaximumIOPS其中一个大于0,则表示启用IOPS限制;如MinimumIOPS与MaximumIOPS均等于0,则表示关闭IOPS限制,使用系统默认值| |Notes|String|-|非必填|实例注释内容| ### 27.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetResLimit?VMName=cvm_1&ProcessorMaximum=0&ProcessorReserve=0&ProcessorRelativeWeight=1&ProcessorVirtualizationEnabled=1&MemoryStartupBytes=1.5&MemoryMaximumBytes=2&MemoryBuffer=100&MemoryPriority=100&MinimumIOPS=1000&MaximumIOPS=1000&ExtranetBandWidth=10&IntranetBandWidth=100&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 28、CVM.GetObjectSetting ### 28.1 接口描述 获取实例当前配置数据 ### 28.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| ### 28.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetObjectSetting?VMName=cvm_1&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 29、CVM.GetVMNetTrafficData ### 29.1 接口描述 获取网络流量统计数据,可根据月份、日期进行查询 ### 29.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Date|Int|-|必填|查询日期,数据类型为Int,格式为yyyyMM(根据月份查询)或yyyyMMdd(根据日期查询),FastOSAPI不提供更高级查询方式,建议每日任务计划查询将数据存储到数据库| ### 29.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetVMNetTrafficData?VMName=cvm_1&Date=202212&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 30、CVM.GetAllVM ### 30.1 接口描述 获取宿主机下所有虚拟机 ### 30.2 接口参数 无 ### 30.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetAllVM?_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 31、CVM.ReBuildVHDAccess ### 31.1 接口描述 当虚拟磁盘权限丢失时(如:错误:“一般性拒绝访问错误"。帐户没有足够的权限打开…),从而无法启动,可使用该接口进行重建权限 一般手动操作虚拟磁盘、迁移、覆盖均有可能丢失权限 ### 31.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| ### 31.3 接口示例 ` http://yourhost:2390/api/service/CVM.ReBuildVHDAccess?VMName=cvm_1&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 32、CVM.GetVMMeter ### 32.1 接口描述 获取资源计量器,通过本接口可根据时间段查询资源使用计量信息,包括:网络流量、磁盘I/O次数、内存分配、CPU占比、主机状态 ### 32.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |DateType|Int|-|必填|查询日期类型,可选值:1(秒)、2(分)、3(时)、4(日)、5(月)、6(年)| |MinDateTime|Int|-|非必填|查询最小日期,数据类型为Int,格式为:yyyyMMddHHmmss,默认为当前时间| |MaxDateTime|Int|-|非必填|查询最大日期,数据类型为Int,格式为:yyyyMMddHHmmss,默认为当前时间| |Sort|String|-|必填|根据记录时间排序方式,可选值:desc(降序)、asc(升序)| ### 32.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetVMMeter?VMName=cvm_1&DateType=1&MinDateTime=20221227001001&Sort=desc&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 32.4 返回data数据字段说明 |字段名|数据类型|字段描述| | ------------ | ------------ | ------------ | |net|JsonArray|网络计量数据集合| |net.ExBytes|long|外网网络收发字节数,单位:字节(btye)| |net.ExBytesSent|long|外网网络发送字节数,单位:字节(btye)| |net.ExBytesReceived|long|外网网络接收字节数,单位:字节(btye)| |net.InBytes|long|内网网络收发字节数,单位:字节(btye)| |net.InBytesSent|long|内网网络发送字节数,单位:字节(btye)| |net.InBytesReceived|long|内网网络接收字节数,单位:字节(btye)| |net.GetTime|long|网络更新时间,格式为:yyyyMMddHHMMsss,不同DateType,展示不同长度的时间格式| |io|JsonArray|磁盘I/O次数计量数据集合| |io.ReadBytes|long|读取字节数,单位:字节(byte)| |io.WriteBytes|long|写入字节数,单位:字节(byte)| |io.DiskUsedBytes|long|磁盘已使用容量,单位:字节(byte)| |io.GetTime|long|IO更新时间,格式为:yyyyMMddHHMMsss,不同DateType,展示不同长度的时间格式| |state|JsonArray|磁盘I/O次数计量数据集合| |state.CPUUSE|Decimal|CPU占用率,单位:百分比。最后以秒采集时得到的记录值。| |state.MemoryAssigned|long|实例已分配内存,单位:字节(byte)。最后以秒采集时得到的记录值。| |state.State|Int|实例状态。最后以秒采集时得到的记录值。| |state.GetTime|long|状态更新时间,格式为:yyyyMMddHHMMsss,不同DateType,展示不同长度的时间格式| # 33、CVM.Export ### 33.1 接口描述 导出实例,根据磁盘数据大小觉得导出时间,**建议使用异步操作** ### 33.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|非必填|云主机名称,限英文字母+数字+下划线。允许放空,放空则表示导出所有实例。| |Path|String|-|必填|导出存放目录,如:d:\vmexport,那么导出数据将存放在d:\vmexport\vmname| ### 33.3 接口示例 ` http://yourhost:2390/api/service/CVM.Export?VMName=cvm_1&Path=d%3A%5Cvmexport&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 34、CVM.Import ### 34.1 接口描述 导入实例,导入实例时,Hyper-V中不能存在该实例。根据磁盘数据大小决定导入时间,**建议使用异步操作** ### 34.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Path|String|-|必填|导入的实例来源目录,即在此之前导出时的存放的目录,如:d:\vmexport| ### 34.3 接口示例 ` http://yourhost:2390/api/service/CVM.Import?VMName=cvm_1&Path=d%3A%5Cvmexport&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` # 35、CVM.GetHostMeter ### 35.1 接口描述 获取宿主机资源计量器,通过本接口可根据时间段查询资源使用计量信息,包括:网络流量、磁盘I/O次数、已使用内存、CPU占比 ### 35.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |DateType|Int|-|必填|查询日期类型,可选值:1(秒)、2(分)、3(时)、4(日)、5(月)、6(年)| |MinDateTime|Int|-|非必填|查询最小日期,数据类型为Int,格式为:yyyyMMddHHmmss,默认为当前时间| |MaxDateTime|Int|-|非必填|查询最大日期,数据类型为Int,格式为:yyyyMMddHHmmss,默认为当前时间| |Sort|String|-|必填|根据记录时间排序方式,可选值:desc(降序)、asc(升序)| ### 35.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetHostMeter?DateType=1&MinDateTime=20221227001001&Sort=desc&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 35.4 返回data数据字段说明 |字段名|数据类型|字段描述| | ------------ | ------------ | ------------ | |base|JsonArray|基础资源计量数据集合,包含:CPU使用率、内存已使用量、磁盘I/O次数| |base.DiskReadBytes|Decimal|磁盘读取字节数,DiskReadBytes+DiskWriteBytes即总读写字节数,单位:字节(byte)| |base.DiskWriteBytes|Decimal|磁盘写入字节数,DiskReadBytes+DiskWriteBytes即总读写字节数,单位:字节(byte)| |base.CPUUSE|Decimal|CPU占用率,单位:百分比。最后以秒采集时得到的记录值。| |base.PhysicalMemoryUSE|long|物理内存已使用量,单位:字节(byte)。最后以秒采集时得到的记录值。| |base.ProcessorCount|int|CPU核心数量| |base.PhysicalMemory|long|物理内存大小,单位:字节(byte)| |base.ToalDiskSize|String|各磁盘总容量,格式:分区1_容量,分区2_容量,容量单位:字节(byte)| |base.ToalDiskUsedSize|String|各磁盘已使用容量,格式:分区1_容量,分区2_容量,容量单位:字节(byte)| |base.GetTime|long|数据采集时间,格式为:yyyyMMddHHMMss,不同DateType,展示不同长度的时间格式| |net|JsonArray|网络资源计量数据集合| |net.NetworkAdapterName(网卡名称).Bytes|long|网络收发字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).SentBytes|long|网络发送字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).ReceivedBytes|long|网络接收字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).GetTime|long|网络采集时间,格式为:yyyyMMddHHMMss,不同DateType,展示不同长度的时间格式| # 36、CVM.GetHostResStats ### 36.1 接口描述 获取宿主机当前资源计量 ### 36.2 接口参数 无 ### 36.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetHostResStats?Sort=desc&_RPW_Sign=2EC7F11EADA71DCEC6C4C3B112FEF2A8&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220829193617860` ### 36.4 返回data数据字段说明 |字段名|数据类型|字段描述| | ------------ | ------------ | ------------ | |base|JsonObject|基础资源计量数据,包含:CPU使用率、内存已使用量、磁盘I/O次数| |base.DiskReadBytes|Decimal|磁盘读取字节数,DiskReadBytes+DiskWriteBytes即总读写字节数,单位:字节(byte)| |base.DiskWriteBytes|Decimal|磁盘写入字节数,DiskReadBytes+DiskWriteBytes即总读写字节数,单位:字节(byte)| |base.CPUUSE|Decimal|CPU占用率,单位:百分比。最后以秒采集时得到的记录值。| |base.PhysicalMemoryUSE|long|物理内存已使用量,单位:字节(byte)。最后以秒采集时得到的记录值。| |base.ProcessorCount|int|CPU核心数量| |base.PhysicalMemory|long|物理内存大小,单位:字节(byte)| |base.ToalDiskSize|String|各磁盘总容量,格式:分区1_容量,分区2_容量,容量单位:字节(byte)| |base.ToalDiskUsedSize|String|各磁盘已使用容量,格式:分区1_容量,分区2_容量,容量单位:字节(byte)| |base.GetTime|long|数据采集时间,格式为:yyyyMMddHHMMss,不同DateType,展示不同长度的时间格式| |net|JsonObject|网络资源计量数据| |net.NetworkAdapterName(网卡名称).Bytes|long|网络收发字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).SentBytes|long|网络发送字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).ReceivedBytes|long|网络接收字节数,单位:字节(btye)| |net.NetworkAdapterName(网卡名称).GetTime|long|网络采集时间,格式为:yyyyMMddHHMMss,不同DateType,展示不同长度的时间格式| # 37、CVM.ColdMove ### 37.1 接口描述 1、冷迁移接口,调用接口前请注意:目标主机已配置好环境,虚拟交换机名称、VMSavePath(实例存放位置)、VHDDataSavePath(数据盘存放位置)、VHDSystemSavePath(系统盘存放位置)需与源主机一致且已存在 2、实例需在已关机的状态下才可执行迁移操作,迁移时应保证有足够内存,至少1GB剩余内存 3、迁移时间受实例占用磁盘大小以及网络传输速率影响,且比较久,**建议使用异步操作** 4、**请勿同时调用多个该接口,避免主机资源不足导致迁移失败,批量迁移应逐个迁移,切勿并发** 5、迁移成功后,业务系统应更新实例所属节点ID 6、迁移成功后,FastOSAPI不自动删除源主机实例,如需删除需调用源主机删除接口,**建议不着急删除,待数据核实无误后再执行删除** ### 37.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。与其它云主机不能重名,建议使用您的系统数据库记录值Id| |ExportPath|String|-|必填|实例迁移临时数据存放位置,该位置需有足够的磁盘空间,在迁移完成后系统自动释放,如d:\cvmexport |SourceHost|String|-|必填|源主机地址,一般为受控端访问IP,如源主机与目标主机处于同一内网,建议采用内网IP以加快数据传输速率,受控端应注意增加目标主机IP。| |TargetHost|String|-|必填|目标主机地址,如源主机与目标主机处于同一内网,建议采用内网IP以加快数据传输速率,受控端应注意增加源主机IP。| |TargetPort|Int|-|必填|目标主机FastOSAPI端口| |TargetBindID|String|-|必填|目标主机FastOSAPI的“服务端ID”,在系统设置中可查看| |TargetAPISecret|String|-|必填|目标主机FastOSAPI“API秘钥”| ### 37.3 接口示例 ` http://yourhost:2390/api/service/CVM.ColdMove?SourceHost=156.227.31.38&TargetPort=2390&_RPW_Sign=5A4C74C5DD89C95C955DF3B434DAD4D7&_RPW_IsAsyn=1&ExportPath=D%3a%5cvmbak&VMName=ecs_2617&TargetAPISecret=abcde123&TargetHost=186.1.2.1&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&TargetBindID=87A39ADC4957426B8178CC264C3F87C9&_RPW_QueueId=20230212202458403` # 38、CVM.SetNotes ### 38.1 接口描述 设置实例注释 ### 38.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。与其它云主机不能重名,建议使用您的系统数据库记录值Id| |Notes|String|-|非必填|实例注释内容,放空则表示清除注释| ### 38.3 接口示例 ` http://yourhost:2390/api/service/CVM.SetNotes?_RPW_Sign=5A4C74C5DD89C95C955DF3B434DAD4D7&_RPW_IsAsyn=1&VMName=ecs_2617&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20230212202458403` # 39、CVM.GetVMThumbnailImage ### 39.1 接口描述 获取实例当前屏幕缩略图,返回图片Base64字符串,文件类型为PNG html调用示例:```
``` ### 39.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。与其它云主机不能重名,建议使用您的系统数据库记录值Id| |Width|Int|500|非必填|缩略图宽度,单位:像素| |Height|Int|500|非必填|缩略图高度,单位:像素| ### 39.3 接口示例 ` http://yourhost:2390/api/service/CVM.GetVMThumbnailImage?_RPW_Sign=5A4C74C5DD89C95C955DF3B434DAD4D7&_RPW_IsAsyn=1&VMName=ecs_2617&Width=500&Height=500&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20230212202458403` # 40、CVM.SetVlanId ### 40.1 接口描述 设置虚拟Vlan标识 ### 40.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |ExtranetVlanId|Int|-|必填|外网VlanId,≤0表示不启用虚拟LAN标识| |IntranetVlanId|Decimal|-|必填|外网VlanId,≤0表示不启用虚拟LAN标识| # 41、CVM.AddClusterVirtualMachineRole ### 41.1 接口描述 添加到集群虚拟机角色,一般在虚拟机创建完成后加入,仅宿主机在集群环境中有效 ### 41.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| # 42、CVM.RemoveExport ### 42.1 接口描述 删除实例导出目录 ### 42.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| |Path|String|-|必填|导出时存放目录,如:d:\vmexport,那么删除的目录将会是d:\vmexport\vmname| # 43、CVM.MoveClusterVirtualMachineRole ### 43.1 接口描述 移除集群虚拟机角色,一般在虚拟机删除前移除,仅宿主机在集群环境中有效 ### 43.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| # 44、CVM.ReCreateNetworkAdapter ### 44.1 接口描述 重建实例网卡,重建时将删除实例现有网卡,并重新创建。 该接口重建后不会重新配置IP,应配合[CVM.SetIP](#17、CVM.SetIP "CVM.SetIP")接口设置实例IP。 ### 44.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMName|String|-|必填|云主机名称,限英文字母+数字+下划线。| # 45、CVM.BatchSetVHDIOPS ### 45.1 接口描述 设置IOPS ### 45.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |VMS|String|-|必填|云主机名称列表,多个名称以英文逗号隔开,放空则表示全部云主机。此接口为被控端内部异步接口,即请求后,系统验证输入参数无误就直接返回请求正确,被控后台自主处理请求,如单台云主机设置,不建议使用该接口,而应使用CVM.SetlOPS。| |MinimumIOPS|long|-|非必填|最小IOPS,1M=128IOPS| |MaximumIOPS|long|-|非必填|最大IOPS,1M=128IOPS,如MinimumIOPS与MaximumIOPS其中一个大于0,则表示启用IOPS限制;如MinimumIOPS与MaximumIOPS均等于0,则表示关闭IOPS限制,使用系统默认值|