接口说明

引入增强插件

在pom.xml文件中添加增强插件以提升 Executor 的能力。

注意：请确保该插件在 pom 中放置在xxl-job-core 依赖的上方。

详细信息请参考：插件版本说明文档

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID	xxljob-a1804a3226d
AppName	string	是	应用名称。	test-app

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	39938688-0BAB-5AD8-BF02-F4910FAC7589
Code	integer	响应码。	200
Message	string	错误信息。	not support query script history, please upgrade engine version to 2.2.2+
Success	boolean	是否成功。	true
Data	object	查询结果。
Config	string	数据集成同步解决方案任务默认的全局配置内容（即对不同 DDL 消息类型配置的默认处理策略）。示例如下： {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"} DDL 消息类型如下： RENAMECOLUMN：重命名列。 DROPTABLE：删除表。 CREATETABLE：新建表。 MODIFYCOLUMN：修改列类型。 TRUNCATETABLE：清空表。 DROPCOLUMN：删除列。 ADDCOLUMN：新增列。 RENAMETABLE：重命名表。 DataWorks 收到对应类型的 DDL 消息时，处理策略如下： WARNING：直接丢弃该消息，同时会在实时同步日志中记录告警信息，指明该消息因执行出错被丢弃。 IGNORE：直接丢弃该消息，不再向目的端数据源发送。 CRITICAL：实时同步任务直接显示出错状态并终止运行。 NORMAL：将相应消息继续下发给目的端数据源，由目的端数据源来处理。因为不同目的端数据源对 DDL 消息处理策略可能会不同，因此 DataWorks 只执行转发操作。	[{"cluster":"c2c619b5129e0400fa3df263b249622aa","namespace":"default","service":"xxljob-http-demo1-svc"}]
ExecutorType	string	执行器类型	k8s_service

示例

正常返回示例

JSON格式

{
  "RequestId": "39938688-0BAB-5AD8-BF02-F4910FAC7589",
  "Code": 200,
  "Message": "not support query script history, please upgrade engine version to 2.2.2+",
  "Success": true,
  "Data": {
    "Config": "[{\"cluster\":\"c2c619b5129e0400fa3df263b249622aa\",\"namespace\":\"default\",\"service\":\"xxljob-http-demo1-svc\"}]",
    "ExecutorType": "k8s_service"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
500	InternalError	InternalError: %s.	系统内部错误：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。