Updates the configuration of one or more Executors.

Operation description

Add the enhancement plugin

Add the enhancement plugin to the pom.xml file to extend the capabilities of the Executor.

Note: Place this plugin above the xxl-job-core dependency in the pom.xml file.

For more information, see the Plugin Version Description Document.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The Cluster ID.	xxljob-a1804a3226d
AppName	string	Yes	The application name.	test-app
WorkerType	string	No	The Worker type.	k8s_service
Workers	string	No	A JSON-formatted string that contains a list of Workers.	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The Request ID.	3835AA29-2298-5434-BC53-9CC377CDFD2C
Code	integer	The response code.	200
Message	string	The returned error message.	Parameter error: content is null.
Success	boolean	Indicates whether the API call was successful. true: The call was successful. false: The call failed.	true
Data	object	The returned data.
WorkId	integer	The Worker ID.	1
AppGroupId	integer	The Application Group ID.	1
AppType	integer	The Application type.	1
WorkerType	string	The Worker type.	k8s_service
Workers	string	A JSON-formatted string that contains a list of Workers.	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]
FailedService	string	The Kubernetes services that failed to import.	[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]

Examples

Success response

JSON format

{
  "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\"}]"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.