# Alibaba Cloud SchedulerX3 API

> Alibaba Cloud SchedulerX3 API on Apizie: 98 endpoints (Creates an application, Creates a custom calendar, Creates a cluster, Creates a notification contact, …) 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://apizie.tech/v1/cloud:aliyun-schedulerx3/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for SchedulerX3 (schedulerx3, version 2024-06-24). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates an application
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| AccessToken | string | no | The access token of the application |
| Title | string | yes | The title |
| MaxConcurrency | integer | no | The size of the task execution queue. The maximum number of task instances that can run concurrently for an application. Task instances… |
| EnableLog | string | no | Specifies whether to enable logging |
| LabelRouteStrategy | integer | no | The label routing strategy |
| AppType | integer | no | The application type |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID. You can call https://help.aliyun.com/document_detail/28147.html to query the cluster ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |
| Months | string | yes | The calendar for each month, in JSON array format |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |

### Creates a cluster
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterName | string | yes | The name of the cluster |
| VpcId | string | no | The VPC ID |
| VSwitches | string | no | The vSwitch information (JSON-encoded) |
| ClusterSpec | string | no | The cluster specifications. Valid values: scx.dev.x1. scx.small.x1. scx.small.x2. scx.medium.x1. scx.medium.x2 |
| EngineType | string | no | The engine type. Valid values: xxljob |
| Tag | string | no | The tag list, which can contain up to 20 sub-items (JSON-encoded) |
| ChargeType | string | no | The billing method |
| PricingCycle | string | no | The pricing cycle |
| Duration | integer | no | The duration |
| ClusterType | integer | no | The cluster type |
| Source | string | no | The source |

### Creates a notification contact
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ContactName | string | yes | The name of the alert contact |
| Type | string | yes | The contact type. IM: Configures an IM channel notification contact |
| Config | string | yes | The JSON character string for channel parameter settings. Example for the IM type:… |

### Creates a data source
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-datasource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Name | string | yes | The name of the data source |
| Description | string | no | The name of the data source |
| Type | integer | yes | The type of the data source. Valid values: 0: MySQL 1: PostgreSQL |
| ConnectionParams | string | yes | The connection parameters of the data source, in JSON format |
| Password | string | yes | The database password |

### Adds an executor group
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-executor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Name | string | yes | The name of the worker group |
| Description | string | no | The description of the worker group |
| WorkerType | string | yes | The worker type |
| Protocol | string | no | The backend protocol. Valid values: HTTP (default): Supports association with HTTPS, HTTP, and QUIC listeners. HTTPS: Supports association… |
| Network | string | no | The network type. Valid values: public and private |
| AuthType | string | no | The authentication type |
| ApiKey | string | no | The client key |
| Workers | string | yes | The list of workers in JSON format |
| IntegrationType | string | no | The executor integration method. Valid values: manual: Manual entry. acs: Integration with ACS |
| AutoScale | string | no | The auto scaling configuration |
| CmsWorkspaceId | string | no | The CMS workspace ID |
| XAttrs | string | no | The extended configuration of the executor group |

### Manually imports workers
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-executors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkerType | string | yes | The worker type |
| Workers | string | yes | The list of specified machines in JSON format |

