JetBrains PluginQuotas Info
Authorization Information
No permission information is available for the cloud service.
Request Parameters
| Field Name | Field Details |
|---|---|
RegionIdstring | The region ID. Example:cn-hangzhou |
Namespacestring | The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console. Example:adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
NamespaceSourcestring | The source of the namespace. You must specify this parameter only if the namespace is provided by a third party. Example:schedulerx |
GroupIdstring | The application ID. You can obtain the application ID on the Application Management page in the SchedulerX console. Example:testSchedulerx.defaultGroup |
JobTypestring | The job type. Valid values:View Details... Example:javaEnumeration Value:pythonxxljobjavashellgohttpdataworks |
Namestring | The job name. Example:helloworld |
Descriptionstring | The job description. Example:Test |
ExecuteModestring | The execution mode of the job. Valid values:View Details... Example:standaloneEnumeration Value:broadcastparallelgridbatchstandalonesharding |
ClassNamestring | The full path of the job interface class.View Details... Example:com.alibaba.schedulerx.test.helloworld |
Contentstring | The script content. This parameter is required when you set JobType to python, shell, go, or k8s. Example:echo 'hello' |
Parametersstring | The user-defined parameters that you can obtain when the job is running. Example:test |
MaxConcurrencyinteger<int32> | The maximum number of concurrent instances. By default, only one instance can run at a time. When an instance is running, the next instance is not triggered even if the scheduled start time arrives. Example:1value <= 200 |
MaxAttemptinteger<int32> | The maximum number of retry attempts in case of a job failure. Specify this parameter based on your business requirements. Default value: 0. Example:0 |
AttemptIntervalinteger<int32> | The time interval between retry attempts in case of a job failure. Unit: seconds. Default value: 30. Example:30 |
PageSizeinteger<int32> | The number of entries per page. You can specify this parameter for MapReduce jobs. Default value: 100. Example:100 |
ConsumerSizeinteger<int32> | The number of threads that a single worker triggers simultaneously. You can specify this parameter for MapReduce jobs. Default value: 5. Example:5 |
QueueSizeinteger<int32> | The maximum capacity of the task queue. You can specify this parameter for MapReduce jobs. Default value: 10000. Example:10000 |
DispatcherSizeinteger<int32> | The number of task distribution threads. This parameter is an advanced configuration item of the MapReduce job. Default value: 5. Example:5 |
TimeTypeinteger<int32> | The time type. Valid values:View Details... Example:1Enumeration Value:1345100 |
TimeExpressionstring | The time expression. Specify the time expression based on the value of TimeType:View Details... Example:0 0/10 * * * ? |
Calendarstring | If you set TimeType to 1 (cron), you can specify calendar days. Example:This parameter is not supported. You do not need to specify this parameter.
|
DataOffsetinteger<int32> | If you set TimeType to 1 (cron), you can specify a time offset. Unit: seconds. Example:2400 |
Timezonestring | Time zone. Example:GMT+8 |
TimeoutEnableboolean | Specifies whether to enable the timeout alert feature. If the feature is enabled, an alert will be triggered upon a timeout. Valid values:View Details... Example:falseEnumeration Value:falsetrue |
Timeoutinteger<int64> | The timeout threshold. Unit: seconds. Default value: 7200. Notice
The field type is Long, and the precision may be lost during serialization/deserialization. Please note that the value must not be greater than 9007199254740991. Example:7200 |
TimeoutKillEnableboolean | Specifies whether to enable the timeout termination feature. If the feature is enabled, a job will automatically be terminated if it times out. Valid values:View Details... Example:falseEnumeration Value:falsetrue |
FailEnableboolean | Specifies whether to trigger an alert when a job fails. Valid values:View Details... Example:falseEnumeration Value:falsetrue |
FailTimesinteger<int32> | The maximum number of consecutive failures before an alert is triggered. An alert will be triggered if the number of consecutive failures reaches the value of this parameter. Example:2 |
MissWorkerEnableboolean | Specifies whether to generate an alert if no machines are available to run the job. Valid values:View Details... Example:false |
SuccessNoticeEnableboolean | Specifies whether to send notifications for successfully running the job. Example:false |
SendChannelstring | The method that is used to send alerts. Set the value to sms. Default value: sms. Example:sms |
TaskMaxAttemptinteger<int32> | The maximum number of retry attempts in case of a job failure. This parameter is an advanced configuration item of the MapReduce job. Default value: 0. Example:0value <= 10 |
TaskAttemptIntervalinteger<int32> | The time interval between retry attempts in case of a job failure. This parameter is an advanced configuration item of the MapReduce job. Default value: 0. Example:0value >= 0 |
ContactInfoarray<object> | The information about the alert contact. Count of Children <= 10 |
Statusinteger<int32> | Specifies whether to enable the job. If this parameter is set to 0, the job is disabled. If this parameter is set to 1, the job is enabled. Default value: 1. Example:1Enumeration Value:01 |
XAttrsstring | The extended attributes. If you set JobType to k8s, this parameter is required. For a job whose resource type is Job-YAML, set this parameter to {"resource":"job"}. For a job whose resource type is Shell-Script, set this parameter to {"image":"busybox","resource":"shell"}. Example:{"resource":"job"}Enumeration Value: |
Priorityinteger<int32> |
Response Parameters
| Field Name | Field Details |
|---|---|
Codeinteger<int32> | The HTTP status code. Example:200 |
Messagestring | The additional information returned. Example:message |
RequestIdstring | The request ID. Example:39090022-1F3B-4797-8518-6B61095F1AF0 |
Successboolean | If you set JobType to k8s, this parameter is required. Valid values:View Details... Example:true |
Dataobject | The details of the job. |