返回任務實例的信息,可以查看任務實例的狀態和進度。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
edas:ReadSchedulerxJobInstanceQuery | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 區域 ID | cn-hangzhou |
Namespace | string | 是 | 命名空間 id,在控制臺的命名空間頁面中獲取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
GroupId | string | 是 | 應用 id,在控制臺的應用管理頁面中獲取。 | testSchedulerx.defaultGroup |
JobId | long | 是 | 任務 ID,在控制臺的任務管理頁面中獲取。 | 92583 |
JobInstanceId | long | 是 | 任務實例 ID | 1685883418 |
NamespaceSource | string | 否 | 特殊第三方才需要填寫。 | schedulerx |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "jobId=xxx is not existed",
"RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Success": true,
"Data": {
"JobInstanceDetail": {
"Status": 4,
"Progress": "{\"taskProgress\":[{\"name\":\"MAP_TASK_ROOT\",\"total\":1,\"pulled\":1,\"running\":0,\"success\":0,\"failed\":0}],\"workerProgress\":[{\"workerAddr\":\"11.122.241.245:34865\",\"total\":1,\"pulled\":1,\"running\":0,\"success\":0,\"failed\":0}]}",
"Result": "{'TotalSize': 31, 'CurrentPage': 5, 'PageSize': 10}",
"InstanceId": 1189853849,
"TimeType": 1,
"TriggerType": 1,
"EndTime": "2020-07-27 11:52:10",
"StartTime": "2020-07-27 11:52:10",
"Executor": "張三\n",
"JobId": 92583,
"ScheduleTime": "2020-07-27 11:52:10",
"DataTime": "2020-07-27 11:52:10",
"WorkAddr": "192.168.0.0:16",
"Parameters": "{\\\"alertId\\\":11111}",
"JobName": "ManualJob",
"TraceId": "210e845016596663430048015d0a2c"
}
},
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-07-17 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-03-30 | API 內部配置變更,不影響調用 | 查看變更詳情 |