菜单

添加实例

下载

接口地址:/webapi/db/createInstance

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

MySQL-PostgreSQL-添加实例

请求示例:

javascript 复制代码

{
  "requestId": "",
  "agentType": 0,
  "instanceName": "",
  "osUserName": "",
  "dbUserName": "",
  "dbPassword": "",
  "backupMethod": 0,
  "binDirectory": "",
  "logDirectory": "",
  "configFile": "",
  "socketFile": "",
  "clientId": 0,
  "backPlanType": 0,
  "customPlan": 0,
  "planGroupId": 0,
  "containerGroupId": 0,
  "port": "",
  "maintenanceDB": "",
  "libDirectory": "",
  "archiveDirectory": "",
  "xtracbackupBinDirectory": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
databaseInstanceForm	DatabaseInstanceForm	body	true	DatabaseInstanceForm	DatabaseInstanceForm
requestId	请求ID	body	false	string
agentType	代理类型	body	false	integer(int32)
instanceName	实例名	body	false	string
osUserName	操作系统用户名，字段必传，如果用户没有填则传root	body	false	string
dbUserName	数据库用户名	body	false	string
dbPassword	数据库密码	body	false	string
backupMethod	用户启用XtraBackup则1 否则=2	body		false	integer(int32)
binDirectory	mysql二进制目录（mysql可执行文件的父目录）	body	false	string
logDirectory	mysql二进制目录-mysql可执行文件的父目录	body	false	string
configFile	配置文件全路径	body	false	string
socketFile	mysql socket文件全路径	body	false	string
clientId	客户端ID	body	false	integer(int64)
backPlanType	备份方案 0精简配置(自服务计划) 1高级配置(计划，容器组)	body	false	integer(int32)
customPlan	自服务计划ID 如果backPlanType=0则此id必填，否则填0	body	false	integer(int64)
planGroupId	计划组Id 如果backPlanType=1则此id必填，否则填0	body	false	integer(int64)
containerGroupId	容器组Id 如果backPlanType=1则此id必填，否则填0	body	false	integer(int64)
port	端口数据库类型为PostgreSQL时必填	body	false	string
maintenanceDB	维护数据库数据库类型为PostgreSQL时必填	body	false	string
libDirectory	库目录数据库类型为PostgreSQL时必填	body	false	string
archiveDirectory	归档日志目录	body	false	string
xtracbackupBinDirectory	xtracbackup的二进制目录路，如果未开启则为空	body	false	string

响应状态:

状态码	说明	schema
200	OK	ResponseResultLong

响应参数:

参数名称	参数说明	类型	schema
message	返回状态标记	string
statFlag	返回状态	integer(int32)	integer(int32)
dataInfo	返回的数据	integer(int64)	integer(int64)
dataCount	返回数据条数	integer(int32)	integer(int32)

响应示例:

javascript 复制代码

{
	"message": "操作成功",
	"statFlag": 0,
	"dataInfo": 0,
	"dataCount": 10
}

上一个

羲和

下一个

探寻数据库列表

最近修改: 2024-12-18