4.4.1_dtle_http_api.md

dtle 3.x HTTP API 说明

dtle 3.x 根据业务功能提供了一套HTTP API（开启方式见"节点配置"，api_addr），可与dtle UI配套使用。

本节API示例默认使用swagger UI调用。

通过swagger UI查看接口文档

访问http://{dtle ip}:8190/swagger/index.html通过swagger UI查看接口文档，打开界面如下：

通过swagger UI调用API

除了使用curl命令外，还可以通过swagger UI界面调用API，具体步骤如下：

1 点击"Try it out"，进入调试模式

2 填写请求参数后点击"Execute"调用API

3 查看响应：

4 由于用户校验功能限制，大多数接口调用需要在header中携带登录成功返回的token，在swagger页面可点击swagger页面顶部的Authorize按钮，将token填入Value的文本框中，swagger页面中其他接口即可正常使用

dtle API Docs

This is a sample server for dev.

Version: 2.0

Security

ApiKeyAuth

apiKey	API Key
In	header
Name	Authorization

/v2/database/columns

GET

Description:

list columns of database source instance.

Parameters

Name	Located in	Description	Required	Schema
host	query	database host	Yes	string
port	query	database port	Yes	integer
user	query	database user	Yes	string
password	query	database password	Yes	string
database_type	query	database_type	Yes	string
service_name	query	database service_name	No	string
schema	query	database schema	Yes	string
table	query	database table	Yes	string
character_set	query	database character set	No	string
is_password_encrypted	query	indecate that database password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ListColumnsRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/database/instance_connection

GET

Description:

connect to database instance.

Parameters

Name	Located in	Description	Required	Schema
host	query	database host	Yes	string
port	query	database port	Yes	integer
user	query	database user	Yes	string
password	query	database password	Yes	string
database_type	query	database_type	Yes	string
service_name	query	database service_name	No	string
is_password_encrypted	query	indecate that database password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ConnectionRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/database/schemas

GET

Description:

list schemas of database source instance.

Parameters

Name	Located in	Description	Required	Schema
database_type	query	database_type	Yes	string
host	query	database host	Yes	string
port	query	database port	Yes	integer
user	query	database user	Yes	string
password	query	database password	Yes	string
service_name	query	database service_name	No	string
character_set	query	database character set	No	string
is_password_encrypted	query	indecate that database password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ListSchemasRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/gtid

GET

Description:

get src task current gtid.

Parameters

Name	Located in	Description	Required	Schema
job_id	query	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.JobGtidResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/create

POST

Description:

create migration job.

Parameters

Name	Located in	Description	Required	Schema
migration_job_config	body	migration job config	Yes	models.CreateOrUpdateMysqlToMysqlJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToMysqlJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/delete

POST

Description:

delete migration job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.DeleteJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/detail

GET

Description:

get migration job detail.

Parameters

Name	Located in	Description	Required	Schema
job_id	query	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.MysqlToMysqlJobDetailRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/pause

POST

Description:

pause migration job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.PauseJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/resume

POST

Description:

resume migration job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ResumeJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/reverse

POST

Description:

reverse migration Job

Parameters

Name	Located in	Description	Required	Schema
reverse_config	body	reverse config config	Yes	models.ReverseJobReq

Responses

Code	Description	Schema
200	OK	models.ReverseJobResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/reverse_start

POST

Summary:

start reverse-init job

Description:

Start Reverse Job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ReverseStartRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/migration/update

POST

Description:

update migration job.

Parameters

Name	Located in	Description	Required	Schema
migration_job_config	body	migration job config	Yes	models.CreateOrUpdateMysqlToMysqlJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToMysqlJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/reverse_start

POST

Summary:

start reverse-init job

Description:

Finish Job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ReverseStartRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/create

POST

Description:

create subscription job.

Parameters

Name	Located in	Description	Required	Schema
subscription_job_config	body	subscription job config	Yes	models.CreateOrUpdateMysqlToKafkaJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToKafkaJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/delete

POST

Description:

delete subscription job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.DeleteJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/detail

