API overview-Microservices Engine(MSE)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (SchedulerX3/2024-06-24) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

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.

Cluster

API	Title	Description
CreateCluster	Create cluster	Create a cluster
UpdateCluster	Update cluster	Updates a cluster.
DeleteCluster	Release and delete a cluster	Deletes a cluster.
GetCluster	Obtain cluster details	Get cluster details.
ListClusters	Query instance list	Returns a list of instances.

Application

API	Title	Description
CreateApp	Create Application	Creates an app.
UpdateApp	Update Application	Updates an application group.
GetApp	Retrieve a specified application	Retrieves the details of a specified application.
DeleteApp	Delete Application	Deletes an App Group.
ListApps	Retrieve application list	Gets the application list.
ListAppNames	Obtain a list of application names	Returns a list of application names.
ListLables	Obtain the label list of the executor	Retrieves a list of labels for an Executor.
ListExecutors	Query Executor List	Lists executors based on specified filters.

Executor

API	Title	Description
UpdateExecutors	Update executor	Updates the configuration of one or more Executors.
GetExecutorConfig	Obtain the configuration information of the specified executor	Retrieves the configuration for a specified Executor.
CreateExecutors	Manually import executor	Imports one or more executors.

Job

API	Title	Description
SyncJobs	Sync task	Synchronizes jobs.
CreateJob	Create a job	Click Create Task.
UpdateJob	Update Job	Update task details.
UpdateJobScript	Update Job Execution Script	Updates a job script.
DeleteJobs	Batch delete jobs	Deletes multiple jobs in a batch.
OperateEnableJobs	Batch enable jobs	Enables multiple jobs in a batch.
OperateDisableJobs	Disable jobs in batch.	Disables multiple jobs.
OperateRerunJob	Refresh historical data of a job	Reruns historical data for a job within a specified time range.
ListJobs	Retrieve Job List	Returns a task list.
ListJobScriptHistory	Retrieve the job script history list	Lists the script history for a job.
GetDesigateInfo	Obtain the information of the specified machine	Retrieves the designation information for a job.

Task execution

API	Title	Description
GetJobExecution	Obtain detailed information about task execution	Returns the details of a Task Execution.
OperateStopJobExecution	Stop a running task instance	Stops a running Job Execution.
OperateDesignateExecutors	Specify the executor	Designates one or more executors for a job.
OperateRetryJobExecution	Rerun task instance	Retries a failed Job Instance.
OperateExecuteJob	Run a job once	Executes a job on demand.
GetJobExecutionProgress	Obtain the details of job execution	Gets the details of a sharding task execution.
GetJobExecutionThreadDump	Query the job execution stack	Retrieves the thread dump for a specific job execution.
ListJobExecutions	Obtain the job instance list	Returns a list of task instances.

Other

API	Title	Description
ListK8sResource	Obtain k8s resources	Lists k8s resources.
GetLogEvent	Query Management Event	Query Events.
ImportJobs	Batch import job	Imports jobs in bulk.
ListRegions	Obtain Region List	Obtain the List of all Regions.
ListRegionZone	Obtain the zone list	Obtain the zone list.
ListCalendarNames	Obtain a list of calendar names	Lists all Calendar names.
ListScheduleEvent	Query schedule events	Lists scheduled events.
ListAlarmEvent	Retrieve alert events	Retrieves alert events.
ListScheduleTimes	Obtain the next five scheduled times for the specified time type and expression	Retrieves the next five scheduled times based on the specified time type and time expression.
ImportCalendar	Import a calendar	Imports a calendar.
ExportJobs	Batch Export Job	Exports job information in bulk.
GetLog	Query logs	Retrieves log entries.
OperateMarkSuccessWorkflowExecution	Mark a workflow instance as succeeded	Marks a workflow execution as successful.
OperateSkipJobExecution	Skip task instance	Skips a job execution.
UpdateWorkflow	Update pipeline	Updates an existing workflow.
OperateEnableWorkflows	Enable pipeline	Enables one or more workflows.
CreateCalendar	Create Calendar	Creates a custom calendar.
ImportWorkflows	Import pipeline	Imports one or more workflows.
GetWorkflow	Obtain basic information about a pipeline	Retrieves the basic information for a specified workflow.
OperateUnskipJobExecution	Cancel a skipped task instance	Resumes a skipped job execution.
ExportWorkflows	Export pipeline	Exports the definitions of one or more Workflows in JSON format. The exported data includes the basic information, all Nodes, and the Directed Acyclic Graph (DAG) dependencies for each Workflow.
GetWorkflowDAG	Retrieve pipeline DAG information	Gets the Directed Acyclic Graph (DAG) of a workflow.
ListWorkflowVersions	Retrieve the pipeline version list	Lists the versions for a specified workflow.
OperateHoldJobExecution	Suspend task instances that have not been executed yet	Holds a pending job execution.
DeleteCalendar	Delete Calendar	Deletes the specified calendar.
UpdateWorkflowDAG	Update the DAG information of a pipeline	Updates a workflow's Directed Acyclic Graph (DAG), including node coordinates and edges.
OperateUnholdJobExecution	Cancel suspension of a task instance	Resumes a Job Execution that is in the Hold state.
OperateHoldWorkflowExecution	Suspend Workflow Instance	Puts a Workflow Execution on hold, suspending all its unexecuted nodes.
OperateBackfillWorkflow	Backfill Historical Data for Pipeline	Backfills historical data for a specified workflow.
DeleteWorkflows	Batch delete pipelines	Deletes one or more workflows.
UpdateCalendar	Update calendar	Updates a calendar.
OperateRetryWorkflowExecution	Rerun pipeline instance	Retries a workflow execution.
UpdateWorkflowDAGVersion	Switch pipeline DAG version	Updates the Directed Acyclic Graph (DAG) version for a Workflow.
GetCalendar	Obtain calendar	Retrieves the details of a specified calendar.
GetWorkflowExecutionDAG	Obtain the DAG information of a pipeline instance	Retrieve the DAG information for a workflow instance.
ListWorkflows	List pipelines	Lists your workflows.
OperateMarkSuccessJobExecution	Mark a task instance as Succeeded	Marks a job execution as successful.
CreateWorkflow	Create a pipeline	Creates a workflow.
OperateDisableWorkflows	Disable pipeline	Disables one or more workflows.
OperateUnholdWorkflowExecution	Cancel suspension of a workflow instance	Resumes a workflow execution that is on hold.
OperateExecuteWorkflow	Run a pipeline once	Executes a workflow.
OperateStopWorkflowExecution	Stop a running pipeline instance	Stops a running workflow execution.
ListCalendars	Retrieve Calendar List	Retrieves a list of calendars.
GetWorkflowDAGPreview	Retrieve the DAG of a pipeline History version	Gets the DAG for a previous workflow version.
ListWorkflowExecutions	Retrieve the workflow instance list	Retrieves a list of workflow instances.
DeleteWorkflow	Delete pipeline	Deletes a Workflow.