All Products
Search
Document Center

SchedulerX:ReadSchedulerxDesignateInfo

Last Updated:Nov 20, 2025

Queries the basic information of specified workers.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ReadSchedulerxDesignateInfoget
*AppGroup
acs:edas:{#regionId}:{#accountId}:namespace/{#Namespace}/JobGroup/{#GroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdlongYes

The job ID. You can obtain the ID on the Tasks page in the SchedulerX console.

368
NamespacestringYes

The unique identifier (UID) of the namespace. You can obtain the namespace UID on the Namespaces 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
GroupIdstringYes

The ID of the application. You can obtain the application ID on the Applications page in the SchedulerX console.

test.defalutGroup
RegionIdstringYes

The ID of the region.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code returned.

200
Messagestring

The error message returned only if an error occurs.

jobId=xxx is not existed
RequestIdstring

The request ID.

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

Indicates whether the request was successful.

true
Dataobject
DesignateDetailVosarray<object>
designateDetailVoobject
Checkedboolean

Indicates whether the workers are specified.

  • true: The workers are specified.
  • false: The workers are not specified.
true
Metricsobject

The metric values.

SharePoolAvailableSizeinteger

The number of available resources in the shared pool.

72
Heap1Usagedouble

The most recent value of heap memory usage.

0.06072874493927125
DiskUsagedouble

The disk usage.

0.19142496008515167
CpuProcessorsinteger

The number of available CPU processors.

1
Heap1Useddouble

The most recent value of used heap memory in MB.

14
CpuLoad1double

The most recent value of CPU workload.

0
CpuLoad5double

The average of the latest five values of CPU workload.

0
ExecCountlong

The number of job executions.

56
SharePoolQueueSizeinteger

The queue size in the shared pool.

1
HeapMaxinteger

The maximum heap memory in MB.

500
DiskUsedinteger

The used disk space in MB.

148
DiskMaxinteger

The total disk capacity in MB.

1024
Heap5Usagedouble

The average of the latest five values of heap memory usage.

0.06477732793522267
Versionstring

The version of the workers.

1.12.5
Sizeinteger

The number of workers.

1
Busystring

The status of the workers. Valid values:

  • FREE: idle.
  • LOAD5_BUSY: The average of the latest five values of CPU workload is too high.
  • HEAP5_BUSY: The average of the latest five values of heap memory usage is too high.
  • DISK_BUSY: The disk usage is too high.
FREE
Offlineboolean

Indicates whether the workers are offline.

fasle
Starterstring

The startup method of the workers.

pod
Keystring

The information returned based on the value of the DesignateType parameter.

  • If you set the DesignateType parameter to 2, the tags of the workers are returned.
  • If you set the DesignateType parameter to 1, the IP addresses of the workers are returned.
10.52.169.25
DesignateTypeinteger

The information type of the specified workers.

  • 1: the IP address of the specified workers.
  • 2: the tags of the specified workers.
Note The default value of the DesignateType parameter is 1.
1
Transferableboolean

Indicates whether to enable failover for the workers. If you set this parameter to true, the job is scheduled to other workers when the specified workers go offline.

  • true: enables failover for the workers.
  • false: disables failover for the workers.
Note The default value of the Transferable parameter is false.
true
AccessDeniedDetailobject

The access denial details.

AuthActionstring

The authentication operation.

edas:ReadSchedulerxDesignateInfo
AuthPrincipalDisplayNamestring

The principal name.

209312833131416xxx
AuthPrincipalOwnerIdstring

The principal account.

1827811800526xxx
AuthPrincipalTypestring

The principal type.

SubUser
EncodedDiagnosticMessagestring

The encoded diagnostic message.

AQFn/cLPZ/3Cz0YxQkZBMjVGLTY0REUtNTlGNS05NzUwLTgyMUE4M0MwMTFDRQ==
NoPermissionTypestring

The permission denial type.

ImplicitDeny
PolicyTypestring

The policy type.

AccountLevelIdentityBasedPolicy

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "jobId=xxx is not existed",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Data": {
    "DesignateDetailVos": [
      {
        "Checked": true,
        "Metrics": {
          "SharePoolAvailableSize": 72,
          "Heap1Usage": 0.06072874493927125,
          "DiskUsage": 0.19142496008515167,
          "CpuProcessors": 1,
          "Heap1Used": 14,
          "CpuLoad1": 0,
          "CpuLoad5": 0,
          "ExecCount": 56,
          "SharePoolQueueSize": 1,
          "HeapMax": 500,
          "DiskUsed": 148,
          "DiskMax": 1024,
          "Heap5Usage": 0.06477732793522267
        },
        "Version": "1.12.5",
        "Size": 1,
        "Busy": "FREE",
        "Offline": true,
        "Starter": "pod",
        "Key": "10.52.169.25"
      }
    ],
    "DesignateType": 1,
    "Transferable": true
  },
  "AccessDeniedDetail": {
    "AuthAction": "edas:ReadSchedulerxDesignateInfo",
    "AuthPrincipalDisplayName": "209312833131416xxx",
    "AuthPrincipalOwnerId": "1827811800526xxx",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFn/cLPZ/3Cz0YxQkZBMjVGLTY0REUtNTlGNS05NzUwLTgyMUE4M0MwMTFDRQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "AccountLevelIdentityBasedPolicy"
  }
}

Error codes

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