GET

Description:

get subscription job detail.

Parameters

Name	Located in	Description	Required	Schema
job_id	query	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.MysqlToKafkaJobDetailRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/pause

POST

Description:

pause subscription job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.PauseJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/resume

POST

Description:

resume subscription job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ResumeJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/subscription/update

POST

Description:

update subscription job.

Parameters

Name	Located in	Description	Required	Schema
subscription_job_config	body	subscription job config	Yes	models.CreateOrUpdateMysqlToKafkaJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToKafkaJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/create

POST

Description:

create sync job.

Parameters

Name	Located in	Description	Required	Schema
sync_job_config	body	sync job config	Yes	models.CreateOrUpdateMysqlToMysqlJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToMysqlJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/delete

POST

Description:

delete sync job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.DeleteJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/detail

GET

Description:

get sync job detail.

Parameters

Name	Located in	Description	Required	Schema
job_id	query	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.MysqlToMysqlJobDetailRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/pause

POST

Description:

pause sync job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.PauseJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/resume

POST

Description:

resume sync job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ResumeJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/reverse

POST

Description:

reverse sync Job

Parameters

Name	Located in	Description	Required	Schema
reverse_config	body	reverse config config	Yes	models.ReverseJobReq

Responses

Code	Description	Schema
200	OK	models.ReverseJobResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/reverse_start

POST

Summary:

start reverse-init job

Description:

Start Reverse Job.

Parameters

Name	Located in	Description	Required	Schema
job_id	formData	job id	Yes	string

Responses

Code	Description	Schema
200	OK	models.ReverseStartRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/job/sync/update

POST

Description:

update sync job.

Parameters

Name	Located in	Description	Required	Schema
sync_job_config	body	sync job config	Yes	models.CreateOrUpdateMysqlToMysqlJobParamV2

Responses

Code	Description	Schema
200	OK	models.CreateOrUpdateMysqlToMysqlJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/jobs/migration

GET

Description:

get job list.

Parameters

Name	Located in	Description	Required	Schema
filter_job_id	query	filter job id	No	string
filter_job_src_ip	query	filter job src ip	No	string
filter_job_src_port	query	filter job src port	No	string
filter_job_dest_ip	query	filter job dest ip	No	string
filter_job_dest_port	query	filter job dest port	No	string
filter_job_status	query	filter job status	No	string
order_by	query	order by	No	string

Responses

Code	Description	Schema
200	OK	models.JobListRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/jobs/subscription

GET

Description:

get subscription job list.

Parameters

Name	Located in	Description	Required	Schema
filter_job_id	query	filter job id	No	string
filter_job_src_ip	query	filter job src ip	No	string
filter_job_src_port	query	filter job src port	No	string
filter_job_dest_ip	query	filter job dest ip	No	string
filter_job_dest_port	query	filter job dest port	No	string
filter_job_status	query	filter job status	No	string
order_by	query	order by	No	string

Responses

Code	Description	Schema
200	OK	models.JobListRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/jobs/sync

GET

Description:

get sync job list.

Parameters

Name	Located in	Description	Required	Schema
filter_job_id	query	filter job id	No	string
filter_job_src_ip	query	filter job src ip	No	string
filter_job_src_port	query	filter job src port	No	string
filter_job_dest_ip	query	filter job dest ip	No	string
filter_job_dest_port	query	filter job dest port	No	string
filter_job_status	query	filter job status	No	string
order_by	query	order by	No	string

Responses

Code	Description	Schema
200	OK	models.JobListRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/log/level

POST

Description:

reload log level dynamically.

Parameters

Name	Located in	Description	Required	Schema
dtle_log_level	formData	dtle log level	Yes	string

Responses

Code	Description	Schema
200	OK	models.UpdataLogLevelRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/login

POST

Summary:

user loginV2

Description:

user login

Parameters

Name	Located in	Description	Required	Schema
user	body	user login request	Yes	models.UserLoginReqV2

Responses

Code	Description	Schema
200	OK	models.GetUserLoginResV2

/v2/login/captcha

POST

