# Alibaba Cloud Schedulerx API

> Alibaba Cloud Schedulerx API on Apizie: 62 endpoints (Batch deletes nodes, Deletes routing policies in batches, Disables nodes in a batch, Enables nodes in a batch, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-schedulerx2`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/schedulerx2
- Page: https://www.apizie.tech/api/cloud/aliyun-schedulerx2
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-schedulerx2/openapi.json

Alibaba Cloud OpenAPI for Schedulerx (schedulerx2, version 2019-04-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Batch deletes nodes
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-delete-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The namespace ID of the nodes. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region of the nodes |
| JobIdList | string | yes | The list of node IDs. Separate multiple node IDs with commas (,) (JSON-encoded) |

### Deletes routing policies in batches
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-delete-route-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| JobIdList | string | no | The list of node IDs (JSON-encoded) |

### Disables nodes in a batch
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-disable-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The namespace ID of the nodes. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region to which the nodes belong |
| JobIdList | string | yes | The list of node IDs. Separate multiple node IDs with commas (,) (JSON-encoded) |

### Enables nodes in a batch
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-enable-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The namespace ID of the nodes. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region to which the nodes belong |
| JobIdList | string | yes | The list of node IDs. Separate multiple node IDs with commas (,) (JSON-encoded) |

### Creates an application group and returns the AppKey
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppName | string | yes | The name of the application |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| NamespaceSource | string | no | This parameter is not supported. Leave it empty |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | no | The region ID |
| Description | string | no | The description of the application |
| MaxJobs | integer | no | The maximum number of jobs |
| NamespaceName | string | no | The name of the namespace |
| AppKey | string | no | The AppKey of the application |
| MonitorConfigJson | string | no | The configuration of alert notifications. The following properties are supported: sendChannel, alarmType, and webhookIsAtAll. For more… |
| MonitorContactsJson | string | no | The configuration of alert contacts. You can configure alert contacts and alert contact groups. For more information about this field, see… |
| ScheduleBusyWorkers | string | no | Specifies whether to schedule tasks on busy workers |
| EnableLog | string | no | Specifies whether to enable logging. Valid values: true: Enabled. false: Disabled |
| AppType | integer | no | The application type. Valid values: 1: Common application. 2: Kubernetes application |
| AppVersion | integer | no | The application version. Valid values: 1: Basic Edition. 2: Professional Edition |
| NotificationPolicyName | string | no | The notification policy name |

### Creates a job and returns the job ID
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party systems |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| JobType | string | yes | The job type. Valid values: java python shell go http xxljob dataworks k8s springschedule |
| Name | string | yes | The job name |
| Description | string | no | The job description |
| ExecuteMode | string | yes | The execution mode of the job. Valid values: standalone: standalone execution. broadcast: broadcast execution. parallel: visualized… |
| ClassName | string | no | The full path of the job interface class. This parameter is required and must be set to the full path only when the job type is set to Java |
| Content | string | no | If the job type is python, shell, or k8s, enter the corresponding script content. If the job type is golang, the content format example is… |
| Parameters | string | no | The custom parameters. These parameters can be obtained during runtime |
| MaxConcurrency | integer | no | The maximum number of concurrently running instances. Default value: 1. If the previous instance has not finished running when the next… |
| MaxAttempt | integer | no | The maximum number of retries allowed upon failure. Set this parameter based on your business requirements. Default value: 0 |
| AttemptInterval | integer | no | The retry interval upon failure. Unit: seconds. Default value: 30 |
| PageSize | integer | no | The advanced configuration for parallel grid jobs. The number of subtasks pulled at a time. Default value: 100 |
| ConsumerSize | integer | no | The advanced configuration for parallel grid jobs. The number of execution threads triggered on a single node at a time. Default value: 5 |
| QueueSize | integer | no | The advanced configuration for parallel grid jobs. The maximum cache size of the subtask queue. Default value: 10000 |
| DispatcherSize | integer | no | The advanced configuration for parallel grid jobs. The number of threads used to dispatch subtasks. Default value: 5 |
| TimeType | integer | yes | The scheduling time type. This parameter specifies the scheduling type, not a specific date, time, or timestamp. Valid values: 1: cron. 3:… |
| TimeExpression | string | no | The time expression. Set this parameter based on the selected time type. cron: Enter a standard cron expression. Online verification is… |
| Calendar | string | no | The custom calendar. This parameter is available when the time type is set to cron |
| DataOffset | integer | no | The time offset. Unit: seconds. This parameter is available when the time type is set to cron |
| Timezone | string | no | The time zone |
| TimeoutEnable | string | no | Specifies whether to enable the timeout alert feature. Valid values: true: enables the timeout alert feature. false: disables the timeout… |
| Timeout | integer | no | The timeout threshold. Unit: seconds. Default value: 7200 |
| TimeoutKillEnable | string | no | Specifies whether to enable the timeout termination feature. Valid values: true: enables the timeout termination feature. false: disables… |
| FailEnable | string | no | Specifies whether to enable the failure alert feature. Valid values: true: enables the failure alert feature. false: disables the failure… |
| FailTimes | integer | no | The number of consecutive failures that trigger an alert |
| MissWorkerEnable | string | no | Specifies whether to enable the alert for no available workers. Valid values: true: enables the alert for no available workers. false:… |
| SuccessNoticeEnable | string | no | Specifies whether to enable the success notification feature |
| SendChannel | string | no | The alert notification channel. Valid values: default: the default channel for the application group. sms, mail, phone, webhook: specified… |
| TaskMaxAttempt | integer | no | The advanced configuration for parallel grid jobs. The maximum number of retries allowed for a failed subtask. Default value: 0 |
| TaskAttemptInterval | integer | no | The advanced configuration for parallel grid jobs. The retry interval for a failed subtask. Default value: 0 |
| ContactInfo | string | no | [Deprecated] The contact information of the job (JSON-encoded) |
| Status | integer | no | The job status. Valid values: 0: disabled. 1: enabled. Default value: 1 |
| XAttrs | string | no | The extended attributes. This parameter is required if the job type is k8s. Job task: {"resource":"job"} Shell task:… |
| Priority | integer | no | The job priority. Valid values: 1: low. 5: medium. 10: high. 15: very high |
| StartTime | integer | no | The start timestamp. Unit: milliseconds. The value must be later than the current time. A value of -1 indicates that the job starts… |
| EndTime | integer | no | The expiration timestamp. Unit: milliseconds. The value must be later than the current time and the start time. A value of -1 indicates… |

### Creates a namespace
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Uid | string | no | The namespace UID, which is globally unique. We recommend that you use a UUID generator to create this value |
| Name | string | yes | The namespace name |
| Description | string | no | The namespace description |

### Creates a routing policy
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-route-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Name | string | yes | The Policy Name of the routing policy |
| GroupId | string | yes | The application group ID. You can obtain the ID on the Application Management page in the console |
| JobId | integer | no | The node ID. You can obtain the ID on the Task Management page in the console |
| Type | integer | no | The type of the routing policy. Valid values: 3: Routes traffic based on a specified ratio |
| Status | integer | no | The status of the routing policy. Valid values: 0: Disabled. 1: Enabled |
| StrategyContent | string | no | The JSON string that contains the details of the routing policy. For more information about this field, see Supplementary description of… |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |

### Creates a calendar
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-schedulerx-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |
| MonthDaysContent | string | yes | The months and days |

### Creates a notification policy
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-schedulerx-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| PolicyName | string | yes | The notification policy name |
| Description | string | no | The description of the notification policy |
| ChannelTimeRange | string | yes | The effective period configuration for notification channels. Refer to the supplementary description of ChannelTimeRange in the request… |

### Creates a workflow. The workflow is disabled by default. After you update the directed acyclic graph (DAG),…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/create-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| Name | string | yes | The workflow name |
| Description | string | no | The workflow description |
| TimeType | integer | yes | The time type. The following time types are supported: cron: 1 api: 100 |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. cron: Specify a standard CRON expression, which supports… |
| Timezone | string | no | The time zone |
| MaxConcurrency | integer | no | The maximum number of workflow instances that can run at the same time. Default value: 1. This indicates that if the previous triggered… |

### Deletes an application group
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| DeleteJobs | string | no | Specifies whether to delete the jobs in the application group. Valid values: true: Delete the jobs. false: Do not delete the jobs |

### Deletes a specified node
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The node ID. You can obtain the ID on the Task Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Deletes a namespace
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |

### Deletes a routing policy
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-route-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| JobId | integer | no | The node ID. You can obtain the node ID on the Task Management page in the console |

### Deletes a calendar
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-schedulerx-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |

### Deletes a notification policy
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-schedulerx-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| PolicyName | string | yes | The Policy Name of the notification policy |

### Deletes a specified workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkflowId | integer | yes | The workflow ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | Required only by special third parties |
| GroupId | string | no | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Returns the list of available regions
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |

### Designates workers
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/designate-workers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The UID of the namespace |
| NamespaceSource | string | no | The source of the namespace |
| GroupId | string | yes | The ID of the application group |
| JobId | integer | yes | The ID of the job |
| Transferable | string | yes | Specifies whether failover is enabled |
| DesignateType | integer | yes | The type of designation. Valid values: 1: worker. 2: label |
| Workers | string | no | The list of designated workers in JSON format |
| Labels | string | no | The list of designated `label` values in `json` format |
| RegionId | string | yes | The region ID |

### Disables a specified node
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/disable-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The node ID. You can obtain the ID on the Task Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Disables a specified workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/disable-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkflowId | integer | yes | The workflow ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | Required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Enables a specified node
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/enable-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The node ID. You can obtain the ID on the Task Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Enables a specified workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/enable-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkflowId | integer | yes | The workflow ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | no | The application ID. You can obtain the application ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Triggers a job to run immediately
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/execute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The job ID. You can obtain the ID on the Task Management page in the console |
| InstanceParameters | string | no | The parameters carried by this trigger. The value can be any string. The `processor` code retrieves the value by calling… |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | Required only for special third-party use |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |
| CheckJobStatus | string | no | Specifies whether to check the job status. Valid values: true: The job can be executed only when it is enabled. false: The job can be… |
| DesignateType | integer | no | The type of the designated machine. Valid values: 1: designate a worker. 2: designate a label |
| Worker | string | no | The worker address of the application. Obtain the workerAddress by calling the GetWokerList operation first |
| Label | string | no | The label of the worker |

### Triggers an immediate run of a workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/execute-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| WorkflowId | integer | yes | The workflow ID |
| InstanceParameters | string | no | The dynamic parameters of the workflow instance. The value cannot exceed 1,000 bytes |

### Retrieves an application group
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GroupId | string | yes | The application ID. You can obtain the ID from the Application Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the ID from the Namespace page in the console |
| RegionId | string | no | The region ID |

### Retrieves the details of a specified job, which is typically used to update the job
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-job-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The job ID. You can obtain the job ID on the Job Management page in the console |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party integrations |
| RegionId | string | yes | The region ID |
| JobName | string | no | The job name |

### Retrieves the details of a task instance, including its status and progress
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-job-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID from the Namespaces page in the console |
| GroupId | string | yes | The application ID. You can obtain the ID from the Application Management page in the console |
| JobId | integer | yes | The job ID. You can obtain the ID from the Job Management page in the console |
| JobInstanceId | integer | yes | The job instance ID |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third parties |

### Retrieves the execution history of a job filtered by keywords
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-job-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain it on the Namespaces page in the console |
| NamespaceSource | string | no | Required only for specific third parties |
| GroupId | string | yes | The application group ID |
| JobId | integer | no | The job ID |
| Status | integer | no | The instance status. Valid values: 1: Waiting. 3: Running. 4: Successful. 5: Failed. 9: Rejected. Corresponding enum class:… |
| StartTimestamp | integer | no | The start timestamp |
| EndTimestamp | integer | no | The end timestamp |
| PageNum | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries the execution logs of a job. This feature is available only in the Professional Edition
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party integrations |
| GroupId | string | yes | The application group ID. You can obtain the ID on the Application Management page in the console |
| JobId | string | no | The job ID |
| JobInstanceId | string | no | The job instance ID |
| StartTimestamp | integer | no | The start timestamp, accurate to milliseconds. If the start timestamp is not specified, the default value is 30 minutes before the current… |
| EndTimestamp | integer | no | The end timestamp, accurate to milliseconds.> If the end timestamp is not specified, the default value is the current time. |
| Keyword | string | no | The keyword |
| Line | integer | no | The number of lines to return. Maximum value: 200 |
| Offset | integer | no | The line offset. You can use this parameter for paging in a paged query |
| Reverse | string | no | Specifies whether to return logs in reverse order. Default value: true |

### Retrieves the overview data of task scheduling for Professional Edition applications
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | no | The namespace UID |
| NamespaceSource | string | no | The source of the namespace. This parameter is required only for specific third parties |
| GroupId | string | no | The application group ID |
| Operate | string | yes | The operation type. Valid values: query: Queries data within a time range. query_range: Queries time series data within a time range |
| MetricType | integer | yes | The metric type. Valid values: 0: Basic information about tasks. 1: Task execution information |
| StartTime | integer | yes | The start timestamp of the data, in seconds. Example: 1684166400 |
| EndTime | integer | no | The end timestamp of the data, in seconds. Example: 1684166400. If you do not specify this parameter, the current time is used by default |

### Retrieves workflow information
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-work-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID |
| NamespaceSource | string | no | The namespace source |
| GroupId | string | yes | The application group ID |
| WorkflowId | integer | yes | The workflow ID |

### Retrieves the list of workers connected to a specified application
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-worker-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| GroupId | string | yes | The permission group ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |

### Queries the details of a specified workflow instance, including the instance status, dependencies, and the…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/get-workflow-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third parties |
| GroupId | string | yes | The application group ID. You can obtain the ID on the Application Management page in the console |
| WorkflowId | integer | yes | The workflow ID |
| WfInstanceId | integer | yes | The workflow instance ID |

### Grants authorization to a specified group
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/grant-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Namespace | string | yes | The namespace UID |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID |
| UserId | string | yes | The user ID |
| UserName | string | yes | The username |
| GrantOption | string | no | Specifies whether to allow the grant option. Valid values: true: Allowed. false: Not allowed |

### Queries the list of applications
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The namespace. You can obtain the namespace on the Namespaces page in the console |
| NamespaceSource | string | no | Required only for special third parties |
| RegionId | string | no | The region ID |
| AppGroupName | string | no | The name of the application group |

### Retrieves the task script history
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-job-script-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The ID of the task. You can obtain the ID from the Task Management page in the console |
| GroupId | string | yes | The ID of the application. You can obtain the ID from the Application Management page in the console |
| Namespace | string | yes | The ID of the namespace. You can obtain the ID from the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party systems |
| RegionId | string | yes | The region ID |

### Retrieves a list of jobs
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| Namespace | string | yes | The namespace. You can obtain the namespace on the Namespace page in the console |
| NamespaceSource | string | no | Required only for special third-party users |
| RegionId | string | yes | The region ID |
| JobName | string | no | The job name |
| Status | string | no | The job status. Valid values: 0: disabled. 1: enabled |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of records per page |

### Retrieves a list of namespaces
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| NamespaceName | string | no | The namespace name |
| Namespace | string | no | The namespace UID |

### Retrieves a list of workflow information
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-work-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The UID of the namespace |
| NamespaceSource | string | no | The source of the namespace. This parameter is required only for special sources |
| GroupId | string | yes | The application group ID |
| WorkflowName | string | no | The workflow name |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page for paginated queries |
| Status | integer | no | The task status. 0: Disabled. 1: Enabled |

### Retrieves the historical execution records of a workflow. This feature is supported only in Professional…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/list-workflow-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third parties |
| GroupId | string | yes | The application group ID. You can obtain the ID on the Application Management page in the console |
| WorkflowId | string | yes | The workflow ID |

### Updates a calendar
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/manage-schedulerx-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |
| MonthDaysContent | string | yes | The months and days |
| Incremental | string | no | Specifies whether to perform an incremental update. Default value: false. false: Updates the specified months and deletes the… |

### Synchronizes nodes across namespaces
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/manage-schedulerx-job-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| OriginalNamespace | string | yes | The source namespace where the nodes originally reside |
| NamespaceSource | string | no | The source of the namespace. This parameter is required only for special third-party integrations |
| OriginalGroupId | string | yes | The source application ID. The application group where the nodes originally reside |
| JobIdList | string | yes | The list of node IDs (JSON-encoded) |
| TargetNamespace | string | yes | The target namespace to which the nodes are synchronized |
| TargetGroupId | string | yes | The target application ID. The application group to which the nodes are synchronized |

### Updates a notification policy
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/manage-schedulerx-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| PolicyName | string | yes | The Policy Name of the notification policy |
| Description | string | no | The description of the notification policy |
| ChannelTimeRange | string | no | The effective period configuration for notification channels. Refer to the supplementary description of ChannelTimeRange in the request… |

### Queries calendars
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/read-schedulerx-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| CalendarName | string | no | The calendar name |
| Year | integer | no | The year |
| FetchSystemCalendar | string | no | Specifies whether to retrieve the system calendar. Default value: false. Valid values: false: Returns only user-defined calendars. true:… |
| FetchCalendarDetail | string | no | Specifies whether to retrieve calendar details. Default value: false. Valid values: false: Does not return the detailed list of days for… |
| MaxResults | integer | no | The maximum number of results to return for a single request. Default value: 20 |
| NextToken | string | no | The token that indicates the position from which the current call returns results. An empty value indicates that all data has been… |

### Retrieves the details of machines specified for a task
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/read-schedulerx-designate-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The ID of the task. You can obtain the ID from the Task Management page in the console |
| Namespace | string | yes | The UID of the namespace. You can obtain the UID from the Namespace page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party integrations |
| GroupId | string | yes | The ID of the application. You can obtain the ID from the Application Management page in the console |
| RegionId | string | yes | The region ID |
| DesignateType | integer | no | The type of the specified machines. Valid values: 1: Machine address. 2: Machine tag |

### Retrieves the basic information of a specified machine
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/read-schedulerx-designate-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The task ID. You can obtain the ID on the Task Management page in the console |
| Namespace | string | yes | The UID of the namespace. You can obtain the UID on the Namespace page in the console |
| NamespaceSource | string | no | Required only for specific third parties |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Queries notification policies
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/read-schedulerx-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| PolicyName | string | no | The notification policy name. Fuzzy matching is supported |
| MaxResults | integer | no | The maximum number of entries to return for a single request. Default value: 20 |
| NextToken | string | no | The token that specifies the position from which the query begins. An empty value indicates that all data has been read. You do not need… |

### Reruns historical data of a node. This operation is supported only by the professional edition
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/rerun-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| JobId | integer | yes | The node ID |
| StartDate | integer | yes | The start date timestamp, in milliseconds |
| EndDate | integer | yes | The end date timestamp, in milliseconds |
| DataTime | string | yes | The data timestamp character string, in the HH:mm:ss format |

### Reruns a node instance in the failed or successful state. Only the professional edition supports this…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/retry-job-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| JobId | integer | yes | The node ID |
| JobInstanceId | integer | yes | The node instance ID |

### Revokes the permissions of a specified Alibaba Cloud RAM user
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/revoke-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace UID. You can obtain the namespace UID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the application ID on the Application Management page in the console |
| UserId | string | yes | The UID of the Alibaba Cloud account |

### Forcibly sets the node instance status to successful. Only DAS Professional Edition supports this operation
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/set-job-instance-success` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only by special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| JobId | integer | yes | The node ID |
| JobInstanceId | integer | yes | The node instance ID |

### Forcibly sets the workflow instance status to the success state. Only the professional edition supports this…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/set-wf-instance-success` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only by special third parties |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| WorkflowId | integer | yes | The workflow ID |
| WfInstanceId | integer | yes | The workflow instance ID |

### Stops a running instance
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The node ID. You can obtain the ID on the Task Management page in the console |
| InstanceId | integer | yes | The running instance ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | Required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |

### Updates an application group
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | no | The description of the application |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| MaxConcurrency | integer | no | The maximum number of concurrently running instances. Default value: 1. If the previous trigger has not finished running, the next trigger… |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| RegionId | string | yes | The region ID |
| AppVersion | integer | no | The application edition. Valid values: 1: Basic Edition. 2: Professional Edition |
| MonitorConfigJson | string | no | The configuration of alert notifications. The following properties are supported: `sendChannel`, `alarmType`, and `webhookIsAtAll`. For… |
| MonitorContactsJson | string | no | The configuration of alert contacts. You can configure alert contacts and alert contact groups. For more information about this field, see… |
| NotificationPolicyName | string | no | The notification policy name |
| EnableLog | string | no | Specifies whether to enable logging |

### Updates the configuration of a job. By default, you must first call the operation to query the job and find…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespaces page in the console |
| NamespaceSource | string | no | The namespace source. This parameter is required only for specific third-party integrations |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| JobId | integer | yes | The job ID. You can obtain the ID on the Jobs page in the console |
| Name | string | no | The job name |
| Description | string | no | The job description |
| ExecuteMode | string | no | The execution mode of the job. Valid values: standalone: Standalone execution. broadcatst: Broadcast execution. parallel: Visualized… |
| ClassName | string | no | The full path of the job interface class. This parameter is required only for Java jobs and must be the full path |
| Content | string | no | The job content. If the job type is Python, Shell, or Kubernetes, enter the corresponding script content. If the job type is Golang, the… |
| Parameters | string | no | The custom parameters. These parameters can be obtained during runtime |
| MaxConcurrency | integer | no | The maximum number of concurrently running instances. Default value: 1. If the previous trigger has not finished running, the next trigger… |
| MaxAttempt | integer | no | The maximum number of retries allowed upon errors. Set this parameter based on your business requirements |
| AttemptInterval | integer | no | The retry interval upon errors. Unit: seconds. Default value: 30 |
| PageSize | integer | no | The advanced configuration for parallel grid jobs. The number of subtasks pulled at a time. Default value: 100 |
| TaskDispatchMode | string | no | The advanced configuration for parallel grid jobs. The dispatch mode, which can be push or pull |
| ConsumerSize | integer | no | The advanced configuration for parallel grid jobs. The number of execution threads triggered at a time on a single machine. Default value: 5 |
| QueueSize | integer | no | The advanced configuration for parallel grid jobs. The maximum cache size of the subtask queue. Default value: 10000 |
| DispatcherSize | integer | no | The advanced configuration for parallel grid jobs. The number of subtask dispatch threads. Default value: 5 |
| TaskMaxAttempt | integer | no | The advanced configuration for parallel grid jobs. The maximum number of retries allowed for a failed subtask |
| TaskAttemptInterval | integer | no | The advanced configuration for parallel grid jobs. The retry interval for a failed subtask |
| TimeType | integer | no | The scheduling time type. This field indicates the scheduling type, not a specific date, time, or timestamp. Valid values: 1: cron. 3:… |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. cron: Enter a standard cron expression. Online verification… |
| Calendar | string | no | The custom calendar. This parameter is optional for the cron type |
| DataOffset | integer | no | The time offset. Unit: seconds. This parameter is optional for the cron type |
| Timezone | string | no | The time zone |
| TimeoutEnable | string | no | Specifies whether to enable the timeout alert. Valid values: true: enables the timeout alert. false: disables the timeout alert |
| Timeout | integer | no | The timeout threshold. Unit: seconds |
| TimeoutKillEnable | string | no | Specifies whether to terminate the current trigger upon timeout. Valid values: true: terminates the current trigger upon timeout. false:… |
| FailEnable | string | no | Specifies whether to enable the failure alert. Valid values: true: enables the failure alert. false: disables the failure alert |
| FailTimes | integer | no | The number of consecutive failures that trigger an alert |
| MissWorkerEnable | string | no | Specifies whether to enable the alert for no available workers. Valid values: true: enables the alert for no available workers. false:… |
| SuccessNoticeEnable | string | no | Specifies whether to enable the success notification |
| SendChannel | string | no | The alert sending channel. Only SMS is supported |
| ContactInfo | string | no | The job contact information. [Deprecated] (JSON-encoded) |
| XAttrs | string | no | The extended attributes. This parameter is required for Kubernetes jobs. Job: {"resource":"job"} Shell:… |
| Template | string | no | The custom job template for Kubernetes jobs |
| Priority | integer | no | The job priority. Valid values: 1: low. 5: medium. 10: high. 15: very high |
| StartTime | integer | no | The start timestamp. Unit: milliseconds. The value must be later than the current time. A value of -1 indicates that the job starts… |
| EndTime | integer | no | The expiration timestamp of the job. Unit: milliseconds. The value must be later than the current time and the start time. A value of -1… |

### Updates the execution script of a node
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-job-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | integer | yes | The node ID. You can obtain the ID on the Task Management page in the console |
| Namespace | string | yes | The namespace ID. You can obtain the ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application ID. You can obtain the ID on the Application Management page in the console |
| RegionId | string | yes | The region ID |
| VersionDescription | string | no | The description of the script version |
| ScriptContent | string | no | The script content |

### Updates a namespace
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceName | string | no | The namespace name |
| Description | string | no | The namespace description |

### Updates the basic information of a workflow. Only the Professional Edition supports this operation
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| WorkflowId | string | yes | The workflow ID |
| Name | string | no | The workflow name |
| Description | string | no | The workflow description |
| TimeType | integer | no | The time type. Valid values: cron: 1 api: 100 |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. cron: Enter a standard cron expression. Online verification… |

### Updates the nodes and dependencies of a workflow. Only Professional Edition applications support this…
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/update-workflow-dag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| Namespace | string | yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the console |
| NamespaceSource | string | no | This parameter is required only for special third-party users |
| GroupId | string | yes | The application group ID. You can obtain the application group ID on the Application Management page in the console |
| WorkflowId | string | yes | The workflow ID |
| DagJson | string | yes | The DAG information of the workflow, including node and edge information, in JSON format |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/version` (byok)

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-delete-jobs" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Schedulerx API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-schedulerx2/batch-delete-jobs with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Schedulerx API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Schedulerx itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Schedulerx API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-schedulerx2.

### What is the status of the Alibaba Cloud Schedulerx API?
Needs your own provider key (bring your own key)