更新执行器

接口说明

引入增强插件

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

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

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-a1804a3226d
AppName	string	是	应用名称。	test-app
WorkerType	string	否	执行器类型	k8s_service
Workers	string	否	指定机器列表 JSON 格式列表	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	3835AA29-2298-5434-BC53-9CC377CDFD2C
Code	integer	响应码。	200
Message	string	错误信息。	Parameter error: content is null.
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object
WorkId	integer	执行器 ID	1
AppGroupId	long	任务分组 ID。	1
AppType	integer	应用类型	1
WorkerType	string	执行器类型	k8s_service
Workers	string	指定机器列表 JSON 格式列表	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]
FailedService	string	导入失败的 k8s 服务	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]

示例

正常返回示例

JSON格式

{
  "RequestId": "3835AA29-2298-5434-BC53-9CC377CDFD2C",
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "WorkId": 1,
    "AppGroupId": 1,
    "AppType": 1,
    "WorkerType": "k8s_service",
    "Workers": [
      {
        "cluster": "xxxxx",
        "namespace": "xxxxx",
        "service": "xxxxx"
      }
    ],
    "FailedService": [
      {
        "cluster": "xxxxx",
        "namespace": "xxxxx",
        "service": "xxxxx"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2025-10-29	新增 OpenAPI	查看变更详情