FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 接口目录 |接口名称|接口描述| | ------------ | ------------ | |[Other.Hello](#1、Other.Hello "Other.Hello")|系统握手| |[Other.FolderExists](#2、Other.FolderExists "Other.FolderExists")|判断系统目录是否存在| |[Other.GetQueue](#3、Other.GetQueue "Other.GetQueue")|获取队列信息| |[Other.GetSoftInfo](#4、Other.GetSoftInfo "Other.GetSoftInfo")|获取软件信息| |[Other.DownloadFile](#5、Other.DownloadFile "Other.DownloadFile")|下载文件到宿主机| # 1、Other.Hello ### 1.1 接口描述 本方法一般用于接口测试是否正常 ### 1.2 接口参数 无 ### 1.3 接口示例 ` http://yourhost:2390/api/service/Other.Hello?_RPW_Sign=9E3BF12B5A069C543CAF27CCF184AEE2&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825001208282&_RPW_IsAsyn=0 ` ### 1.4 接口返回data说明 返回String类型,success ### 1.5 接口返回成功示例 ```json {"aqid":0,"state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 2、Other.FolderExists ### 2.1 接口描述 判断系统目录是否存在 ### 2.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Folder|String|-|必填|文件夹路径,如:D:\FastOSAPI| ### 2.3 接口示例 ` http://yourhost:2390/api/service/Other.FolderExists?_RPW_Sign=54D468330E8214D959AA3F7065052653&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&Folder=D%3a%5cFastOSAPI&_RPW_QueueId=20220825005151618&_RPW_IsAsyn=0 ` ### 2.4 接口返回data说明 返回Int类型,1为存在,0为不存在 ### 2.5 接口返回成功示例 ```json {"aqid":0,"state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":1} ``` ### 2.6 错误代码 |代码|描述| | ------------ | ------------ | |600101|请输入判断文件夹路径| # 3、Other.GetQueue ### 3.1 接口描述 获取队列信息,在接口异步请求接口时,服务器将记录队列信息,在接口完成任务后会推送信息至接口回调地址。为解决推送信息可能失败,可使用该接口自主查询队列状态。 ### 3.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |QueueId|String|-|必填|查询队列ID| ### 3.3 接口示例 ` http://yourhost:2390/api/service/Other.GetQueue?_RPW_Sign=54D468330E8214D959AA3F7065052653&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&QueueId=20221109114858578&_RPW_QueueId=20220825005151618&_RPW_IsAsyn=0 ` ### 3.4 错误代码 |代码|描述| | ------------ | ------------ | |603901|请输入队列ID| |603902|找不到队列数据| ### 3.5 接口返回实体说明 |字段|说明| | ------------ | ------------ | |QueueId|队列ID| |Request|接口请求信息| |Completed|是否已完成,数据类型为bool| |State|接口执行返回状态| |CreateTime|队列创建时间,即队列请求时间| |CompletedTime|队列完成时间,即接口完成时间| ### 3.6 接口返回示例 ```json { "QueueId":"20221109114858578", "Request":{ "Params":null, "Method":null, "URL":"/api/service/Other.Hello", "ProtocolVersion":"HTTP/1.1", "Logger":null, "Body":"_RPW_IsAsyn=1&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20221109114858578&_RPW_Sign=517D67F9E79E485E84C5531E7A35DE18&VMName=cvm_1", "Encoding":null, "Content_Type":null, "Content_Length":null, "Content_Encoding":null, "ContentLanguage":null, "Headers":{ "ContentLength":"145", "Content-Type":"application/x-www-form-urlencoded", "Host":"156.227.31.38", "Content-Length":"145", "Expect":"100-continue", "Connection":"Keep-Alive" } }, "Completed":true, "State":{ "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":"success" }, "CreateTime":"2022-11-09 11:48:41.013", "CompletedTime":"2022-11-09 11:48:41.060" } ``` # 4、Other.GetSoftInfo ### 4.1 接口描述 获取软件信息 ### 4.2 接口参数 无 ### 4.3 接口示例 ` http://yourhost:2390/api/service/Other.GetSoftInfo?_RPW_Sign=54D468330E8214D959AA3F7065052653&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825005151618&_RPW_IsAsyn=0 ` ### 4.4 接口返回实体说明 |字段|说明| | ------------ | ------------ | |RegInfo|软件注册信息| |RegInfo.Registered|是否已注册,仅判断授权码是否正确,不判断是否已到期,1为已注册,0为未注册| |RegInfo.BindId|FastOSAPI受控端服务ID,用于主控识别| |RegInfo.RegData|授权信息,仅Registered等于1时有数据| |RegInfo.RegData.PCCode|机器码| |RegInfo.RegData.EditionName|授权版本名称| |RegInfo.RegData.CVMEnabled|是否支持云主机,1为支持,0为不支持| |RegInfo.RegData.CVHostEnabled|是否支持云虚拟主机,1为支持,0为不支持| |RegInfo.RegData.CDBEnabled|是否支持云数据库,1为支持,0为不支持| |RegInfo.RegData.EMailEnabled|是否支持企业邮局,1为支持,0为不支持| |RegInfo.RegData.ExpTime|授权到期时间| |RegInfo.RegData.AddTime|授权激活信息| |RegInfo.RegData.UpdateTime|授权码更新时间| |VersionInfo|版本信息| |VersionInfo.Version|发行版本号,类型为字符串| |VersionInfo.BuildNumber|**内部版本号,编译时的版本编号,该编号为整型,数字越大表示版本越高**| |VersionInfo.BuildDate|编译日期,整型,格式为yyyyMMdd| # 5、Other.DownloadFile ### 5.1 接口描述 下载文件到宿主机 ### 5.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |DownloadUrl|String|-|必填|下载地址| |SaveDirectory|String|-|必填|保存目录| |SaveFileName|String|-|必填|保存文件名称| ### 5.3 接口示例 ` http://yourhost:2390/api/service/Other.DownloadFile?_RPW_Sign=54D468330E8214D959AA3F7065052653&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825005151618&_RPW_IsAsyn=0&DownloadUrl=http%3A%2F%2Fabc.com%2F1.rar&SaveDirectory=d%3A%5Cdw&SaveFileName=save.rar `