ListExecutors-阿里云帮助中心

Gets a list of executors.

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-b6ec1xxxx
AppName	string	Yes	The application name.	test-app
JobId	integer	No	The job ID.	74
Label	string	No	The label used to filter executors.	gray

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	A unique identifier for the request, used for troubleshooting.	5EF879D0-3B43-5AD1-9BF7-52418F9C5E73
Code	integer	The response code.	200
Message	string	The error message, if any.	Parameter check error
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Data	array<object>
	object
Address	string	The address.	http://192.168.1.10:9999/
Ip	string	The IP address.	192.168.1.10
Port	integer	The port.	9999
Label	string	The label of the executor.	gray
Version	string	The version of the executor.	2.0.2
Online	boolean	Indicates whether the client is online.	true
IsDesignated	boolean	Indicates whether the executor is designated.	true
Weight	integer	The weight of the executor.	1
Status	string

Examples

Success response

JSON format

{
  "RequestId": "5EF879D0-3B43-5AD1-9BF7-52418F9C5E73",
  "Code": 200,
  "Message": "Parameter check error",
  "Success": true,
  "Data": [
    {
      "Address": "http://192.168.1.10:9999/",
      "Ip": "192.168.1.10",
      "Port": 9999,
      "Label": "gray",
      "Version": "2.0.2",
      "Online": true,
      "IsDesignated": true,
      "Weight": 1,
      "Status": ""
    }
  ]
}

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.