FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 1、云数据库服务描述 云数据库服务支持服务器上管理MSSQL、MySQL数据库 # 2、运行平台 系统支持管理多平台创建的云数据库,如:MSSQL、MySQL等数据库服务器软件 当前支持软件对应表格如下: |平台名称|简称| | ------------ | ------------ | |Microsoft SQL Server|MSSQL| |Oracle MySQL|MySQL| # 3、接口目录 |接口名称|接口描述| | ------------ | ------------ | |[CDB.CreateCDB](#4、CDB.CreateCDB "CDB.CreateCDB")|创建云数据库| |[CDB.SetMaxSize](#5、CDB.SetMaxSize "CDB.SetMaxSize")|设置实例最大容量上限| |[CDB.SetExpDate](#6、CDB.SetExpDate "CDB.SetExpDate")|设置实例到期时间| |[CDB.RevokeAccess](#7、CDB.RevokeAccess "CDB.SetExpDate")|撤销数据库访问权限,用于特殊情况下对实例进行管控时操作,如:出现违规。注意:删除实例、备份、还原等操作无须执行本操作,系统会自动执行| |[CDB.GrantAccess](#8、CDB.GrantAccess "CDB.GrantAccess")|授权数据库访问,用于实例被撤销访问时重新授权访问时操作。注意:创建实例、备份、还原等操作无须执行本操作,系统会自动执行| |[CDB.Remove](#9、CDB.Remove "CDB.Remove")|删除实例,注意:删除实例将彻底删除数据且无法恢复,请谨慎操作| |[CDB.Backup](#10、CDB.Backup "CDB.Backup")|备份数据库| |[CDB.GetDBBackupManageUrl](#11、CDB.GetDBBackupManageUrl "CDB.GetDBBackupManageUrl")|获取备份文件管理地址| |[CDB.Restore](#12、CDB.Restore "CDB.Restore")|还原数据库| |[CDB.GetBackupInfo](#13、CDB.GetBackupInfo "CDB.GetBackupInfo")|获取备份列表| |[CDB.DelBackup](#14、CDB.DelBackup "CDB.DelBackup")|删除备份文件| |[CDB.GetStatus](#15、CDB.GetStatus "CDB.GetStatus")|获取实例状态| |[CDB.GetObjectSetting](#16、CDB.GetObjectSetting "CDB.GetObjectSetting")|获取实例信息| |[CDB.SetPWD](#17、CDB.SetPWD "CDB.SetPWD")|设置实例登陆密码| |[CDB.GetConnectionInfo](#18、CDB.GetConnectionInfo "CDB.GetConnectionInfo")|获取实例连接信息:主机地址、端口、账号、密码、数据库名| # 4、CDB.CreateCDB ### 4.1 接口描述 创建云数据库接口 ### 4.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|创建数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |Password|String|-|必填|登陆密码,由字母+数字+下划线组成,4-12位| |DBMaxSize|Int|-|必填|数据库最大容量,0为无限制,单位:MB| |LogMaxSize|Int|-|必填|数据库日志最大容量,0为无限制,单位:MB,本参数**仅Platform=MSSQL有效**| |BackupSpaceMaxSize|Int|-|必填|实例备份存储空间容量,0为无限制,单位:MB| |CDBSavePath|String|-|必填|实例存放目录,该目录在磁盘上必须存在,如:d:\\cdb,那么实例创建后将存放在d:\\cdb\\**Name**,本参数**仅Platform=MSSQL有效**| |ExpDate|Int|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| ### 4.3 接口示例 `http://yourhost:2390/api/service/CDB.CreateCDB?Platform=MSSQL&Name=test_1&Password=123123&DBMaxSize=1024&LogMaxSize=512&CDBSavePath=d%3A%5Ccdb&ExpDate=20231116&_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 4.4 错误代码列表 |代码|描述| | ------------ | ------------ | |605301|数据库名称格式错误,由字母+数字+下划线组成,4-12位| |605302|实例存放目录不存在| |605303|实例到期日期不能≤创建日期| |605304|实例数据库容量不能小于0,单位MB| |605305|实例日志容量不能小于0,单位MB| |605306|实例创建失败| |605307|实例已经存在,请更换其它名称| |605308|实例到期日期不能≤创建日期| # 5、CDB.SetMaxSize ### 5.1 接口描述 创建云数据库接口 ### 5.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |DBMaxSize|Int|-|必填|数据库最大容量,0为无限制,单位:MB| |LogMaxSize|Int|-|必填|数据库日志最大容量,0为无限制,单位:MB,本参数**仅Platform=MSSQL有效**| |BackupSpaceMaxSize|Int|-|必填|备份文件存储空间容量,0为无限制,单位:MB| ### 5.3 接口示例 `http://yourhost:2390/api/service/CDB.SetMaxSize?Platform=MSSQL&Name=test_1&DBMaxSize=1024&LogMaxSize=512&_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 5.4 错误代码列表 |代码|描述| | ------------ | ------------ | |605501|实例数据库容量不能小于0,单位MB| |605502|实例日志容量不能小于0,单位MB| |605503|修改数据库容量失败| # 6、CDB.SetExpDate ### 6.1接口描述 设置实例到期日期 ### 6.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |ExpDate|Int|-|必填|实例到期时间,数据类型为整型,格式为:yyyyMMdd| ### 6.3接口示例 ` http://yourhost:2390/api/service/CDB.SetExpDate?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&ExpDate=20241117&Platform=MSSQL&Name=test_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":""} ``` # 7、CDB.RevokeAccess ### 7.1接口描述 撤销数据库访问权限,用于特殊情况下对实例进行管控时操作,如:出现违规。注意:删除实例、备份、还原等操作无须执行本操作,系统会自动执行 ### 7.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 7.3接口示例 ` http://yourhost:2390/api/service/CDB.RevokeAccess?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_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":""} ``` # 8、CDB.GrantAccess ### 8.1接口描述 授权数据库访问,用于实例被撤销访问时重新授权访问时操作。注意:创建实例、备份、还原等操作无须执行本操作,系统会自动执行 ### 8.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 8.3接口示例 ` http://yourhost:2390/api/service/CDB.GrantAccess?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 8.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 9、CDB.Remove ### 9.1接口描述 删除实例,注意:删除实例将彻底删除数据且无法恢复,请谨慎操作 ### 9.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 9.3接口示例 ` http://yourhost:2390/api/service/CDB.Remove?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 9.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 10、CDB.Backup ### 10.1接口描述 备份实例 ### 10.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 10.3接口示例 ` http://yourhost:2390/api/service/CDB.Backup?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 10.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 11、CDB.GetDBBackupManageUrl ### 11.1接口描述 获取备份文件管理地址,访问本地址可上传本地备份文件,对备份文件进行还原、下载、删除操作 ### 11.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 11.3接口示例 ` http://yourhost:2390/api/service/CDB.GetDBBackupManageUrl?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 11.4接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":"http://156.227.31.38:3659/?token=YwfJ6iimE4YeMcZm5G4PGLTzg3vl7M2O9j5J5xWWPAi7izXR5aqmmhXFBDz0rG6iuMx%2fC%2bW38YbgJJL6zWdN47j5QjqV%2fhoMEzYuWgv5T84z2d3YDW%2b5edTkGamftNJu5zLIlEzkB5Z50mGoIjWilrMpbJtBDoc6JNP8VW5eHKHOydmonrAfA1AY6oZ7kBMULfbGX9hrghrR5lkNy0ZOkH7t33u9vD5zNnVdaL7FLOnXPGQvvI3JRQ%3d%3d&sign=707BE05AF1038CD842B756478138F30C" } ``` # 12、CDB.Restore ### 12.1接口描述 还原数据库实例 ### 12.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |DBFileName|String|-|必填|备份文件名称,该文件名称可根据GetBackupInfo接口获取服务器存储的备份文件列表| ### 12.3接口示例 ` http://yourhost:2390/api/service/CDB.Restore?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&DBFileName=20221122.bak&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 12.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 13、CDB.GetBackupInfo ### 13.1接口描述 获取备份文件信息 ### 13.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 13.3接口示例 ` http://yourhost:2390/api/service/CDB.GetBackupInfo?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 13.4接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":[ { "FileName":"20221122012141743.bak", "AddTime":"2022-11-22 01:21:43", "IsFromUpload":0, "Size":1879 } ] } ``` # 14、CDB.DelBackup ### 14.1接口描述 删除备份文件 ### 14.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |DBFileName|String|-|必填|备份文件名称,该文件名称可根据GetBackupInfo接口获取服务器存储的备份文件列表| ### 14.3接口示例 ` http://yourhost:2390/api/service/CDB.DelBackup?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&DBFileName=20221122.bak&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 14.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 15、CDB.GetStatus ### 15.1接口描述 获取实例状态 ### 15.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 15.3接口示例 ` http://yourhost:2390/api/service/CDB.GetStatus?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 15.4接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":{ "DBSize":0.01, "BackupSpaceSize":0, "LogSize":0, "LogMaxSize":0, "BackupSpaceMaxSize":512, "DBMaxSize":1024 } } ``` # 16、CDB.GetObjectSetting ### 16.1接口描述 获取实例状态 ### 16.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 16.3接口示例 ` http://yourhost:2390/api/service/CDB.GetObjectSetting?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Name=test_1&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584` ### 16.4接口返回成功示例 ```json { "aqid":"", "state":true, "err":{ "code":0, "msg":"success" }, "count":0, "code":0, "msg":"success", "data":{ "Platform":"MySQL", "Name":"mytest", "Password":"a123123a", "DBSize":0.01, "LogSize":0, "BackupSpaceSize":0, "DBMaxSize":1024, "LogMaxSize":0, "ExpDate":20231122, "CDBSavePath":"", "Backups":[ { "FileName":"20221122012141743.bak", "AddTime":"2022-11-22 01:21:43", "IsFromUpload":0, "Size":1879 } ], "BackupSpaceMaxSize":512 } } ``` # 17、CDB.SetPWD ### 17.1接口描述 设置实例登陆密码 ### 17.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| |Password|String|-|必填|登陆密码,由字母+数字+下划线组成,4-12位| ### 17.3接口示例 ` http://yourhost:2390/api/service/CDB.SetPWD?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Password=a123abcd&Name=test_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、CDB.GetConnectionInfo ### 18.1接口描述 获取实例连接信息:主机地址、端口、账号、密码、数据库名 ### 18.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Platform|String|-|必填|数据库类型,当前支持类型:MSSQL、MySQL,参数值必须为支持类型之一| |Name|String|-|必填|实例名称,由字母+数字+下划线组成,4-12位| ### 18.3接口示例 ` http://yourhost:2390/api/service/CDB.GetConnectionInfo?_RPW_Sign=8DACCCA7CF009495D5B37A2E74C4C5B0&_RPW_QueueId=20220908111807684&Platform=MSSQL&Password=a123abcd&Name=test_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":{ "LoginName":"mytest", "DatabaseName":"mytest", "Port":3306, "Host":"156.227.31.38", "Password":"a123123a" } } ```