### Creates a job
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| Name | string | yes | The job name |
| Description | string | no | The job description |
| JobType | string | yes | The job type |
| RouteStrategy | integer | no | The routing strategy. Valid values: 1: Round-robin. 2: Random. 3: First. 4: Last. 5: Least frequently used. 6: Least recently used. 7:… |
| Parameters | string | no | The job parameters |
| MaxConcurrency | integer | no | The maximum concurrency |
| MaxAttempt | integer | no | The maximum number of retries for errors. Set this parameter based on your business requirements |
| AttemptInterval | integer | no | The retry interval for errors. Unit: seconds. Default value: 30 |
| JobHandler | string | no | The name of the job handler |
| Script | string | no | The script content for non-BEAN jobs |
| TimeType | integer | yes | The time type. Valid values: -1: none 1: cron 3: fix_rate 5: one_time 100: api |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. none: Not required. cron: Enter a standard cron expression.… |
| Calendar | string | no | The custom calendar. This parameter is optional for the cron type |
| Timezone | string | no | The time zone |
| StartTimeType | integer | no | The start time type |
| StartTime | integer | no | The start time. Use a UNIX timestamp in milliseconds |
| XAttrs | string | no | The extended attributes. This parameter is required if the job type is Kubernetes. Job: {"resource":"job"} Shell job:… |
| Priority | integer | no | The priority. Valid values: 1: Low. 5: Medium. 10: High. 15: Very high |
| NoticeConfig | string | no | The notification configuration (JSON-encoded) |
| NoticeContacts | string | no | The notification contact configuration (JSON-encoded) |
| ExecutorBlockStrategy | integer | no | The client blocking strategy. Valid values: 1: Serial execution on a single machine. 2: Ignore subsequent schedules. 3: Override previous… |
| Status | integer | no | The job status. Default value: Enabled. Valid values: 0: Disabled. 1: Enabled |
| ChildJobId | string | no | The IDs of child jobs. Separate multiple IDs with commas (,) |
| Weight | integer | no | The job weight |
| DependentStrategy | integer | no | The dependency strategy |
| Coordinate | string | no | The coordinates of the node in the workflow (JSON-encoded) |
| Label | string | no | The job label information |

### Creates a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| Name | string | yes | The workflow name |
| Description | string | no | The workflow description |
| TimeType | integer | no | The time type. Valid values: -1: none 1: cron 100: api |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. none: Not required. cron: Enter a standard cron expression.… |
| Calendar | string | no | The custom calendar. This parameter is optional when the time type is cron |
| Timezone | string | no | The time zone |
| MaxConcurrency | integer | no | The maximum concurrency of the workflow |
| Status | integer | no | The workflow status. Default value: 0. Valid values: 0: Disabled. 1: Enabled |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client and ensure that the… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |

### Releases and deletes a cluster
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Deletes a notification contact
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ContactName | string | yes | The name of the alert contact |

### Deletes a data source
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-datasource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DatasourceId | integer | yes | The data source ID. You can call the ListDatasources operation to obtain the ID |

### Adds an executor group
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-executor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Id | integer | yes | The ID |
| Name | string | no | The name of the executor group |
| DeleteJobs | string | no | Specifies whether to synchronously delete tasks |

### Deletes tasks in batches
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobIds | string | no | The list of task IDs (JSON-encoded) |
| AppGroupId | integer | no | The application ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| DeleteJobs | string | no | Specifies whether to delete all nodes under the workflow |

### Deletes workflows in batches
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/delete-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowIds | string | yes | The list of workflow IDs (JSON-encoded) |
| DeleteJobs | string | no | Specifies whether to delete all nodes under the workflow |

### Exports export task information in batches
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobIds | string | no | The list of task IDs (JSON-encoded) |
| ExportJobType | integer | no | The export task type. Default value: 1 |

### Exports a workflow in JSON format, including the basic workflow information, all node content within the…
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/export-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | A short description of struct |
| WorkflowId | string | no | The workflow ID (JSON-encoded) |
| AppName | string | no | The application name |

### Retrieves a specified application
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |

### Retrieves the calendar
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |

### Queries the details of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Retrieves the information of a specified machine
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-desigate-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The job ID |
| AppGroupId | integer | no | The application ID |

### Retrieves the configuration information of a specified executor
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-executor-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |

### Retrieves the details of a job execution
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | yes | The job execution ID |
| MseSessionId | string | no | The MSE session ID |

### Retrieves the details of a sharding task execution
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-job-execution-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | yes | The job execution ID |
| AppGroupId | integer | no | The application ID |