Summary:

create base64Captcha

Description:

create base64Captcha

Parameters

Name	Located in	Description	Required	Schema
captcha_type	formData	captcha type	Yes	string

Responses

Code	Description	Schema
200	OK	models.CaptchaRespV2

/v2/loginWithoutVerifyCode

POST

Summary:

user LoginWithoutVerifyCodeV2

Description:

user login Without Verify Code

Parameters

Name	Located in	Description	Required	Schema
user	body	user login request	Yes	models.LoginWithoutVerifyCodeReqV2

Responses

Code	Description	Schema
200	OK	models.GetUserLoginResV2

/v2/monitor/task

GET

Description:

get progress of tasks within an allocation.

Parameters

Name	Located in	Description	Required	Schema
allocation_id	query	allocation id	Yes	string
task_name	query	task name	Yes	string
nomad_http_address	query	nomad_http_address is the http address of the nomad that the target dtle is running with. ignore it if you are not sure what to provide	No	string

Responses

Code	Description	Schema
200	OK	models.GetTaskProgressRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/mysql/columns

GET

Description:

list columns of mysql source instance.

Parameters

Name	Located in	Description	Required	Schema
mysql_host	query	mysql host	Yes	string
mysql_port	query	mysql port	Yes	string
mysql_user	query	mysql user	Yes	string
mysql_password	query	mysql password	Yes	string
mysql_schema	query	mysql schema	Yes	string
mysql_table	query	mysql table	Yes	string
mysql_character_set	query	mysql character set	No	string
is_mysql_password_encrypted	query	indecate that mysql password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ListColumnsRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/mysql/instance_connection

GET

Description:

connect to mysql instance.

Parameters

Name	Located in	Description	Required	Schema
mysql_host	query	mysql host	Yes	string
mysql_port	query	mysql port	Yes	string
mysql_user	query	mysql user	Yes	string
mysql_password	query	mysql password	Yes	string
is_mysql_password_encrypted	query	indecate that mysql password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ConnectionRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/mysql/schemas

GET

Description:

list schemas of mysql source instance.

Parameters

Name	Located in	Description	Required	Schema
mysql_host	query	mysql host	Yes	string
mysql_port	query	mysql port	Yes	string
mysql_user	query	mysql user	Yes	string
mysql_password	query	mysql password	Yes	string
mysql_character_set	query	mysql character set	No	string
is_mysql_password_encrypted	query	indecate that mysql password is encrypted or not	No	boolean

Responses

Code	Description	Schema
200	OK	models.ListSchemasRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/nodes

GET

Description:

get node list.

Responses

Code	Description	Schema
200	OK	models.NodeListRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/role/create

POST

Description:

create Role.

Parameters

Name	Located in	Description	Required	Schema
Role	body	Role info	Yes	models.CreateRoleReqV2

Responses

Code	Description	Schema
200	OK	models.CreateRoleRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/role/delete

POST

Description:

delete Role.

Parameters

Name	Located in	Description	Required	Schema
tenant	formData	tenant	Yes	string
name	formData	role name	Yes	string

Responses

Code	Description	Schema
200	OK	models.DeleteRoleRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/role/list

GET

Description:

get role list.

Parameters

Name	Located in	Description	Required	Schema
filter_tenant	query	filter tenant	No	string

Responses

Code	Description	Schema
200	OK	models.RoleListResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/role/update

POST

Description:

update Role info.

Parameters

Name	Located in	Description	Required	Schema
Role	body	Role info	Yes	models.UpdateRoleReqV2

Responses

Code	Description	Schema
200	OK	models.UpdateRoleRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/tenant/list

GET

Description:

get tenant list.

Responses

Code	Description	Schema
200	OK	models.TenantListResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/create

POST

Description:

create user.

Parameters

Name	Located in	Description	Required	Schema
user	body	user info	Yes	models.CreateUserReqV2

Responses

Code	Description	Schema
200	OK	models.CreateUserRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/current_user

GET

Description:

get current user.

Responses

Code	Description	Schema
200	OK	models.CurrentUserResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/delete

POST

Description:

delete user.

Parameters

Name	Located in	Description	Required	Schema
tenant	formData	tenant	Yes	string
username	formData	user name	Yes	string

Responses

Code	Description	Schema
200	OK	models.DeleteUserRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/list

GET

Description:

get user list.

Parameters

Name	Located in	Description	Required	Schema
filter_username	query	filter user name	No	string
filter_tenant	query	filter tenant	No	string

Responses

Code	Description	Schema
200	OK	models.UserListResp

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/list_action

GET

Description:

list user action.

Responses

Code	Description	Schema
200	OK	models.ListActionRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/reset_password

POST

Description:

reset user password.

Parameters

Name	Located in	Description	Required	Schema
user	body	reset user password	Yes	models.ResetPasswordReqV2

Responses

Code	Description	Schema
200	OK	models.ResetPasswordRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/user/update

POST

Description:

update user info.

Parameters

Name	Located in	Description	Required	Schema
user	body	user info	Yes	models.UpdateUserReqV2

Responses

Code	Description	Schema
200	OK	models.UpdateUserRespV2

Security

Security Schema	Scopes
ApiKeyAuth

/v2/validation/job

POST

Description:

validate job config.

Parameters

Name	Located in	Description	Required	Schema
job_config	body	validate job config	Yes	models.ValidateJobReqV2

Responses

Code	Description	Schema
200	OK	models.ValidateJobRespV2

Security

Security Schema	Scopes
ApiKeyAuth

Models

common.JobListItemV2

Name	Type	Description	Required
dst_addr_list	[ string ]		No
dst_database_type	string		No
job_create_time	string		No
job_id	string		No
job_status	string		No
job_steps	[ common.JobStep ]		No
src_addr_list	[ string ]		No
src_database_type	string		No
topic	string		No
user	string		No

common.JobStep

Name	Type	Description	Required
job_create_time	string		No
step_name	string		No
step_schedule	number		No
step_status	string		No

common.Role

Name	Type	Description	Required
authority	string		No
name	string		No
object_type	string		No
object_users	[ string ]		No
tenant	string		No

common.User

Name	Type	Description	Required
create_time	string		No
password	string		No
remark	string		No
role	string		No
tenant	string		No
username	string		No

models.BasicTaskProfile

Name	Type	Description	Required
configuration	models.Configuration		No
connection_info	models.ConnectionInfo		No
dtle_node_infos	[ models.DtleNodeInfo ]		No
job_base_info	models.JobBaseInfo		No
replicate_do_db	[ models.DataSourceConfig ]		No
replicate_ignore_db	[ models.DataSourceConfig ]		No

models.BinlogValidation

Name	Type	Description	Required
error	string	Error is a string version of any error that may have occured	No
validated	boolean		No

models.BufferStat

Name	Type	Description	Required
applier_tx_queue_size	integer		No
binlog_event_queue_size	integer		No
extractor_tx_queue_size	integer		No
send_by_size_full	integer		No
send_by_timeout	integer		No

models.ButtonItem

Name	Type	Description	Required
action	string		No
text_cn	string		No
text_en	string		No
uri	string		No

models.CaptchaRespV2

Name	Type	Description	Required
data_scheme	string		No
id	string		No
message	string		No

models.Configuration

Name	Type	Description	Required
dst_config	models.DstConfig		No
fail_over	boolean		No
retry_times	integer		No
src_config	models.SrcConfig		No

models.ConnectionInfo

Name	Type	Description	Required
dst_data_base	models.DatabaseConnectionConfig		No
dst_kafka	models.KafkaDestTaskConfig		No
src_data_base	models.DatabaseConnectionConfig		No

models.ConnectionRespV2

Name	Type	Description	Required
message	string		No

models.ConnectionValidation

Name	Type	Description	Required
error	string	Error is a string version of any error that may have occured	No
validated	boolean		No

models.CreateOrUpdateMysqlToKafkaJobParamV2

Name	Type	Description	Required
dest_task	models.KafkaDestTaskConfig		Yes
failover	boolean	failover default:true	No
is_password_encrypted	boolean		No
job_id	string		Yes
retry	integer		No
src_task	models.SrcTaskConfig		Yes
task_step_name	string		No

