All Products
Search

This Product

    SchedulerX:CreateJob

    Document Center

    SchedulerX:CreateJob

    Last Updated:Jul 14, 2026

    Creates a node and returns the node ID.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    edas:CreateSchedulerxJobCreate

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    Namespace

    string

    Yes

    The namespace ID. You can obtain the namespace ID on the Namespace page in the console.

    adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
    NamespaceSource

    string

    No

    This parameter is required only for special third-party users.

    schedulerx
    GroupId

    string

    Yes

    The application ID. You can obtain the application ID on the Application Management page in the console.

    testSchedulerx.defaultGroup
    JobType

    string

    Yes

    The node type. The following node types are supported:

    • java

    • python

    • shell

    • go

    • http

    • xxljob

    • dataworks

    • k8s

    • springschedule

    Valid values:

    • python :

      python

    • xxljob :

      xxljob

    • java :

      java

    • shell :

      shell

    • golang :

      golang

    • go :

      go

    • http :

      http

    • dataworks :

      dataworks

    java
    Name

    string

    Yes

    The node name.

    helloworld
    Description

    string

    No

    The node description.

    Test
    ExecuteMode

    string

    Yes

    The node execution mode. The following execution modes are supported:

    • Standalone: standalone

    • Broadcast: broadcast

    • Visual MapReduce: parallel

    • MapReduce: batch

    • Sharding: sharding

    Valid values:

    • broadcast :

      broadcast.

    • parallel :

      parallel computing.

    • grid :

      memory grid.

    • batch :

      grid computing.

    • standalone :

      standalone.

    • sharding :

      sharding.

    standalone
    ClassName

    string

    No

    The full path of the node interface class.

    This field is required only when you select the Java node type. Specify the full path.

    com.alibaba.schedulerx.test.helloworld
    Content

    string

    No

    • If the node type is python, shell, or k8s, specify the corresponding script content.

    • If the node type is golang, the content format example is {"jobName":"HelloWorld"}.

    echo 'hello'
    Parameters

    string

    No

    The user-defined parameters that can be obtained at runtime.

    test
    MaxConcurrency

    integer

    No

    The maximum number of concurrently running instances. Default value: 1. This means that if the previous trigger has not finished running, the next trigger is not performed even if the scheduled time arrives.

    1
    MaxAttempt

    integer

    No

    The maximum number of retries on failure. Set this parameter based on your business requirements. Default value: 0.

    0
    AttemptInterval

    integer

    No

    The retry interval on failure. Unit: seconds. Default value: 30.

    30
    PageSize

    integer

    No

    The advanced configuration for parallel grid nodes. The number of subtasks pulled in a single request. Default value: 100.

    100
    ConsumerSize

    integer

    No

    The advanced configuration for parallel grid nodes. The number of threads triggered for a single execution on a single machine. Default value: 5.

    5
    QueueSize

    integer

    No

    The advanced configuration for parallel grid nodes. The maximum cache size of the subtask queue. Default value: 10000.

    10000
    DispatcherSize

    integer

    No

    The advanced configuration for parallel grid nodes. The number of subtask dispatch threads. Default value: 5.

    5
    TimeType

    integer

    Yes

    The time type. The following time types are supported:

    • cron: 1

    • fixed_rate: 3

    • second_delay: 4

    • one_time: 5

    • api: 100

    • none: -1

    Valid values:

    • 1 :

      1

    • 3 :

      3

    • 4 :

      4

    • 5 :

      5

    • 100 :

      100

    1
    TimeExpression

    string

    No

    The time expression. Set the time expression based on the selected time type.

    • cron: Specify a standard cron expression. Online verification is supported.

    • api: No time expression is required.

    • fixed_rate: Specify a fixed frequency value in seconds. For example, 30 indicates that the node is triggered every 30 seconds.

    • second_delay: Specify a fixed delay in seconds before each execution (1s to 60s).

    • one_time: Specify a time in the format of yyyy-MM-dd HH:mm:ss or a timestamp in milliseconds. For example, "2022-10-10 10:10:00".

    0 0/10 * * * ?
    Calendar

    string

    No

    The custom calendar. This parameter is available for the cron time type.

    DataOffset

    integer

    No

    The time offset. Unit: seconds. This parameter is available for the cron time type.

    2400
    Timezone

    string

    No

    The time zone.

    GMT+8
    TimeoutEnable

    boolean

    No

    Specifies whether to enable the timeout alert. Valid values:

    • true: Enables the timeout alert.

    • false: Disables the timeout alert.

    Valid values:

    • false :

      false

    • true :

      true

    false
    Timeout

    integer

    No

    The timeout threshold. Unit: seconds. Default value: 7200.

    7200
    TimeoutKillEnable

    boolean

    No

    Specifies whether to enable timeout termination. Valid values:

    • true: Enables timeout termination.

    • false: Disables timeout termination.

    Valid values:

    • false :

      false

    • true :

      true

    false
    FailEnable

    boolean

    No

    Specifies whether to enable the failure alert. Valid values:

    • true: Enables the failure alert.

    • false: Disables the failure alert.

    Valid values:

    • false :

      false

    • true :

      true

    false
    FailTimes

    integer

    No

    The number of consecutive failures before an alert is triggered.

    2
    MissWorkerEnable

    boolean

    No

    Specifies whether to enable the no-available-machine alert. Valid values:

    • true: Enables the no-available-machine alert.

    • false: Disables the no-available-machine alert.

    false
    SuccessNoticeEnable

    boolean

    No

    Specifies whether to enable the success notification.

    false
    SendChannel

    string

    No

    The alert notification channel.

    • Use the default channel of the application group: default.

    • Specify a notification channel for the node: sms, mail, phone, or webhook.

    Valid values:

    • default :

      default

    • webhook :

      webhook

    • mail :

      mail

    • phone :

      phone

    • sms :

      sms

    sms
    TaskMaxAttempt

    integer

    No

    The advanced configuration for parallel grid nodes. The number of retries for a failed subtask. Default value: 0.

    0
    TaskAttemptInterval

    integer

    No

    The advanced configuration for parallel grid nodes. The retry interval for a failed subtask. Default value: 0.

    0
    ContactInfo

    array<object>

    No

    The node contact information.

    Important This field is deprecated.

    1

    object

    No

    The node contact information.

    UserPhone

    string

    No

    The mobile phone number of the alert recipient.

    1381111****
    UserName

    string

    No

    The name of the alert contact.

    John Smith
    UserMail

    string

    No

    The email address of the alert contact.

    test***@***.com
    Ding

    string

    No

    The webhook URL of the DingTalk chatbot for the alert contact's DingTalk group. References: DingTalk development documentation.

    https://oapi.dingtalk.com/robot/send?access_token=**********
    Status

    integer

    No

    The node status. Valid values: 0: disabled. 1: enabled. Default value: 1 (enabled).

    1
    XAttrs

    string

    No

    If the node type is k8s, configure this parameter. Job task: {"resource":"job"} Shell task: {"image":"busybox","resource":"shell"}

    {"resource":"job"}
    Priority

    integer

    No

    The node priority. Valid values:

    • 1: low

    • 5: medium

    • 10: high

    • 15: very high

    5

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    integer

    The response code.

    200
    Message

    string

    The additional information.

    message
    RequestId

    string

    The request ID.

    39090022-1F3B-4797-8518-6B61095F1AF0
    Success

    boolean

    Indicates whether the node was created successfully. Valid values:

    • true: The node was created successfully.

    • false: The node failed to be created.

    true
    Data

    object

    The node details.

    JobId

    integer

    The node ID.

    92583

    Examples

    Success response

    JSON format

    {
  "Code": 200,
  "Message": "message",
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Success": true,
  "Data": {
    "JobId": 92583
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.