### Queries the task execution stack
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-job-execution-thread-dump` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | no | The cluster ID |
| AppName | string | no | The application name |
| JobExecutionId | string | no | The task execution ID |
| ExecutorAddr | string | no | The executor address |

### Queries logs
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| JobExecutionId | string | no | The job execution ID |
| StartTime | integer | no | The start time |
| EndTime | integer | no | The end time |
| Level | string | no | The log level |
| Keyword | string | no | The search keyword |
| Offset | integer | no | The offset |
| LineNum | integer | no | The LineNum |
| Reverse | string | no | Specifies whether to sort the results in descending order. Valid values: true: Sorts the results in descending order. false: Sorts the… |
| LogId | integer | no | The log ID |
| WorkerAddr | string | no | The worker address |
| ScheduleTime | integer | no | The schedule time |

### Queries events
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-log-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| EventType | string | no | The event type |
| JobName | string | no | The job name |
| JobExecutionId | integer | no | The job execution ID |
| WorkflowName | string | no | The workflow name |
| WorkflowExecutionId | integer | no | The workflow execution ID |
| StartTime | integer | no | The start time. Specify a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time |
| Event | string | no | The event |
| Keyword | string | no | The keyword |
| PageSize | integer | no | The page size |
| PageNum | integer | no | The page number |
| Reverse | string | no | Specifies whether to sort the results in descending order. Valid values: true: Sorts the results in descending order. false: Sorts the… |

### Retrieves paginated logs
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-page-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| JobName | string | no | The job name |
| JobExecutionId | string | no | The job execution ID |
| WorkerAddr | string | no | The executor address |
| StartTime | integer | no | The start timestamp in milliseconds |
| EndTime | integer | no | The end timestamp in milliseconds |
| Keyword | string | no | The search keyword |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| Reverse | string | no | Specifies whether to sort the results in descending order. Valid values: true: Sorts the results in descending order. false: Sorts the… |

### Retrieves the basic information of a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |

### Retrieves the DAG information of a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-workflow-dag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | no | The workflow ID |

### Retrieves the DAG of a historical version of a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-workflow-dagpreview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | no | The workflow ID |
| DagVersion | string | yes | The version number of the workflow DAG |

### Retrieves the DAG information of a workflow instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/get-workflow-execution-dag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow execution ID |

### Imports scheduled tasks from an agent to the scheduler platform (SSE). This operation cannot be called with…
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/import-agent-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AgentName | string | yes | agentname |
| MigrateStrategy | integer | no | The synchronization strategy for scheduled tasks. Valid values: 1: Migrates both the content and scheduling time of the agent's local… |

### Imports a calendar
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/import-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the calendar |
| Year | integer | yes | The year |
| Months | string | yes | The month |
| ClusterId | string | yes | The cluster ID |

### Imports nodes in batches
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Overwrite | string | no | Specifies whether to overwrite existing nodes. Default value: true. true: Overwrite. false: Do not overwrite |
| Content | string | no | The import content |
| AutoCreateApp | string | no | Specifies whether to enable automatic creation of an application |

### Imports a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/import-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | A short description of struct |
| Overwrite | string | no | Specifies whether to overwrite the workflow if it already exists. Default value: true. Valid values: true: Overwrite. false: Do not… |
| Content | string | no | The import content |
| AutoCreateApp | string | no | Specifies whether to enable automatic creation of an application |

### Retrieves alert events
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-alarm-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| JobName | string | no | The job name |
| StartTime | integer | no | The start time of the retrieved events. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the retrieved events. The value is a UNIX timestamp in milliseconds |
| AlarmType | string | no | The alert type. Valid values: `schedulerx3_no_designate_machine_alarm`: The specified machine is unavailable.… |
| AlarmChannel | string | no | The alert channel. Valid values: `sms`: SMS. `mail`: Email. `phone`: Phone call. `webhook`: Webhook |
| AlarmStatus | string | no | The alert status. Valid values: `true`: The alert message was sent successfully. `false`: The alert message failed to be sent |
| PageSize | string | no | The number of entries per page |
| PageNum | string | no | The page number |
| Reverse | string | no | Specifies whether to sort the results in descending order |

### Retrieves the list of application names
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-app-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |

### Retrieves a list of applications
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| Title | string | no | The title |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The page size |

### Retrieves a list of calendar names
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-calendar-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| CalendarName | string | no | The calendar name |
| Year | integer | no | The year |
| FetchCalendarDetail | string | no | Specifies whether to retrieve calendar details. Default value: false. false: The detailed list of days for each month is not returned.… |
| MaxResults | integer | no | The maximum number of entries to return for the current request. Default value: 10 |
| NextToken | string | no | The token that specifies the position where the current call starts to read data. An empty value indicates that all data has been read.… |

### Queries the list of instances
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page in a paging query |
| Tag | string | no | The list of tags used to filter clusters (JSON-encoded) |
| ClusterId | string | no | The cluster ID |
| ClusterName | string | no | The cluster name |
| ClusterType | integer | no | The cluster type |

### Queries the list of notification contacts
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| PageNum | integer | no | The page number |
| ContactName | string | no | The name of the alert contact |
| PageSize | integer | no | The number of entries per page |

### Retrieves a list of data sources
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-datasources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The page size |
| Name | string | no | The name of the task |
| Type | integer | no | The type of the Grafana dashboard. Valid values: dash-db: dashboard. dash-folder: folder, which can contain dashboards |
| MaxResults | integer | no | The maximum number of entries to return for this request. Default value: 10 |
| NextToken | string | no | The token that specifies the position from which the current call returns data. An empty value indicates that all data has been read. You… |

### Retrieves a list of executor groups
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-executor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Name | string | no | The executor group name |
| WorkerType | string | no | The executor type |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| MaxResults | integer | no | The maximum number of entries to return. Default value: 10 |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. An empty value indicates that all data has been… |

### Queries the list of executors
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-executors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | no | The job ID |
| Label | string | no | The label |
| AppGroupId | integer | no | The application group ID |

### Retrieves a list of job instances
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-job-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| WorkflowExecutionId | integer | no | The workflow instance ID |
| JobId | integer | no | The job ID |
| JobName | string | no | The job name |
| JobExecutionId | string | no | The job execution ID |
| Status | integer | no | The job execution status. Valid values: 0: UNKNOWN. 1: WAITING. 2: READY. 3: RUNNING. 4: SUCCESS. 5: FAILED. 6: PAUSED. 7: SUBMITTED. 8:… |
| StartTime | string | no | The start time. Format: YYYY-MM-DD HH:mm:ss |
| EndTime | string | no | The end time. The format is YYYY-MM-DD HH:mm:ss |
| PageNum | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The job ID |
| MaxResults | integer | no | The maximum number of entries to return for this request. Default value: 10 |
| NextToken | string | no | The token that indicates the position from which the current call returns data. An empty value indicates that all data has been read. You… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| Status | string | no | The status |
| JobId | integer | no | The job ID |
| JobName | string | no | The job name |
| Description | string | no | The description |
| JobHandler | string | no | The name of the jobhandler |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| WorkflowId | integer | no | The workflow ID |
| Label | string | no | The job tag condition |

### Retrieves Kubernetes resources
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-k8s-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| K8sClusterId | string | no | The ID of the Kubernetes cluster for which namespaces are synchronized. The Kubernetes cluster is added to the service mesh specified by… |
| K8sNamespace | string | no | The namespace ID of the Kubernetes cluster. This parameter is required when you query Kubernetes services |
| ResourceType | string | yes | The resource type |
| VpcId | string | no | The VPC ID. This parameter is required when ResourceType is set to cluster |

### Retrieves the list of labels for an executor
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-lables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | no | The job ID |

### Retrieves the list of available zones
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-region-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |

### Retrieves a list of all regions
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |

### Queries scheduling events
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-schedule-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| JobName | string | no | The job name |
| JobExecutionId | string | no | The job execution ID |
| WorkflowName | string | no | The workflow name |
| WorkflowExecutionId | integer | no | The workflow execution ID |
| StartTime | integer | no | The start time of the retrieved events, specified as a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the retrieved events, specified as a UNIX timestamp in milliseconds |
| Event | string | no | The event ID. Valid values: Scheduled. Running. Succeed. Failed. Failing_Auto_Retry. Skip_Schedule. Execute_Log |
| EventType | string | no | The event type |
| Keyword | string | no | The query keyword |
| PageSize | integer | no | The number of entries per page |
| PageNum | integer | no | The current page number |
| Reverse | string | no | Specifies whether to sort the results in descending order |

### Retrieves the next five scheduling times for a specified time type and expression
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-schedule-times` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| TimeType | integer | yes | The time type. Currently, only cron is supported. Valid values: 1: cron |
| TimeExpression | string | yes | The time expression. For cron scheduling, use the Quartz cron format (second minute hour day-of-month month day-of-week) |
| TimeZone | string | no | The time zone |
| Calendar | string | no | The calendar |