models.CreateOrUpdateMysqlToKafkaJobRespV2

Name	Type	Description	Required
dest_task	models.KafkaDestTaskConfig		Yes
eval_create_index	integer		No
failover	boolean	failover default:true	No
is_password_encrypted	boolean		No
job_id	string		Yes
job_modify_index	integer		No
message	string		No
retry	integer		No
src_task	models.SrcTaskConfig		Yes
task_step_name	string		No

models.CreateOrUpdateMysqlToMysqlJobParamV2

Name	Type	Description	Required
dest_task	models.DestTaskConfig		Yes
failover	boolean		No
is_password_encrypted	boolean		No
job_id	string		Yes
retry	integer		No
reverse	boolean		No
src_task	models.SrcTaskConfig		Yes
task_step_name	string		No

models.CreateOrUpdateMysqlToMysqlJobRespV2

Name	Type	Description	Required
dest_task	models.DestTaskConfig		Yes
eval_create_index	integer		No
failover	boolean		No
is_password_encrypted	boolean		No
job_id	string		Yes
job_modify_index	integer		No
message	string		No
retry	integer		No
reverse	boolean		No
src_task	models.SrcTaskConfig		Yes
task_step_name	string		No

models.CreateRoleReqV2

Name	Type	Description	Required
authority	string		No
name	string		No
operation_object_type	string		No
operation_users	[ string ]		No
tenant	string		No

models.CreateRoleRespV2

Name	Type	Description	Required
message	string		No

models.CreateUserReqV2

Name	Type	Description	Required
pass_word	string		Yes
remark	string		No
role	string		Yes
tenant	string		Yes
username	string		Yes

models.CreateUserRespV2

Name	Type	Description	Required
message	string		No

models.CurrentCoordinates

Name	Type	Description	Required
file	string		No
gtid_set	string		No
position	integer		No
read_master_log_pos	integer		No
relay_master_log_file	string		No
retrieved_gtid_set	string		No

models.CurrentUserResp

Name	Type	Description	Required
current_user	common.User		No
message	string		No

models.DataSourceConfig

Name	Type	Description	Required
table_schema	string		No
table_schema_regex	string		No
table_schema_rename	string		No
tables	[ models.TableConfig ]		No

models.DatabaseConnectionConfig

Name	Type	Description	Required
database_type	string		Yes
host	string		Yes
password	string		Yes
port	integer		Yes
service_name	string		No
user	string		Yes

models.DelayCount

Name	Type	Description	Required
num	integer		No
time	integer		No

models.DeleteJobRespV2

Name	Type	Description	Required
message	string		No

models.DeleteRoleRespV2

Name	Type	Description	Required
message	string		No

models.DeleteUserRespV2

Name	Type	Description	Required
message	string		No

models.DestTaskConfig

Name	Type	Description	Required
connection_config	models.DatabaseConnectionConfig		Yes
database_type	string		No
mysql_dest_task_config	models.MysqlDestTaskConfig		No
node_id	string		No
task_name	string		Yes

models.DstConfig

Name	Type	Description	Required
mysql_dest_task_config	models.MysqlDestTaskConfig		No

models.DtleNodeInfo

Name	Type	Description	Required
data_source	string		No
node_addr	string		No
node_id	string		No
source	string		No

models.GetTaskProgressRespV2

Name	Type	Description	Required
message	string		No
tasks_status	models.TaskProgress		No

models.GetUserLoginResV2

Name	Type	Description	Required
data	models.UserLoginResV2		No
message	string		No

models.GtidModeValidation

Name	Type	Description	Required
error	string	Error is a string version of any error that may have occured	No
validated	boolean		No

models.JobBaseInfo

Name	Type	Description	Required
delay	integer		No
job_create_time	string		No
job_id	string		No
job_status	string		No
job_steps	[ common.JobStep ]		No
subscription_topic	string		No

models.JobGtidResp

Name	Type	Description	Required
gtid	string		No
message	string		No

