返回任务实例的信息，可以查看任务实例的状态和进度。
调试
您可以在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 内部配置变更，不影响调用 | 查看变更详情 |