All Products
Search

This Product

    SchedulerX:List of operations by function

    Document Center

    SchedulerX:List of operations by function

    Last Updated:Mar 22, 2023
    This product(schedulerx2/2019-04-30) OpenAPI adopts RPC Signature style, see signature details 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 service nail group (11370001915) 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 and returns the AppKey.
    GetAppGroupGetAppGroupQueries an application group.
    DeleteAppGroupDeleteAppGroupDeletes an application group.
    UpdateAppGroupUpdateAppGroupUpdates an application group.
    ListGroupsListGroupsQueries applications.
    GetWorkerListGetWorkerListObtains the list of workers that are connected to an application.

    Workflow

    APITitleDescription
    DeleteWorkflowDeleteWorkflowSends the ID of a workflow.
    DisableWorkflowDisableWorkflowSends the ID of a workflow.
    EnableWorkflowEnableWorkflowSends the ID of a workflow.
    GetWorkFlowGetWorkFlowObtains the information about a workflow.
    ExecuteWorkflowExecuteWorkflowImmediately triggers a workflow.
    ListWorkflowInstanceListWorkflowInstanceQueries the execution history of a workflow. You can call this operation only in the professional edition.

    Job

    APITitleDescription
    CreateJobCreateJobCreates a job and returns the job ID.
    DeleteJobDeleteJobSends the ID of a job.
    BatchDeleteJobsBatchDeleteJobsDeletes multiple jobs at a time based on job IDs.
    UpdateJobUpdateJobUpdates the job configuration information. By default, GetJobInfo is called first to obtain the previous configuration of the job. Then, you can 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 one or more machines.

    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.

    Permission Settings

    APITitleDescription
    GrantPermissionGrantPermissionGrants permissions to an application group.
    RevokePermissionRevokePermissionRevokes the permissions that are granted to a 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.
    BatchDeleteRouteStrategyBatchDeleteRouteStrategyDeletes multiple routing policies at a time.
    CreateRouteStrategyCreateRouteStrategyCreates a routing policy.