### Retrieves a list of workflow instances
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-workflow-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| WorkflowId | integer | no | The workflow ID |
| WorkflowName | string | no | The workflow name |
| WorkflowExecutionId | integer | no | The workflow instance ID |
| Status | integer | no | The workflow execution status. Valid values: 0: unknown 1: waiting 2: queued 3: running 4: success 5: failed 6: killed 7: held 8:… |
| StartTime | string | no | The start time. The time is in the YYYY-MM-DD HH:mm:ss format |
| EndTime | string | no | The end time. The time is in the YYYY-MM-DD HH:mm:ss format |
| PageNum | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| MaxResults | integer | no | The maximum number of entries to return for this request. Default value: 10 |
| NextToken | string | no | The token that specifies the position from which the query starts. An empty value indicates that all data has been read. You do not need… |

### Retrieves a list of workflow versions
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/list-workflow-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| MaxResults | integer | no | The maximum number of results to return for this request. Default value: 10 |
| NextToken | string | no | The pagination token that indicates the position from which the current call returns results. An empty value indicates that all data has… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | no | The application name |
| Status | integer | no | The workflow status. Default value: 0. Valid values: 0: Disabled. 1: Enabled |
| WorkflowId | integer | no | The workflow ID |
| Name | string | no | The workflow name |
| Description | string | no | The workflow description |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The page size |
| MaxResults | integer | no | The maximum number of entries to return for this request. Default value: 10 |
| NextToken | string | no | The token that specifies the position where the current call returns the read data. An empty value indicates that all data has been read.… |