models.JobListRespV2

Name	Type	Description	Required
jobs	[ common.JobListItemV2 ]		No
message	string		No

models.KafkaDestTaskConfig

Name	Type	Description	Required
kafka_broker_addrs	[ string ]		Yes
kafka_topic	string		Yes
message_group_max_size	integer		No
message_group_timeout	integer		No
node_id	string		No
task_name	string		Yes

models.ListActionRespV2

Name	Type	Description	Required
authority	[ models.MenuItem ]		No
message	string		No

models.ListColumnsRespV2

Name	Type	Description	Required
columns	[ string ]		No
message	string		No

models.ListSchemasRespV2

Name	Type	Description	Required
message	string		No
schemas	[ models.SchemaItem ]		No

models.LoginWithoutVerifyCodeReqV2

Name	Type	Description	Required
password	string		Yes
tenant	string		Yes
username	string		Yes

models.MenuItem

Name	Type	Description	Required
admin_only	boolean		No
id	integer		No
menu_level	integer		No
menu_url	string		No
name	string		No
operations	[ models.ButtonItem ]		No
parent_id	integer		No
text_cn	string		No
text_en	string		No

models.MysqlDestTaskConfig

Name	Type	Description	Required
dependency_history_size	integer		No
parallel_workers	integer		No
use_my_sql_dependency	boolean		No

models.MysqlSrcTaskConfig

Name	Type	Description	Required
auto_gtid	boolean		No
binlog_relay	boolean		No
expand_syntax_support	boolean		No
gtid	string		No
wait_on_job	string		No

models.MysqlTaskValidationReport

Name	Type	Description	Required
binlog_validation	models.BinlogValidation		No
connection_validation	models.ConnectionValidation		No
gtid_mode_validation	models.GtidModeValidation		No
privileges_validation	models.PrivilegesValidation		No
server_id_validation	models.ServerIDValidation		No
task_name	string		No

models.MysqlToKafkaJobDetailRespV2

Name	Type	Description	Required
basic_task_profile	models.BasicTaskProfile		No
message	string		No
task_logs	[ models.TaskLog ]		No

models.MysqlToMysqlJobDetailRespV2

Name	Type	Description	Required
basic_task_profile	models.BasicTaskProfile		No
message	string		No
task_logs	[ models.TaskLog ]		No

models.NatsMessageStatistics

Name	Type	Description	Required
in_bytes	integer		No
in_messages	integer		No
out_bytes	integer		No
out_messages	integer		No
reconnects	integer		No

models.NodeListItemV2

Name	Type	Description	Required
datacenter	string		No
dtle_version	string		No
leader	boolean		No
member	boolean		No
node_address	string		No
node_id	string		No
node_name	string		No
node_status	string		No
node_status_description	string		No
nomad_version	string		No

models.NodeListRespV2

Name	Type	Description	Required
message	string		No
nodes	[ models.NodeListItemV2 ]		No

models.OracleSrcTaskConfig

Name	Type	Description	Required
scn	integer		No

models.PauseJobRespV2

Name	Type	Description	Required
message	string		No

models.PrivilegesValidation

Name	Type	Description	Required
error	string	Error is a string version of any error that may have occured	No
validated	boolean		No

models.ResetPasswordReqV2

Name	Type	Description	Required
current_user_password	string		Yes
password	string		Yes
tenant	string		Yes
username	string		Yes

models.ResetPasswordRespV2

Name	Type	Description	Required
message	string		No

models.ResumeJobRespV2

Name	Type	Description	Required
message	string		No

models.ReverseConfig

Name	Type	Description	Required
dest_user	string		No
dst_pwd	string		No
is_mysql_password_encrypted	boolean		No
src_pwd	string		No
src_user	string		No

models.ReverseJobReq

Name	Type	Description	Required
job_id	string		Yes
reverse_config	models.ReverseConfig		No

models.ReverseJobResp

Name	Type	Description	Required
message	string		No

models.ReverseStartRespV2

Name	Type	Description	Required
message	string		No

models.RoleListResp

Name	Type	Description	Required
message	string		No
role_list	[ common.Role ]		No

