更新任務配置信息。默認先調用獲取任務找到對應字段進行修改。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
edas:ManageSchedulerxJobModify | update | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
Namespace | string | 是 | 命名空間 ID,在控制臺的命名空間頁面中獲取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
NamespaceSource | string | 否 | 特殊第三方才需要填寫。 | schedulerx |
GroupId | string | 是 | 應用 ID,在控制臺的應用管理頁面中獲取。 | testSchedulerx.defaultGroup |
JobId | long | 是 | 任務 ID,在控制臺的任務管理頁面中獲取。 | 92583 |
Name | string | 否 | 任務名。 | helloword |
Description | string | 否 | 任務描述。 | test |
ExecuteMode | string | 否 | 任務執行模式,目前支持以下幾種任務執行模式:
| standalone |
ClassName | string | 否 | 任務接口類完整路徑。 是 Java 任務類型時,才有該字段且必須填寫完整路徑。 | com.alibaba.test.helloworld |
Content | string | 否 |
| echo 'hello' |
Parameters | string | 否 | 用戶自定義參數,運行時可以獲取。 | test |
MaxConcurrency | integer | 否 | 最大同時運行實例數量,默認值為 1,即上次觸發沒有運行結束,不會進行下次觸發即使到了運行時刻。 | 1 |
MaxAttempt | integer | 否 | 錯誤最大重試次數,根據業務需求填寫。 | 0 |
AttemptInterval | integer | 否 | 錯誤重試間隔時間,單位 s,默認值為 30。 | 30 |
PageSize | integer | 否 | 并行網格任務高級配置,單次拉取子任務數,默認值為 100。 | 100 |
TaskDispatchMode | string | 否 | 并行網格任務高級配置,推模型或者拉模型 枚舉值:
| push |
ConsumerSize | integer | 否 | 并行網格任務高級配置,單機單次觸發執行線程數,默認值為 5。 | 5 |
QueueSize | integer | 否 | 并行網格任務高級配置,子任務隊列緩存上限,默認值為 10000。 | 10000 |
DispatcherSize | integer | 否 | 并行網格任務高級配置,子任務分發線程數,默認值為 5。 | 5 |
TaskMaxAttempt | integer | 否 | 并行網格任務高級配置,子任務失敗重試次數。 | 0 |
TaskAttemptInterval | integer | 否 | 并行網格任務高級配置,子任務失敗重試間隔。 | 0 |
TimeType | integer | 否 | 時間配置類型,目前支持以下幾種配置類型:
| 1 |
TimeExpression | string | 否 | 時間表達式,根據選擇的時間類型設置時間表達式。
| 30 |
Calendar | string | 否 | cron 類型可以選擇填寫自定義日歷。 | 工作日 |
DataOffset | integer | 否 | cron 類型可以選擇時間偏移,單位 s。 | 2400 |
Timezone | string | 否 | 時區 | GMT+8 |
TimeoutEnable | boolean | 否 | 超時報警開關。取值如下:
| true |
Timeout | long | 否 | 超時閾值,單位 s。 | 7200 |
TimeoutKillEnable | boolean | 否 | 超時終止本次觸發開關。取值如下:
| true |
FailEnable | boolean | 否 | 失敗報警開關。取值如下:
| true |
FailTimes | integer | 否 | 連續失敗報警次數 | 1 |
MissWorkerEnable | boolean | 否 | 是否開啟無可用機器告警。
| true |
SuccessNoticeEnable | boolean | 否 | 成功通知開關 | false |
SendChannel | string | 否 | 報警發送形式,目前只支持 sms。 | sms |
ContactInfo | array<object> | 否 | 任務聯系人信息。 | |
object | 否 | |||
UserPhone | string | 否 | 用戶手機號。 | 1381111**** |
UserName | string | 否 | 用戶名。 | userA |
UserMail | string | 否 | 用戶郵箱。 | test***@***.com |
Ding | string | 否 | 報警聯系人釘釘群機器人 webhook 地址,參考文檔:釘釘開發文檔。 | https://oapi.dingtalk.com/robot/send?access_token=********** |
XAttrs | string | 否 | 如果是 k8s 任務類型,需要配置該參數 Job 任務:{"resource":"job"} Shell 任務:{"image":"busybox","resource":"shell"} | {"resource":"shell","fileFormat":"unix","templateType":"customTemplate"} |
Template | string | 否 | k8s 任務類型自定義任務模版 | apiVersion: v1 kind: Pod metadata: name: schedulerx-node-{JOB_ID} namespace: {NAMESPACE} spec: containers: - name: node-job image: node:16 imagePullPolicy: IfNotPresent volumeMounts: - name: script-node mountPath: script/node command: ["node", "script/node/node-{JOB_ID}.js"] volumes: - name: script-node configMap: name: schedulerx-configmap items: - key: schedulerx-node-{JOB_ID} path: node-{JOB_ID}.js restartPolicy: Never |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "job type is java className can not be blank",
"RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Success": true,
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-06-07 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-30 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2022-12-26 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2022-09-28 | API 內部配置變更,不影響調用 | 查看變更詳情 |