### Backfills the historical data of a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-backfill-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| StartDate | string | yes | The start date for backfilling data. The format is YYYY-MM-DD |
| EndDate | string | yes | The end date for backfilling data. The format is YYYY-MM-DD |

### Tests the connectivity to a data source
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-connect-datasource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Type | integer | yes | The type of the data source |
| ConnectionParams | string | yes | The connection parameters of the data source |
| Password | string | yes | The password of the database user |

### Specifies the executor
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-designate-executors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The job ID |
| Transferable | string | no | Specifies whether failover is enabled |
| DesignateType | integer | yes | The type of machine to designate. Valid values: 1: Designates a worker. 2: Designates a label |
| AddressList | string | yes | The address list (JSON-encoded) |
| AppGroupId | integer | no | The application ID |

### Disables tasks in batches
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-disable-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobIds | string | no | The list of task IDs (JSON-encoded) |
| AppGroupId | integer | no | The application ID |

### Disables a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-disable-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowIds | string | yes | The list of workflow IDs (JSON-encoded) |

### Enables multiple tasks
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-enable-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobIds | string | no | The list of task IDs to operate on (JSON-encoded) |
| AppGroupId | integer | no | The application ID |

### Enables a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-enable-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowIds | string | yes | The list of workflow IDs (JSON-encoded) |

### Runs a task once
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-execute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The job ID |
| InstanceParameters | string | no | The instance parameters |
| Worker | string | no | The worker address of the specified machine |
| Label | string | no | The label of the specified machine |
| AppGroupId | integer | no | The application ID |

### Runs a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-execute-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |

### Suspends a task instance that has not yet been executed
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-hold-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | no | The task execution ID |

### Suspends a workflow instance. Nodes that have not been executed in the workflow are suspended
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-hold-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow instance ID |

