All Products
Search
Document Center

SchedulerX:GetWorkerList

Last Updated:Dec 10, 2024

Obtains the list of workers that are connected to an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadSchedulerxAppGroupQueryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
GroupIdstringYes

The ID of the permission group.

usercenter
NamespacestringYes

The ID of the namespace. You can obtain the namespace ID on the Namespace page in the SchedulerX console.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestringNo

The source of the namespace. This parameter is required only for a special third party.

schedulerx

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

4F68ABED-AC31-4412-9297-D9A8F0401108****
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

Cannot find product according to your domain.
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
Dataobject

The job information.

WorkerInfosarray<object>

The worker information.

WorkerInfoobject
Ipstring

The IP address of the worker.

30.225.16.49
Portinteger

The port number of the worker.

60831
WorkerAddressstring

The address of the worker. The address is in the format of ${worker_id}@${worker_ip}:${worker_port}.

030225016049_11734_25917@30.225.16.49:60831
Labelstring

The label of the worker.

gray
Versionstring

The version of the worker.

1.3.4
Starterstring

The startup method of the worker.

springboot

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108****",
  "Code": 200,
  "Message": "Cannot find product according to your domain.",
  "Success": true,
  "Data": {
    "WorkerInfos": [
      {
        "Ip": "30.225.16.49",
        "Port": 60831,
        "WorkerAddress": "030225016049_11734_25917@30.225.16.49:60831",
        "Label": "gray",
        "Version": "1.3.4",
        "Starter": "springboot"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-18The response structure of the API has changedView Change Details
2022-12-26The internal configuration of the API is changed, but the call is not affectedView Change Details
2021-12-30Add OperationView Change Details