調用GetJobInfo API擷取任務詳情-分布式任務調度-阿里雲

擷取指定Jobid任務詳情，通常用來更新任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

edas:ReadSchedulerxJobQuery

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
JobId	integer	是	任務 ID，在控制台的任務管理頁面中擷取。	92583
GroupId	string	是	應用 ID，在控制台的應用管理頁面中擷取。	testSchedulerx.defaultGroup
Namespace	string	是	命名空間 ID，在控制台的命名空間頁面中擷取。	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	否	特殊第三方才需要填寫。	schedulerx
RegionId	string	是	地區 ID。	cn-hangzhou
JobName	string	否	任務名稱。	simpleJob

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	返回碼。	200
Message	string	錯誤資訊，僅錯誤時返回錯誤資訊。	jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestId	string	請求唯一 ID。	4F68ABED-AC31-4412-9297-D9A8F0401108
Success	boolean	擷取任務詳情是否成功。取值如下： true：擷取任務詳情成功。 false：擷取任務詳情失敗。	true
Data	object	指定任務資訊。
JobConfigInfo	object	任務配置資訊。
JobId	integer	任務 ID。	538039
Status	integer	任務狀態。取值如下： 1：啟用，可以被正常觸發。 0：禁用，不會被觸發。	1
Parameters	string	使用者自訂參數，運行時可以擷取。	test
Description	string	任務描述。	test
ExecuteMode	string	任務執行模式，目前包含以下幾種任務執行模式：單機運行：standalone 廣播運行：broadcatst 並行計算：parallel 記憶體網格：grid 格線運算：batch 分區運行：shard	standalone
MaxConcurrency	string	最大同時運行執行個體數量，預設值為 1，即上次觸發沒有運行結束，即使到了運行時刻也不會進行下次觸發。	1
Name	string	任務名稱。	helloworld
MaxAttempt	integer	錯誤最大重試次數，根據業務需求填寫，預設值為 0。	0
Content	string	指令碼類型任務的指令碼。	echo "clear" > /home/admin/edas-container/logs/catalina.out
JarUrl	string	上傳到 OSS 的完整路徑。如果選擇 JAR 包運行，可以將相應 JAR 包上傳到 OSS 的該路徑下。	https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar
ClassName	string	任務介面類完整路徑，僅是 Java 類型任務時有該欄位。	com.alibaba.test.helloword
JobType	string	任務類型	java
AttemptInterval	integer	錯誤稍候再試時間，單位 s，預設值為 30。	30
MapTaskXAttrs	object	進階配置，僅限於並行計算、記憶體網格和格線運算使用。
TaskMaxAttempt	integer	子任務失敗重試次數。	0
TaskAttemptInterval	integer	子任務失敗稍候再試。	0
ConsumerSize	integer	單機單次觸發執行線程數，預設值為 5。	5
QueueSize	integer	子任務隊列緩衝上限，預設值為 10000。	10000
DispatcherSize	integer	子任務分發線程數，預設值為 5。	5
PageSize	integer	並行任務單次拉取子任務數，預設值為 100。	100
TimeConfig	object	時間配置資訊。
Calendar	string	cron 類型可以選擇填寫自訂日曆。	工作日
TimeType	integer	時間配置類型，目前支援以下幾種時間類型： cron：1 fix_rate：3 second_delay：4 one_time ：5 api：100	1
DataOffset	integer	cron 類型可以選擇時間位移，單位為秒（s）。	0
TimeExpression	string	時間運算式，目前支援以下幾種時間表達類型： api：無時間運算式。 fix_rate：具體固定頻率值，如 30 表示每隔 30s 觸發一次。 cron：標準的 cron 運算式。 second_delay：固定延遲多少秒執行一次（1s~60s 可選）。	0 0/10 * * * ?
JobMonitorInfo	object	任務監控資訊。
ContactInfo	array<object>	連絡人資訊。
	object
UserPhone	string	使用者手機號。	1381111****
UserName	string	使用者名稱。	userA
UserMail	string	使用者郵件地址。	user@demo.com
Ding	string	DingTalk Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
MonitorConfig	object	警示開關以及閾值配置。
Timeout	integer	逾時閾值，單位為秒（s），預設值為 7200。	12300
SendChannel	string	警示發送形式，目前只支援 sms。	sms
TimeoutKillEnable	boolean	逾時終止本次觸發開關，預設關閉。	true
TimeoutEnable	boolean	逾時警示開關。取值如下： true：開啟逾時警示開關。 false：關閉逾時警示開關。	true
FailEnable	boolean	失敗警示開關。取值如下： true：開啟失敗警示開關。 false：關閉失敗警示開關。	true
MissWorkerEnable	boolean	是否開啟無可用機器警示。	true
XAttrs	string	任務擴充欄位	{"pageSize":5,"queueSize":10,"consumerSize":5,"dispatcherSize":5,"taskMaxAttempt":0,"taskAttemptInterval":0,"globalConsumerSize":1000,"taskDispatchMode":"push"}

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Data": {
    "JobConfigInfo": {
      "JobId": 538039,
      "Status": 1,
      "Parameters": "test",
      "Description": "test",
      "ExecuteMode": "standalone",
      "MaxConcurrency": "1",
      "Name": "helloworld",
      "MaxAttempt": 0,
      "Content": "echo \"clear\" > /home/admin/edas-container/logs/catalina.out ",
      "JarUrl": "https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar",
      "ClassName": "com.alibaba.test.helloword",
      "JobType": "java",
      "AttemptInterval": 30,
      "MapTaskXAttrs": {
        "TaskMaxAttempt": 0,
        "TaskAttemptInterval": 0,
        "ConsumerSize": 5,
        "QueueSize": 10000,
        "DispatcherSize": 5,
        "PageSize": 100
      },
      "TimeConfig": {
        "Calendar": "工作日",
        "TimeType": 1,
        "DataOffset": 0,
        "TimeExpression": "0 0/10 * * * ?"
      },
      "JobMonitorInfo": {
        "ContactInfo": [
          {
            "UserPhone": "1381111****",
            "UserName": "userA",
            "UserMail": "user@demo.com",
            "Ding": "https://oapi.dingtalk.com/robot/send?access_token=XXXXXX"
          }
        ],
        "MonitorConfig": {
          "Timeout": 12300,
          "SendChannel": "sms",
          "TimeoutKillEnable": true,
          "TimeoutEnable": true,
          "FailEnable": true,
          "MissWorkerEnable": true
        }
      },
      "XAttrs": "{\"pageSize\":5,\"queueSize\":10,\"consumerSize\":5,\"dispatcherSize\":5,\"taskMaxAttempt\":0,\"taskAttemptInterval\":0,\"globalConsumerSize\":1000,\"taskDispatchMode\":\"push\"}"
    }
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。