### Marks a job instance as succeeded
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-mark-success-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | no | The job execution ID |

### Marks a workflow instance as succeeded
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-mark-success-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow instance ID |

### Reruns the historical data of a task
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-rerun-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The job ID |
| StartDate | integer | yes | The start time. Use a UNIX timestamp in milliseconds, use a UNIX timestamp in milliseconds, use a UNIX timestamp in milliseconds, use a… |
| EndDate | integer | yes | The end time. Use a UNIX timestamp in milliseconds, use a UNIX timestamp in milliseconds, use a UNIX timestamp in milliseconds, use a UNIX… |
| DataTime | string | yes | The data timestamp, in the HH:mm:ss format |
| AppId | integer | no | The application ID |

### Reruns failed task instances
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-retry-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | yes | The job execution ID |
| TaskList | string | no | The list of subtask execution IDs for sharded broadcast tasks. To rerun a subtask of a sharded broadcast task, set this field to the… |
| TriggerChild | string | no | Specifies whether to trigger downstream nodes |
| AppGroupId | integer | no | The application ID |

### Reruns a workflow instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-retry-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow instance ID |
| OnlyFailed | string | no | Specifies whether to rerun only the failed nodes |

### Skips a task instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-skip-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | no | The task execution ID |

### Stops a running task instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-stop-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | yes | The job execution ID |
| TaskList | string | no | The subtask IDs (JSON-encoded) |
| AppGroupId | integer | no | 应用ID |

### Stops a running workflow instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-stop-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow instance ID |

### Resumes a suspended job instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-unhold-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | no | The job execution ID |

### Resumes the execution of a suspended workflow instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-unhold-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowExecutionId | integer | yes | The workflow instance ID |

### Resumes a node instance that is in the skipped state
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/operate-unskip-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | no | The node execution ID |

### Synchronizes nodes
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/sync-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| OriginalClusterId | string | yes | The ID of the original cluster where the nodes originally reside |
| OriginalAppName | string | yes | The name of the original application where the nodes originally reside |
| JobIds | string | yes | The list of node IDs (JSON-encoded) |
| TargetClusterId | string | yes | The ID of the target cluster to which the nodes are synchronized |
| TargetAppName | string | yes | The name of the target application to which the nodes are synchronized |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| AccessToken | string | no | The logon access token |
| Title | string | yes | The title |
| MaxConcurrency | integer | no | The maximum size of the task execution queue. The maximum number of task instances that can run concurrently in an application. Task… |
| EnableLog | string | no | Specifies whether to enable logging. true: Enabled. false: Disabled |
| LabelRouteStrategy | integer | no | 标签路由策略 |
| WorkerId | integer | no | worker组主键ID |

### Updates a calendar
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| CalendarName | string | yes | The calendar name |
| Year | integer | yes | The year |
| Months | string | yes | The month |
| Incremental | string | no | Specifies whether to perform an incremental update. Default value: false. false: Updates the data of the specified months and deletes the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |

### Updates a cluster
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| ClusterName | string | no | The cluster name |
| IpWhitelist | string | no | The instance-level IP whitelist |

### Updates a notification contact
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ContactName | string | yes | The name of the contact to update |
| Type | string | no | The type of the contact |
| Config | string | no | The JSON character string for channel parameter settings. This parameter is optional. If specified, the settings are updated |
| Enabled | string | no | Specifies whether to enable or disable the notification channel for the contact |

### Updates a data source
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-datasource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DatasourceId | integer | yes | The data source ID. You can call the ListDatasources operation to obtain the ID |
| Name | string | no | The data source name |
| Description | string | no | The data source description |
| ConnectionParams | string | no | The data source connection parameters |
| Password | string | no | The database password |

### Updates an executor group
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-executor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Id | string | yes | The ID |
| Name | string | no | The name of the executor group |
| Description | string | no | The description of the executor group |
| WorkerType | string | no | The executor type |
| Protocol | string | no | The protocol |
| Network | string | no | The network configuration |
| AuthType | string | no | The authentication type |
| ApiKey | string | no | The client key |
| Workers | string | no | The JSON-formatted list of specified machines |
| AutoScale | string | no | Specifies whether to enable auto scaling |
| CmsWorkspaceId | string | no | The CMS workspace ID |
| XAttrs | string | no | The extended configuration of the executor group |

