ListLables-阿里云帮助中心

Retrieves a list of labels for an Executor.

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.	15

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	A unique identifier for the request. Use this ID to troubleshoot issues.	9079A828-9138-50F1-801E-F2BC3D222A06
Code	integer	The response code.	200
Message	string	The response message.	Parameter check error
Success	boolean	Indicates whether the request succeeded. true: The request was successful. false: The request failed.	true
Data	array<object>	The returned list of labels.
	object	An object containing the details of a label.
Label	string	The label.	gray
Online	boolean	Indicates whether the Executor is online.	true
Size	integer	The number of machines with this label.	2
IsDesignated	boolean	Indicates whether the label is designated.	true

Examples

Success response

JSON format

{
  "RequestId": "9079A828-9138-50F1-801E-F2BC3D222A06",
  "Code": 200,
  "Message": "Parameter check error",
  "Success": true,
  "Data": [
    {
      "Label": "gray",
      "Online": true,
      "Size": 2,
      "IsDesignated": true
    }
  ]
}

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.