models.SchemaItem

Name	Type	Description	Required
schema_name	string		No
tables	[ models.TableItem ]		No

models.ServerIDValidation

Name	Type	Description	Required
error	string	Error is a string version of any error that may have occured	No
validated	boolean		No

models.SrcConfig

Name	Type	Description	Required
chunk_size	integer		No
drop_table_if_exists	boolean		No
group_max_size	integer		No
group_timeout	integer		No
mysql_src_task_config	models.MysqlSrcTaskConfig		No
oracle_src_task_config	models.OracleSrcTaskConfig		No
repl_chan_buffer_size	integer		No
skip_create_db_table	boolean		No

models.SrcTaskConfig

Name	Type	Description	Required
chunk_size	integer		No
connection_config	models.DatabaseConnectionConfig		Yes
drop_table_if_exists	boolean		No
group_max_size	integer		No
group_timeout	integer		No
mysql_src_task_config	models.MysqlSrcTaskConfig		No
node_id	string		No
oracle_src_task_config	models.OracleSrcTaskConfig		No
repl_chan_buffer_size	integer		No
replicate_do_db	[ models.DataSourceConfig ]		No
replicate_ignore_db	[ models.DataSourceConfig ]		No
skip_create_db_table	boolean		No
task_name	string		Yes

models.TableConfig

Name	Type	Description	Required
column_map_from	[ string ]		No
table_name	string		No
table_regex	string		No
table_rename	string		No
where	string		No

models.TableItem

Name	Type	Description	Required
table_name	string		No

models.TaskEvent

Name	Type	Description	Required
event_type	string		No
message	string		No
setup_error	string		No
time	string		No

models.TaskLog

Name	Type	Description	Required
address	string		No
allocation_id	string		No
node_id	string		No
target	string		No
task_events	[ models.TaskEvent ]		No

models.TaskProgress

Name	Type	Description	Required
ETA	string		No
backlog	string		No
buffer_status	models.BufferStat		No
current_coordinates	models.CurrentCoordinates		No
delay_count	models.DelayCount		No
exec_master_row_count	integer		No
exec_master_tx_count	integer		No
nats_message_status	models.NatsMessageStatistics		No
progress_PCT	string		No
read_master_row_count	integer		No
read_master_tx_count	integer		No
stage	string		No
throughput_status	models.ThroughputStat		No
timestamp	integer		No

models.TenantListResp

Name	Type	Description	Required
message	string		No
tenant_list	[ string ]		No

models.ThroughputStat

Name	Type	Description	Required
num	integer		No
time	integer		No

models.UpdataLogLevelRespV2

Name	Type	Description	Required
dtle_log_level	string		No
message	string		No

models.UpdateRoleReqV2

Name	Type	Description	Required
authority	string		No
name	string		No
operation_object_type	string		No
operation_users	[ string ]		No
tenant	string		No

models.UpdateRoleRespV2

Name	Type	Description	Required
message	string		No

models.UpdateUserReqV2

Name	Type	Description	Required
remark	string		No
role	string		Yes
tenant	string		Yes
username	string		Yes

models.UpdateUserRespV2

Name	Type	Description	Required
message	string		No

models.UserListResp

Name	Type	Description	Required
message	string		No
user_list	[ common.User ]		No

models.UserLoginReqV2

Name	Type	Description	Required
captcha	string		Yes
captcha_id	string		Yes
password	string		Yes
tenant	string		Yes
username	string		Yes

models.UserLoginResV2

Name	Type	Description	Required
token	string		No

models.ValidateJobReqV2

Name	Type	Description	Required
dest_task	models.DestTaskConfig		Yes
is_password_encrypted	boolean		No
job_id	string		Yes
src_task	models.SrcTaskConfig		Yes

models.ValidateJobRespV2

Name	Type	Description	Required
driver_config_validated	boolean	DriverConfigValidated indicates whether the agent validated the driver	No
job_validation_error	string		No
job_validation_warning	string		No
message	string		No
mysql_task_validation_report	[ models.MysqlTaskValidationReport ]	config	No