### Updates an executor
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-executors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkerType | string | no | The executor type |
| Workers | string | no | The list of specified machines in JSON format |

### Updates node information
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobId | integer | yes | The node ID |
| Name | string | no | The node name |
| Description | string | no | The node description |
| RouteStrategy | integer | no | The routing strategy. Valid values: 1: round robin 2: random 3: first 4: last 5: least frequently used 6: least recently used 7:… |
| Parameters | string | no | The node parameters |
| MaxConcurrency | integer | no | The maximum number of concurrent instances for the node. The maximum number of instances that can run at the same time for the same node.… |
| MaxAttempt | integer | no | The maximum number of retry attempts upon node failure |
| AttemptInterval | integer | no | The retry interval upon node failure |
| JobHandler | string | no | The JobHandler name |
| Script | string | no | The script content for non-BEAN nodes. Use this field to configure the script |
| TimeType | integer | no | The time type. Valid values: -1: none 1: cron 3: fix_rate 5: one_time 100: api |
| TimeExpression | string | no | The time expression. Set the time expression based on the selected time type. none: No value is required. cron: Set a standard cron… |
| Calendar | string | no | The custom calendar |
| XAttrs | string | no | The node extended properties |
| Priority | integer | no | The node execution priority. Valid values: 1: low 5: medium 10: high 15: very high |
| StartTimeType | string | no | The start time type |
| StartTime | integer | no | The scheduling start time |
| Timezone | string | no | The time zone. By default, the time zone of the SchedulerX server is used |
| NoticeConfig | string | no | The notification configuration (JSON-encoded) |
| NoticeContacts | string | no | The notification contact configuration (JSON-encoded) |
| ExecutorBlockStrategy | integer | no | The client blocking strategy. Valid values: 1: serial execution on a single machine 2: ignore subsequent scheduling 3: override previous… |
| ChildJobId | string | no | The child node IDs, separated by commas |
| Weight | integer | no | The node weight |
| DependentStrategy | integer | no | The dependency strategy |
| AppGroupId | integer | no | The application ID |
| Label | string | no | The node label information |

### Updates a job instance
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| JobExecutionId | string | yes | The job execution ID |
| ScheduleTime | integer | no | The scheduling time |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| ScriptContent | string | no | The script content |
| VersionDescription | string | yes | The description of the script version |
| JobId | integer | yes | The node ID |

### Updates a workflow
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| Name | string | no | The workflow name |
| Description | string | no | The workflow description |
| TimeType | integer | no | The scheduling type. Valid values: -1: none 1: cron 100: api |
| TimeExpression | string | no | The time expression. Set this parameter based on the specified time type. none: No value is required. cron: Specify a standard cron… |
| Timezone | string | no | The time zone. By default, the time zone of the SchedulerX server is used |
| Calendar | string | no | The custom calendar |
| MaxConcurrency | integer | no | The maximum number of concurrent instances. The maximum number of workflow instances that can run at the same time. A value of 1 indicates… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among… |

### Updates the DAG information of a workflow, including node coordinates and edge information
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-workflow-dag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| Dag | string | yes | The DAG information of the workflow (JSON-encoded) |
| DagVersion | string | no | The version number of the workflow. You can call the https://help.aliyun.com/document_detail/465989.html operation to obtain the value of… |

### Switches the workflow DAG version
`POST https://apizie.tech/v1/cloud:aliyun-schedulerx3/update-workflow-dagversion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| AppName | string | yes | The application name |
| WorkflowId | integer | yes | The workflow ID |
| DagVersion | string | yes | The workflow DAG version number |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://schedulerx3.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-schedulerx3/create-app" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

### Can AI agents use the Alibaba Cloud SchedulerX3 API?
Yes. Add the Apizie MCP server (https://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-schedulerx3.

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