All Products
Search

This Product

    SchedulerX:List of operations by function

    Document Center

    SchedulerX:List of operations by function

    Last Updated:Dec 20, 2024
    This product(schedulerx2/2019-04-30) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
    Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

    Region

    APITitleDescription
    DescribeRegionsDescribeRegionsReturns available regions.

    Namespace

    APITitleDescription
    CreateNamespaceCreateNamespaceCreates a namespace.
    ListNamespacesListNamespacesQueries namespaces.

    Application Group

    APITitleDescription
    CreateAppGroupCreateAppGroupCreates an application group. The AppKey is returned.
    GetAppGroupGetAppGroupThe configuration of the alert. The value is a JSON string. For more information, see \\*\\*the additional information about response parameters below this table\\*\\*.
    DeleteAppGroupDeleteAppGroupThe additional information that is returned.
    UpdateAppGroupUpdateAppGroupThe additional information that is returned.
    ListGroupsListGroupsQueries a list of applications.
    GetWorkerListGetWorkerListObtains the list of workers that are connected to an application.

    Workflow

    APITitleDescription
    CreateWorkflowCreateWorkflowCreates 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.
    UpdateWorkflowUpdateWorkflowUpdates the basic information about a workflow. You can call this operation only in the professional edition.
    UpdateWorkflowDagUpdateWorkflowDagModifies the nodes and dependencies of a workflow. You can call this operation only in the professional edition.
    DeleteWorkflowDeleteWorkflowDeletes a workflow.
    DisableWorkflowDisableWorkflowDisables a specified workflow.
    EnableWorkflowEnableWorkflowEnables a specified workflow.
    GetWorkFlowGetWorkFlowObtains the information about a workflow.
    ExecuteWorkflowExecuteWorkflowImmediately triggers a workflow.
    GetWorkflowInstanceGetWorkflowInstanceQueries 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.
    ListWorkflowInstanceListWorkflowInstanceQueries the execution history of a workflow. You can call this operation only in the professional edition.
    SetWfInstanceSuccessSetWfInstanceSuccessForcibly sets the state of a workflow instance to successful. You can call this operation only in the professional edition.

    Job

    APITitleDescription
    CreateJobCreateJobCreates a job and obtains the job ID.
    DeleteJobDeleteJobDeletes a specified job.
    BatchDeleteJobsBatchDeleteJobsDeletes multiple jobs at a time.
    UpdateJobUpdateJobUpdates 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.
    DisableJobDisableJobDisables a job.
    BatchEnableJobsBatchEnableJobsEnables multiple jobs at a time.
    BatchDisableJobsBatchDisableJobsDisables multiple jobs at a time.
    EnableJobEnableJobEnables a job.
    GetJobInfoGetJobInfoQueries the details of a job based on the job ID. In most cases, the obtained information is used to update jobs.
    ListJobsListJobsQueries jobs.
    ExecuteJobExecuteJobTriggers a job to immediately run once.
    DesignateWorkersDesignateWorkersDesignates machines.
    RerunJobRerunJobReruns a job to obtain the historical data of the job. You can call this operation only in the professional edition.

    Instance

    APITitleDescription
    StopInstanceStopInstanceStops a job instance in the running state.
    GetJobInstanceGetJobInstanceQueries the information about a job instance. You can view the status and progress of the job instance.
    GetJobInstanceListGetJobInstanceListQueries the most recent 10 execution instances of a job.
    RetryJobInstanceRetryJobInstanceReruns a successful or failed job instance. You can call this operation only in the professional edition.
    SetJobInstanceSuccessSetJobInstanceSuccessForcibly sets the state of a job instance to successful. You can call this operation only in the professional edition.

    Permission Settings

    APITitleDescription
    GrantPermissionGrantPermissionGrants permissions to an application group.
    RevokePermissionRevokePermissionRevokes the permissions that are granted to an Alibaba Cloud Resource Access Management (RAM) user.

    Log

    APITitleDescription
    GetLogGetLogQueries the operational logs of a job. You can call this operation only in the professional edition.

    Route Strategy

    APITitleDescription
    DeleteRouteStrategyDeleteRouteStrategyDeletes a routing policy.
    BatchDeleteRouteStrategyBatchDeleteRouteStrategyThe additional information that is returned.
    CreateRouteStrategyCreateRouteStrategyCreates a routing policy.