API standard and pre-built SDKs in multi-language
This product (schedulerx2/2019-04-30) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Region
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Returns available regions. |
Namespace
| API | Title | Description |
|---|---|---|
| CreateNamespace | CreateNamespace | Creates a namespace. |
| ListNamespaces | ListNamespaces | Queries namespaces. |
| DeleteNamespace | DeleteNamespace | Deletes a namespace. |
| UpdateNamespace | UpdateNamespace | Updates a namespace. |
Application Group
| API | Title | Description |
|---|---|---|
| CreateAppGroup | CreateAppGroup | Creates an application group. The AppKey is returned. |
| GetAppGroup | GetAppGroup | The configuration of the alert. The value is a JSON string. For more information, see \\\\*\\\\*the additional information about response parameters below this table\\\\*\\\\*. |
| DeleteAppGroup | DeleteAppGroup | Deletes an application group. |
| UpdateAppGroup | UpdateAppGroup | Updates the application group. |
| ListGroups | ListGroups | Queries a list of applications. |
| GetWorkerList | GetWorkerList | Obtains the list of workers that are connected to an application. |
Workflow
| API | Title | Description |
|---|---|---|
| CreateWorkflow | CreateWorkflow | Creates a workflow. By default, the created workflow is disabled. After you update the directed acyclic graph (DAG) of the workflow, you must manually or call the corresponding operation to enable the workflow. You can call this operation only in the professional edition. |
| UpdateWorkflow | UpdateWorkflow | Updates the basic information about a workflow. You can call this operation only in the professional edition. |
| UpdateWorkflowDag | UpdateWorkflowDag | Modifies the nodes and dependencies of a workflow. You can call this operation only in the professional edition. |
| ListWorkFlows | ListWorkFlows | Queries the information of a workflow. |
| ExecuteWorkflow | ExecuteWorkflow | Immediately triggers a workflow. |
| DeleteWorkflow | DeleteWorkflow | Deletes a workflow. |
| DisableWorkflow | DisableWorkflow | Disables a specified workflow. |
| EnableWorkflow | EnableWorkflow | Enables a workflow. |
| GetWorkFlow | GetWorkFlow | Obtains the information about a workflow. |
| GetWorkflowInstance | GetWorkflowInstance | Queries the details of a specified workflow instance, including the state of the workflow instance, the state of each job instance, and the dependencies between job instances. You can call this operation only in the professional edition. |
| ListWorkflowInstance | ListWorkflowInstance | Queries the execution history of a workflow. You can call this operation only in the professional edition. |
| SetWfInstanceSuccess | SetWfInstanceSuccess | Forcibly sets the state of a workflow instance to successful. You can call this operation only in the professional edition. |
Job
| API | Title | Description |
|---|---|---|
| CreateJob | CreateJob | Creates a job and obtains the job ID. |
| DeleteJob | DeleteJob | Deletes a specified job. |
| BatchDeleteJobs | BatchDeleteJobs | Deletes multiple jobs at a time. |
| UpdateJob | UpdateJob | Updates the configuration information about a job. By default, you need to call the GetJobInfo operation to obtain the original configuration of the job before you call this operation to modify the configuration as required. |
| DisableJob | DisableJob | Disables a job. |
| BatchEnableJobs | BatchEnableJobs | Enables multiple jobs at a time. |
| BatchDisableJobs | BatchDisableJobs | Disables multiple jobs at a time. |
| EnableJob | EnableJob | Enables a job. |
| GetJobInfo | GetJobInfo | Queries the details of a job based on the job ID. In most cases, the obtained information is used to update jobs. |
| ListJobs | ListJobs | Queries jobs. |
| ExecuteJob | ExecuteJob | Triggers a job to immediately run once. |
| DesignateWorkers | DesignateWorkers | Designates machines. |
| RerunJob | RerunJob | Reruns a job to obtain the historical data of the job. You can call this operation only in the professional edition. |
| UpdateJobScript | UpdateJobScript | Updates the execution script of a job. |
| ListJobScriptHistory | ListJobScriptHistory | Queries historical scripts of a job. |
| ReadSchedulerxDesignateInfo | ReadSchedulerxDesignateInfo | Queries the basic information of specified workers. |
| ReadSchedulerxDesignateDetail | ReadSchedulerxDesignateDetail | Queries detailed information of the workers specified by a job. |
| ManageSchedulerxJobSync | ManageSchedulerxJobSync | Synchronizes tasks across namespaces. |
Instance
| API | Title | Description |
|---|---|---|
| StopInstance | StopInstance | Stops a job instance in the running state. |
| GetJobInstance | GetJobInstance | Queries the information about a job instance. You can view the status and progress of the job instance. |
| GetJobInstanceList | GetJobInstanceList | Queries the most recent 10 execution instances of a job. |
| RetryJobInstance | RetryJobInstance | Reruns a successful or failed job instance. You can call this operation only in the professional edition. |
| SetJobInstanceSuccess | SetJobInstanceSuccess | Forcibly sets the state of a job instance to successful. You can call this operation only in the professional edition. |
Permission Settings
| API | Title | Description |
|---|---|---|
| GrantPermission | GrantPermission | Grants permissions to an application group. |
| RevokePermission | RevokePermission | Revokes the permissions that are granted to an Alibaba Cloud Resource Access Management (RAM) user. |
Log
| API | Title | Description |
|---|---|---|
| GetLog | GetLog | Queries the operational logs of a job. You can call this operation only in the professional edition. |
Route Strategy
| API | Title | Description |
|---|---|---|
| DeleteRouteStrategy | DeleteRouteStrategy | Deletes a routing policy. |
| BatchDeleteRouteStrategy | BatchDeleteRouteStrategy | Deletes multiple routing policies at a time. |
| CreateRouteStrategy | CreateRouteStrategy | Creates a routing policy. |
Notification Policy
| API | Title | Description |
|---|---|---|
| CreateSchedulerxNotificationPolicy | CreateSchedulerxNotificationPolicy | Creates a notification policy. |
| DeleteSchedulerxNotificationPolicy | DeleteSchedulerxNotificationPolicy | Deletes a notification policy. |
| ManageSchedulerxNotificationPolicy | ManageSchedulerxNotificationPolicy | Updates a notification policy. |
| ReadSchedulerxNotificationPolicy | ReadSchedulerxNotificationPolicy | Queries notification policies. |
Calendar
| API | Title | Description |
|---|---|---|
| CreateSchedulerxCalendar | CreateSchedulerxCalendar | Creates a calendar. |
| DeleteSchedulerxCalendar | DeleteSchedulerxCalendar | Deletes a calendar. |
| ManageSchedulerxCalendar | ManageSchedulerxCalendar | Updates a calendar. |
| ReadSchedulerxCalendar | ReadSchedulerxCalendar | Retrieves the information of a calendar. |
Other
| API | Title | Description |
|---|---|---|
| GetOverview | GetOverview | Retrieves job scheduling data for Professional Edition applications. |