返回任务实例的信息,可以查看任务实例的状态和进度。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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": ""
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-03-30 | API 内部配置变更,不影响调用 | 查看变更详情 |