FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 1、云虚拟主机服务描述 云虚拟主机能够在IIS上创建独立的虚拟主机,为虚拟主机绑定域名、绑定SSL证书、一键打包/解压、修改FTP密码等操作 # 2、运行平台 系统支持管理多平台创建的云主机,如:IIS、Apache等Web服务器软件 当前支持软件对应表格如下: |平台名称|简称| | ------------ | ------------ | |Microsoft Internet Information Server|IIS| ## 2.1、IIS使用前准备 ### 2.1.1 运行环境 Windows Server 2016及以上版本,服务操作系统需[安装IIS7以上版本](/doc/course/setupiis.html "安装IIS7") # 3、接口目录 |接口名称|接口描述| | ------------ | ------------ | |[CVHost.CreateVirHost](#4、CVHost.CreateVirHost "CVHost.CreateVirHost")|创建云虚拟主机,由于本接口在服务端操作时间比较长,因此建议采用异步请求| |[CVHost.BindDomain](#5、CVHost.BindDomain "CVHost.BindDomain")|实例域名绑定接口,**此处应注意,需包含默认绑定域名**| |[CVHost.RAR](#6、CVHost.RAR "CVHost.RAR")|主机实例一键打包,如实例有文件被锁定,可能会有部分文件无法打包,根据实例占用容量大小决定打包时间,建议采用异步调用,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。| |[CVHost.UNRAR](#7、CVHost.UNRAR "CVHost.UNRAR")|主机实例一键解压,如实例有文件被锁定,可能会有部分文件无法解压覆盖,根据实例占用容量大小决定打包时间,**建议采用异步调用**,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。| |[CVHost.SetDefaultDocument](#8、CVHost.SetDefaultDocument "CVHost.SetDefaultDocument")|设置实例默认访问文档| |[CVHost.SetISAPIFilter](#9、CVHost.SetISAPIFilter "CVHost.SetISAPIFilter")|设置实例ISAPI筛选器| |[CVHost.SetHttpError](#10、CVHost.SetHttpError "CVHost.SetHttpError")|设置实例错误页面内容| |[CVHost.SetMIMEMap](#11、CVHost.SetMIMEMap "CVHost.SetMIMEMap")|设置实例MIME类型| |[CVHost.SetSiteLimit](#12、CVHost.SetSiteLimit "CVHost.SetSiteLimit")|设置站点访问限制,最大同时连接数及带宽上限| |[CVHost.SetExpDate](#13、CVHost.SetExpDate "CVHost.SetExpDate")|设置实例到期日期| |[CVHost.SetFTPPWD](#14、CVHost.SetFTPPWD "CVHost.SetFTPPWD")|设置FTP登陆密码| |[CVHost.SetMaxSize](#15、CVHost.SetMaxSize "CVHost.SetMaxSize")|设置最大可用容量| |[CVHost.SetMonthFlow](#16、CVHost.SetMonthFlow "CVHost.SetMonthFlow")|设置月流量| |[CVHost.ReStart](#17、CVHost.ReStart "CVHost.ReStart")|重启程序池| |[CVHost.Start](#18、CVHost.Start "CVHost.Start")|启动实例| |[CVHost.Stop](#19、CVHost.Stop "CVHost.Stop")|停止实例| |[CVHost.Remove](#20、CVHost.Remove "CVHost.Remove")|删除实例| |[CVHost.SetIP](#21、CVHost.SetIP "CVHost.SetIP")|设置实例IP| |[CVHost.GetStatus](#22、CVHost.GetStatus "CVHost.GetStatus")|获取实例状态| |[CVHost.SetPHPVer](#23、CVHost.SetPHPVer "CVHost.SetPHPVer")|设置PHP版本| |[CVHost.SetAppPool](#24、CVHost.SetAppPool "CVHost.SetAppPool")|设置程序池CPU、内存、运行位数| |[CVHost.GetFTPConnection](#25、CVHost.GetFTPConnection "CVHost.GetFTPConnection")|获取FTP连接信息| |[CVHost.GetObjectSetting](#26、CVHost.GetObjectSetting "CVHost.GetObjectSetting")|获取实例设置,其中使用量(如已使用容量、流量等)非实时数据,使用量仅在调用GetStatus时及系统自动每2小时会更新。不建议过度依赖此数据查询,因此建议该数据在开发者数据库中也应存储一份,以减少接口请求。| |[CVHost.SetEnableFSO](#27、CVHost.SetEnableFSO "CVHost.SetEnableFSO")|设置FSO的启用、禁用| |[CVHost.SetHttpRedirect](#28、CVHost.SetHttpRedirect "CVHost.SetHttpRedirect")|设置HTTP重定向| |[CVHost.SetIpSecurity](#29、CVHost.SetIpSecurity "CVHost.SetIpSecurity")|设置IP安全策略| |[CVHost.ClearWWWROOT](#30、CVHost.ClearWWWROOT "CVHost.ClearWWWROOT")|清空WWWROOT目录下的所有内容| |[CVHost.GetLog](#31、CVHost.GetLog "CVHost.GetLog")|获取系统日志| |[CVHost.SetAntiTheft](#32、CVHost.SetAntiTheft "CVHost.SetAntiTheft")|设置防盗链| |[CVHost.SetSiteHSTS](#33、CVHost.SetSiteHSTS "CVHost.SetSiteHSTS")|设置HSTS| |[CVHost.ExportAllCVHost](#34、CVHost.ExportAllCVHost "CVHost.ExportAllCVHost")|导出所有实例,导出方式采用的是WinRAR压缩打包的方式进行导出,如实例有文件被锁定,可能会有部分文件无法打包,根据实例占用容量大小决定打包时间,建议采用异步调用,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。| |[CVHost.SetScriptEnabled](#35、CVHost.SetScriptEnabled "CVHost.SetScriptEnabled")|设置脚本开关| |[CVHost.SetExecutePath](#36、CVHost.SetExecutePath "CVHost.SetExecutePath")|设置运行目录| |[CVHost.SetReadOnly](#37、CVHost.SetReadOnly "CVHost.SetReadOnly")|设置文件保护,把指定后缀全部设置为只读权限,即使自己都无法修改| |[CVHost.DisRunDirs](#38、CVHost.DisRunDirs "CVHost.DisRunDirs")|针对目录取消执行权限| # 4、CVHost.CreateVirHost ### 4.1 接口描述 创建云虚拟主机接口,由于本接口在服务端操作时间比较长,因此**建议采用异步请求**。 ### 4.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|云虚拟主机实例FTP登陆名,限英文字母+数字+下划线。与其它云虚拟主机不能重名,建议使用您的系统数据库记录值Id| |FTPPassword|String|-|必填|实例FTP登陆密码,由字母+数字+下划线组成,4-12位| |CVHostSavePath|String|-|必填|实例存放目录,该目录在磁盘上必须存在,如:d:\\cvhost,那么实例创建后将存放在d:\\cvhost\\**FTPUserName**| |BindDomain|String|-|必填|实例默认绑定域名| |AppPoolName|String|-|必填|程序池名称,如果程序池不存在,则系统自动创建| |Memory|Int|-|必填|程序池最大内存,单位:MB,0为无限制| |CPULimit|Int|-|必填|程序池CPU限制百分比,0为无限制| |maxConnections|Int|-|必填|实例最大同时连接数,-1为不限制| |maxBandwidth|Int|-|必填|实例最大带宽,-1为不限制,单位:KB| |DefaultDocument|JsonArray|-|非必填|默认文档列表,字段类型为String集合,如:["index.html","index.aspx"]| |MIMEMap|JsonArray|-|非必填|自定义MIME类型,字段类型为MIME对象集合,[点击查看MIME对象](#4.2.1%20MIME%E5%AF%B9%E8%B1%A1 "点击查看MIME对象")| |ISAPIFilter|JsonArray|-|非必填|自定义ISAPI过滤器,字段类型为ISAPIFilter对象集合,[点击查看ISAPIFilter对象](#4.2.2%20ISAPIFilter%E5%AF%B9%E8%B1%A1 "点击查看ISAPIFilter对象")| |HttpError|JsonArray|-|非必填|自定义错误页面,字段类型为ErrorPage对象集合,[点击查看ErrorPage对象](#4.2.3%20HttpError%E5%AF%B9%E8%B1%A1 "点击查看ErrorPage对象")| |ExpDate|Int|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| |MaxSize|Decimal|-|必填|实例最大磁盘容量,单位:MB,-1为不限制| |IP|String|-|非必填|云虚拟主机绑定IP,如放空则表示所有指向服务器IP均可使用,如有填写则实例绑定的域名A记录需与该IP一致| |MonthFlow|Decimal|-|必填|月流量,单位:MB,0为不限制| |PHPVer|String|-|必填|FastOSAPI支持市面常见动态网页解释器(ASP.NET\ASP\PHP),其中PHP需定义版本号,只能选择其中一个版本运行,可选版本号为:5.2;5.3;5.4;5.5;5.6;7.0;7.1;7.2;7.3;7.4;8.0;8.1| |Enable32Bit|Int|-|非必填|启用32位运行实例,0表示默认64位,1表示启用32位,应注意的是,此项配置是针对程序池设置的,配置时请关注共享程序池和独享程序池的差异。如共享程序池,则仅第一次创建的程序池有效。| |EnableFSO|Int|-|非必填|启用FSO组件(File System Object),该组件一般用于ASP网页的文件管理组件,0表示为关闭状态,1表示为默认值启用| |IpSecurity|JsonArray|-|非必填|IP安全策略,字段类型为IpSecurity对象集合,[点击查看IpSecurity对象](#4.2.4%20IpSecurity%E5%AF%B9%E8%B1%A1 "点击查看IpSecurity对象")| |HttpRedirect|JsonObject|-|非必填|HTTP重定向,字段类型为HttpRedirect,[点击查看HttpRedirect对象](#4.2.5%20HttpRedirect%E5%AF%B9%E8%B1%A1 "点击查看HttpRedirect对象")| |AntiTheft|JsonObject|-|非必填|实例防盗链配置,字段类型为AntiTheft,[点击查看AntiTheft对象](#4.2.6%20AntiTheft%E5%AF%B9%E8%B1%A1 "点击查看AntiTheft对象")| |HSTS|JsonObject|-|非必填|实例HSTS的配置,字段类型为HSTS,[点击查看HSTS对象](#4.2.7%20HSTS%E5%AF%B9%E8%B1%A1 "点击查看HSTS对象")| |ScriptEnabled|JsonObject|-|非必填|脚本开关对象,[点击查看ScriptEnabled对象](#4.2.8%20ScriptEnabled%E5%AF%B9%E8%B1%A1 "点击查看ScriptEnabled对象")| #### 4.2.1 MIME对象 支持访问的MIME文件类型 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |fileExtension|String|文件后缀名,如:.apk| |mimeType|String|MIME类型,如:application/vnd.android| #### 4.2.2 ISAPIFilter对象 站点ISAPI筛选器 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |Name|String|过滤器名称| |Path|String|过滤器文件位置,站点的wwwroot目录为起始根目录,如:/filter/rewrite.dll| #### 4.2.3 HttpError对象 站点错误页设置,默认为系统自带错误提示页 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |StatusCode|Int|网页错误状态码,如:404| |Path|String|过滤器文件位置,站点的wwwroot目录为起始根目录,如:/errorpage/404.html| #### 4.2.4 IpSecurity对象 IP安全策略 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |IpAddress|String|IP地址| |SubnetMask|String|子网掩码,本字段非必填,如果放空则表示限制单个IP。设ipAddress=128.1.1.0,subnetMask=255.255.255.0,则表示128.1.1.*整个IP段| |Allowed|Int|通行规则,1表示允许,0表示禁止| #### 4.2.5 HttpRedirect对象 HTTP重定向 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |Enabled|Int|是否启用HTTP重定向,1表示启用,0表示默认值关闭| |Destination|String|将请求重定向该目标网址| |ExactDestination|Int|将所有请求重定向到确切的目标(而不是相对目标),1表示启用,0表示默认值关闭| |ChildOnly|Int|仅将请求重定向到此目录(非子目录)中的内容,1表示启用,0表示默认值关闭| |HttpResponseStatus|Int|状态代码,可选值:301(永久)、302(已找到)、307(临时)、308(永久重定向)| #### 4.2.6 AntiTheft对象 防盗链对象 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |FileExts|SringArray|验证文件后缀,字段类型为字符串数组,如:[".jpg",".gif",".png"]| |Domains|SringArray|域名白名单,在数组中允许调用的域名列表,字段类型为字符串数组,如:["lcoalhost","fastosapi.com"]| #### 4.2.7 HSTS对象 HSTS |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |Enabled|Int|是否启用本功能,1未启用,0为关闭| |MaxAge|Long|单位:秒,用来告诉浏览器在指定时间内,这个网站必须通过 HTTPS 协议来访问。也就是对于这个网站的 HTTP 地址,浏览器需要先在本地替换为 HTTPS 之后再发送请求| |IncludeSubDomains|Int|1为启用,0为关闭。是否所有子域名也必须通过 HTTPS 协议来访问| |Preload|Int|1为启用,0为关闭。是否使用浏览器内置的使用 HTTPS 的域名列表| |RedirectHttpToHttps|Int|1为启用,0为关闭。是否将HTTP重定向到HTTPS| #### 4.2.8 ScriptEnabled对象 脚本开关对象 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |DotNet|Int|是否启用.aspx,1为启用,0为禁用| |PHP|Int|是否启用.php,1为启用,0为禁用| |ASP|Int|是否启用.asp,1为启用,0为禁用| ### 4.3 接口示例 ` http://yourhost:2390/api/service/CVHost.CreateVirHost?BindDomain=cvhost_1.fastosapi.com&MonthFlow=10240&Scripts=%5B%22dotnet%22%2C%22asp%22%2C%22php%22%5D&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&Memory=512&_RPW_Sign=E7B6AD5B1154E456AF8F78402F87CDCA&FTPUserName=cvhost_1&_RPW_IsAsyn=0&AppPoolName=cvhostpool_1&FTPPassword=123123&_RPW_QueueId=20220905152056949&CPULimit=10&CVHostSavePath=D%3a%5ccvhost` ### 4.4 错误代码列表 |代码|描述| | ------------ | ------------ | |600401|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |600402|默认绑定域名不能放空| |600403|程序池名称格式错误,由字母+数字+下划线组成,4-12位| |600404|实例存放目录不存在| |600405|FTP密码格式错误,由字母+数字+下划线组成,4-12位| |600406|程序池内存必须大于0,单位GB| |600407|创建云虚拟主机实例目录时出错| |600408|程序池创建失败| |600409|设置实例目录权限失败| |600410|IIS站点已经存在,请更换FTP名| |600411|实例到期日期不能≤创建日期| # 5、CVHost.BindDomain ### 5.1接口描述 绑定云虚拟主机实例域名 ### 5.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |Binds|JsonArray|-|必填|**注意:应包含创建实例时的默认绑定域名**,[域名绑定对象集合](#5.3Bind对象 "域名绑定对象集合")| ### 5.3Bind对象 |字段名称|数据类型|描述| | ------------ | ------------ | ------------ | |protocol|String|协议类型,可选值为http和https| |domain|String|域名| |cert|String|SSL证书下载地址,仅协议类型为https有效,文件格式为pfx;如果协议类型为http,则值放空| |certpwd|String|SSL证书密码,仅协议类型为https有效;如果协议类型为http,则值放空| ### 5.3.1 Bind对象JSON示例 ```json {"protocol":"http","domain":"cvhost_1.fastosapi.com","cert":"";"certpwd":""} ``` ### 5.3.2 Bind集合JSON示例 ```json [{"protocol":"http","domain":"cvhost_1.fastosapi.com","cert":"";"certpwd":""},{"protocol":"http","domain":"test.abc.com","cert":"";"certpwd":""},{"protocol":"https","domain":"test1.abc.com","cert":"http://www.abc.com/abc.pfx","certpwd":"321121"}] ``` ### 5.4接口示例 ` http://yourhost:2390/api/service/CVHost.BindDomain?_RPW_Sign=55CDE873561D3787B6CFBC350C82FDEC&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220905204505028&Binds=%5b%7b%22protocol%22%3a%22http%22%2c%22domain%22%3a%22cvhost_1.fastosapi.com%22%7d%2c%7b%22protocol%22%3a%22http%22%2c%22domain%22%3a%22test.abc.com%22%7d%5d` ### 5.5接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 5.6错误代码 |代码|描述| | ------------ | ------------ | |600501|绑定域名集合有误,请检查数据格式是否正确| |600502|找不到站点,请检查FTP名称是否正确| |600503|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |600504|https证书下载失败,请检查证书下载地址是否正确| |600505|https证书文件需要IIS支持的证书文件,文件后缀为.pfx| |600506|https证书文件下载地址不正确| |600507|protocol协议类型必须为http或https| |600508|绑定域名domain字段不能为空| |600509|绑定域名集合不能为空| |600510|绑定域名集合出现重复,请检查记录是否存在重复| # 6、CVHost.RAR ### 6.1接口描述 主机实例一键打包,如实例有文件被锁定,可能会有部分文件无法打包,根据实例占用容量大小决定打包时间,**建议采用异步调用**,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。 ### 6.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |SavePath|String|-|非必填|自定义存放目录,放空则打包到实例目录\sys_other\compressed.rar下。如有填写,该目录需在服务器上已经存在。| |RARPath|String|-|非必填|自定义打包目录,以实例目录作为根目录,放空则表示打包FTP整个目录。如有填写,该目录需在服务器上已经存在。(3.0版本添加)| ### 6.3接口示例 ` http://yourhost:2390/api/service/CVHost.RAR?_RPW_Sign=E09DBE2EECF42257C349B1C3DFA5F160&_RPW_QueueId=20220908111719821&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 6.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":null} ``` ### 6.5错误代码 |代码|描述| | ------------ | ------------ | |600602|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |600603|压缩包已经存在,但系统删除失败,请先登录FTP手动删除后再执行打包| |600604|服务器未安装winrar,不支持此项操作,winrar下载地址:http://www.winrar.com.cn/| |600605|实例所在目录不存在或FTP名称错误| # 7、CVHost.UNRAR ### 7.1接口描述 主机实例一键解压实例目录\sys_other\compressed.rar,如实例有文件被锁定,可能会有部分文件无法解压覆盖,根据实例占用容量大小决定打包时间,**建议采用异步调用**,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。 ### 7.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |UNRARPath|String|-|非必填|自定义解压目标目录,以实例目录作为根目录,放空则表示解压到实例目录。如有填写,该目录需在服务器上已经存在。(3.0版本添加)| ### 7.3接口示例 ` http://yourhost:2390/api/service/CVHost.UNRAR?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 7.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 7.5错误代码 |代码|描述| | ------------ | ------------ | |600701|服务器未安装winrar,不支持此项操作,winrar下载地址:http://www.winrar.com.cn/| |600702|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |600704|FTP根目录下压缩包文件compressed.rar不存在,请通过FTP上传后再执行解压| |600705|实例所在目录不存在或FTP名称错误| # 8、CVHost.SetDefaultDocument ### 8.1接口描述 设置实例默认文档,新数据将覆盖现有配置。 ### 8.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |DefaultDocument|StringArray|-|必填|默认文档列表,字段类型为String集合,如:["index.html","index.aspx"]| ### 8.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetDefaultDocument?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&DefaultDocument=%5B%22index.html%22%2C%22index.aspx%22%5D` ### 8.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 8.5错误代码 |代码|描述| | ------------ | ------------ | |601401|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |601402|实例不存在| # 9、CVHost.SetISAPIFilter ### 9.1接口描述 设置实例ISAPI筛选器,新数据将覆盖现有配置。 ### 9.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |ISAPIFilter|JsonArray|-|必填|自定义ISAPI过滤器,字段类型为ISAPIFilter对象集合,[点击查看ISAPIFilter对象](#4.2.2%20ISAPIFilter%E5%AF%B9%E8%B1%A1 "点击查看ISAPIFilter对象")| ### 9.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetISAPIFilter?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&ISAPIFilter=%5B%22Name%22%3A%22rewirte%22%2C%22Path%22%3A%22%2Ffilter%2Frewrite.dll%22%5D` ### 9.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 10、CVHost.SetHttpError ### 10.1接口描述 设置实例错误页面,新数据将覆盖现有配置。 ### 10.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |HttpError|JsonArray|-|必填|自定义错误页面,字段类型为ErrorPage对象集合,[点击查看ErrorPage对象](#4.2.3%20HttpError%E5%AF%B9%E8%B1%A1 "点击查看ErrorPage对象")| ### 10.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetHttpError?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&HttpError=%5B%7B%22StatusCode%22%3A404%2C%22Path%22%3A%22%2Ferrorpage%2F404.html%22%7D%5D` ### 10.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 11、CVHost.SetMIMEMap ### 11.1接口描述 设置实例MIME类型,新数据将覆盖现有配置。 ### 11.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |MIMEMap|JsonArray|-|必填|自定义MIME类型,字段类型为MIME对象集合,[点击查看MIME对象](#4.2.1%20MIME%E5%AF%B9%E8%B1%A1 "点击查看MIME对象")| ### 11.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetMIMEMap?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&MIMEMap=%5B%7B%22fileExtension%22%3A%22.apk%22%2C%22mimeType%22%3A%22application%2Fvnd.android%22%7D%5D` ### 11.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 12、CVHost.SetSiteLimit ### 12.1接口描述 设置站点访问限制,最大同时连接数及带宽上限 ### 12.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |maxConnections|Int|-|必填|实例最大同时连接数,-1为不限制| |maxBandwidth|Int|-|必填|实例最大带宽,-1为不限制,单位:KB| ### 12.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetMIMEMap?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&maxConnections=200&maxBandwidth=100` ### 12.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 13、CVHost.SetExpDate ### 13.1接口描述 设置实例到期日期 ### 13.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |ExpDate|Int|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| ### 13.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetExpDate?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&ExpDate=20251108` ### 13.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 14、CVHost.SetFTPPWD ### 14.1接口描述 修改FTP登陆密码 ### 14.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |FTPPassword|String|-|必填|FTP密码,由字母+数字+下划线组成,4-12位| ### 14.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetFTPPWD?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&FTPPassword=newPWD123&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 14.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 14.5错误代码 |代码|描述| | ------------ | ------------ | |602101|FTP名称格式错误,由字母+数字+下划线组成,4-12位| |602102|FTP密码格式错误,由字母+数字+下划线组成,4-12位| |602103|读取实例配置文件失败| |602104|FTP密码修改失败| # 15、CVHost.SetMaxSize ### 15.1接口描述 设置实例最大可用容量 ### 15.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |MaxSize|Decimal|-|必填|实例最大磁盘容量,单位:MB,-1为不限制| ### 15.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetMaxSize?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&MaxSize=1024&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 15.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 16、CVHost.SetMonthFlow ### 16.1接口描述 设置实例最大可用容量 ### 16.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |MonthFlow|Decimal|-|必填|月流量,单位:MB,0为不限制| ### 16.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetMonthFlow?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&MonthFlow=10240&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 16.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 17、CVHost.ReStart ### 16.1接口描述 重启实例 ### 17.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 17.3接口示例 ` http://yourhost:2390/api/service/CVHost.ReStart?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 17.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 18、CVHost.Start ### 18.1接口描述 启动实例 ### 18.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 18.3接口示例 ` http://yourhost:2390/api/service/CVHost.Start?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 18.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 19、CVHost.Stop ### 19.1接口描述 停止实例 ### 19.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 19.3接口示例 ` http://yourhost:2390/api/service/CVHost.Stop?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 19.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 20、CVHost.Remove ### 20.1接口描述 删除实例 ### 20.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |CVHostSavePath|String|-|必填|实例存放目录,与在创建实例目录时设置的CVHostSavePath值一致| ### 20.3接口示例 ` http://yourhost:2390/api/service/CVHost.Remove?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&CVHostSavePath=d%3A%5Ccvhost&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 20.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 21、CVHost.SetIP ### 21.1接口描述 设置实例IP ### 21.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |IP|String|-|必填|放空表示清除绑定,如有填写IP则需使用正确的IP格式:255.255.255.255| ### 21.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetIP?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&IP=151.20.11.30&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 21.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 21.5错误代码 |代码|描述| | ------------ | ------------ | |603801|IP格式有误| # 22、CVHost.GetStatus ### 22.1接口描述 获取实例状态信息,该信息除了每2小时系统会通过消息推送给回调地址外,开发者可通过本接口查询。本数据为实时查询结果,如非必要,建议不要高频率调用本接口,其中包含统计空间使用容量,如文件太多需要时间越久 ### 22.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 22.3接口示例 ` http://yourhost:2390/api/service/CVHost.GetStatus?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 22.4接口返回数据字段说明 |字段名称|字段说明| | ------------ | ------------ | |AppPoolName|程序池名称| |AppPoolState|程序池状态| |MonthFlow|每月可使用流量,单位:MB| |ThisMonthFlow|本月已使用流量,单位:MB| |MaxSize|最大空间容量,单位:MB| |Size|已使用空间容量,单位:MB| ### 22.5接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":{ "AppPoolState":1, "State":1, "MaxSize":3072, "AppPoolName":"17_s_1", "ThisMonthFlow":0, "MonthFlow":2048, "Size":0 } } ``` ### 22.6错误代码 |代码|描述| | ------------ | ------------ | |603801|IP格式有误| # 23、CVHost.SetPHPVer ### 23.1接口描述 设置实例PHP版本 ### 23.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |PHPVer|String|-|必填|可选版本号为:5.2;5.3;5.4;5.5;5.6;7.0;7.1;7.2;7.3;7.4;8.0;8.1| ### 23.3接口示例 ` http://yourhost:2390/api/service/CVHost.GetStatus?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&PHPVer=5.5&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 23.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 23.5错误代码 |代码|描述| | ------------ | ------------ | |605001|PHP版本不正确| |605002|PHP版本切换失败| # 24、CVHost.SetAppPool ### 24.1接口描述 设置程序池CPU、内存、运行位数 ### 24.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |Enable32Bit|Int|-|必填|启用32位运行实例,0表示默认64位,1表示启用32位,应注意的是,此项配置是针对程序池设置的,配置时请关注共享程序池和独享程序池的差异。如共享程序池,则仅第一次创建的程序池有效。| |CPULimit|Int|-|必填|程序池CPU限制百分比,0为无限制| |Memory|Int|-|必填|程序池最大内存,单位:MB,0为无限制| |NetVer|Int|-|必填|程序池.net版本,仅限2或者4| |IsClassicModel|Int|-|必填|是否为经典模式,1为经典模式,2为托管模式(默认),应注意:经典模式为早期产品,许多功能已失去支持,因此托管模式下,防盗链及流量统计将失效| ### 24.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetAppPool?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&Enable32Bit=0&CPULimit=10&Memory=512&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 24.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` ### 24.5错误代码 |代码|描述| | ------------ | ------------ | |e605003|设置程序池信息失败| # 25、CVHost.GetFTPConnection ### 25.1接口描述 获取FTP连接信息 ### 25.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 25.3接口示例 ` http://yourhost:2390/api/service/CVHost.GetFTPConnection?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 25.4返回数据说明 |字段名|字段说明| | ------------ | ------------ | |Server|FTP登陆地址| |Account|FTP登陆帐号,由于IIS登陆机制问题,登陆账号格式为:FTP登陆地址+"英文竖杠"+FTPUserName。在FTP软件登陆时应输入完整的格式账号,而不能只输“FTPUserName”| |Password|FTP登陆密码| ### 25.5接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":{"Password":"hkXVfIwTGioa","Server":"ftp.a27cbf69.testaa.com","Account":"ftp.a27cbf69.testaa.com|a27cbf69"}} ``` # 26、CVHost.GetObjectSetting ### 26.1接口描述 获取实例设置,其中使用量(如已使用容量、流量等)非实时数据,使用量仅在调用GetStatus时及系统自动每2小时会更新。不建议过度依赖此数据查询,因此建议该数据在开发者数据库中也应存储一份,以减少接口请求。 ### 26.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 26.3接口示例 ` http://yourhost:2390/api/service/CVHost.GetObjectSetting?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 26.4接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":{ "FTPUserName":"a27cbf69", "FTPPassword":"hkXVfIwTGioa", "BindDomain":"a27cbf69.testaa.com", "AppPoolName":"17_s_1", "CVHostSavePath":"d:\\cvhost", "Memory":1024, "CPULimit":10, "CPUResetInterval":5, "maxConnections":1000, "maxBandwidth":10, "AddDate":20221109, "ExpDate":20221209, "MIMEMap":[ ], "DefaultDocument":[ "index.html", "index.aspx" ], "HttpError":[ ], "ISAPIFilter":[ ], "Size":0, "MaxSize":3072, "IP":"", "MonthFlow":2048, "ThisMonthFlow":0, "PHPVer":"5.2", "Enable32Bit":1, "Binds":[ { "protocol":"http", "domain":"a27cbf69.testaa.com", "cert":"", "certpwd":"" } ] } } ``` # 27、CVHost.SetEnableFSO ### 27.1接口描述 设置FSO(File System Object)的启用、禁用,该组件一般用于ASP网页的文件管理组件 ### 27.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |EnableFSO|Int|-|必填|1表示默认值启用,0表示禁用| ### 27.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetEnableFSO?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&EnableFSO=0&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 27.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 28、CVHost.SetHttpRedirect ### 28.1接口描述 设置HTTP重定向 ### 28.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |HttpRedirect|JsonObject|-|非必填|HTTP重定向,字段类型为HttpRedirect,[点击查看HttpRedirect对象](#4.2.5%20HttpRedirect%E5%AF%B9%E8%B1%A1 "点击查看HttpRedirect对象")| ### 28.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetHttpRedirect?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&HttpRedirect=%7BEnabled%3A1%2CDestination%3A%22http%3A%2F%2Fwww.fastosapii.com%22%2CExactDestination%3A0%2CChildOnly%3A0%2CHttpResponseStatus%3A301%7D&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 28.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 29、CVHost.SetIpSecurity ### 29.1接口描述 设置IP安全策略 ### 29.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |IpSecuritys|JsonArray|-|非必填|IP安全策略,字段类型为IpSecurity对象集合,[点击查看IpSecurity对象](#4.2.4%20IpSecurity%E5%AF%B9%E8%B1%A1 "点击查看IpSecurity对象")| ### 29.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetIpSecurity?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&IpSecurity=%5B%7BIpAddress%3A%22128.1.1.0%22%2CSubnetMask%3A%22255.255.255.0%22%2CAllowed%3A0%7D%2C%7BIpAddress%3A%22130.1.1.0%22%2CSubnetMask%3A%22255.255.255.0%22%2CAllowed%3A0%7D%5D&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 29.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 30、CVHost.ClearWWWROOT ### 30.1接口描述 清空WWWROOT目录下的所有内容,**警告:原则上不适用该接口清空WWWROOT下的文件,该操作具有风险性,内容清空后无法恢复,请在充分提醒用户(如人机验证、短信验证)后再调用本接口。建议让用户登录FTP自行清理**。 本接口在执行操作时会重启关联程序池及网站。 ### 30.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 30.3接口示例 ` http://yourhost:2390/api/service/CVHost.ClearWWWROOT?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&EnableFSO=0&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 30.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 31、CVHost.GetLog ### 31.1接口描述 获取系统日志,调用接口后,将拉取实例访问日志并打包一份到:**实例根目录\yyyyMMddHHmmssfff.rar** 应注意:**日志不包含当天日志**,本接口需服务器安装[Winrar](http://www.winrar.com.cn/ "Winrar")。 ### 31.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| ### 31.3接口示例 ` http://yourhost:2390/api/service/CVHost.GetLog?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 31.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 32、CVHost.SetAntiTheft ### 32.1接口描述 设置IP安全策略 ### 32.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |AntiTheft|JsonObject|-|非必填|实例防盗链配置,字段类型为AntiTheft,[点击查看AntiTheft对象](#4.2.6%20AntiTheft%E5%AF%B9%E8%B1%A1 "点击查看AntiTheft对象")| ### 32.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetAntiTheft?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&AntiThef=%7B%20%20%20%20%22FileExts%22%3A%5B%22.gif%22%2C%22.jpg%22%5D%2C%20%20%20%20%22Domains%22%3A%5B%5D%7D&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 32.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 33、CVHost.SetSiteHSTS ### 33.1接口描述 设置IP安全策略 ### 33.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |HSTS|JsonObject|-|非必填|实例HSTS的配置,字段类型为HSTS,[点击查看HSTS对象](#4.2.7%20HSTS%E5%AF%B9%E8%B1%A1 "点击查看HSTS对象")| ### 33.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetSiteHSTS?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&HSTS=%7BEnabled%3A1%7D&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 33.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 34、CVHost.ExportAllCVHost ### 34.1接口描述 导出所有实例,导出方式采用的是WinRAR压缩打包的方式进行导出,如实例有文件被锁定,可能会有部分文件无法打包,根据实例占用容量大小决定打包时间,建议采用异步调用,使用该功能,服务器需安装[Winrar](http://www.winrar.com.cn/ "Winrar")。| ### 34.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |SavePath|String|-|必填|导出存储目录,该目录需载服务器上有存在| |VSize|Int|-|非必填|整型数值,表示导出打包每个分卷大小,放空默认值为1,单位:GB| ### 34.3接口示例 ` http://yourhost:2390/api/service/CVHost.ExportAllCVHost?_RPW_Sign=0B36248CAEADD40B631BCA5359F65736&_RPW_IsAsyn=0&SavePath=D%3a%5cexport&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&VSize=1&_RPW_QueueId=20230117140827096` ### 34.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 35、CVHost.SetScriptEnabled ### 35.1接口描述 设置实例脚本开关 ### 35.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |ScriptEnabled|JsonObject|-|非必填|脚本开关对象,[点击查看ScriptEnabled对象](#4.2.8%20ScriptEnabled%E5%AF%B9%E8%B1%A1 "点击查看ScriptEnabled对象")| ### 35.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetSiteHSTS?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&ScriptEnabled=%7B%22DotNet%22%3A1%2C%22PHP%22%3A1%2C%22ASP%22%3A1%7D&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` # 36、CVHost.SetExecutePath ### 36.1接口描述 设置实例运行目录 ### 36.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |ExecutePath|String|-|必填|运行目录,路径需以“/”开头。由于FTP可删除"实例目录/wwwroot"下的文件夹,因此,系统不强制判断该目录是否存在,如目录不存在,站点无法正常访问,路径格式仅支持:英文大小写、数字、下划线及正斜杠]| ### 36.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetSiteHSTS?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&ExecutePath=/shop&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` # 37、CVHost.SetReadOnly ### 37.1接口描述 设置文件保护,把指定后缀全部设置为只读权限,即使自己都无法修改 ### 37.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |ReadOnlyFileRules|String|-|必填|文件规则,多个以,分割演示:*.htm,*.html,或则指定名称fastosapi.php,留空为解锁全部文件保护| ### 37.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetReadOnly?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&ReadOnlyFileRules=web.config,*.html&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` # 38、CVHost.DisRunDirs ### 38.1接口描述 针对目录取消执行权限 ### 38.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |FTPUserName|String|-|必填|实例FTP登陆名| |Dirs|String|-|必填|目录列表,举例:禁止upload目录所有脚本支持,仅限图片访问,多个目录以英文,分割,留空代表取消全部目录执行权限| ### 38.3接口示例 ` http://yourhost:2390/api/service/CVHost.SetReadOnly?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&FTPUserName=cvhost_1&Dirs=upload,img&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584`