获取实时同步任务和同步解决方案任务的运行状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
是 |
DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 |
10000 |
| TaskType |
string |
是 |
目标数据源所关联的数据集成同步任务的任务类型。取值如下:
|
DI_REALTIME |
| FileId |
integer |
是 |
您可以调用 ListFiles 接口获取任务 ID。 |
100 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
数据集成同步任务返回的数据结构。 |
||
| Success |
boolean |
请求是否成功。取值如下:
|
true |
| RequestId |
string |
请求 ID。用于定位日志,排查问题。 |
0bc1411515937635973**** |
| Data |
object |
获取同步任务的运行状态。 |
|
| Status |
string |
|
RUN |
| Message |
string |
获取同步任务运行状态失败后的原因描述。如果获取数据集成同步任务成功,则该参数的返回值为空。 |
fileId[100] is invalid |
| Name |
string |
|
streamx_name |
| SolutionInfo |
object |
|
|
| Status |
string |
同步解决方案运行状态。 |
run |
| Id |
integer |
同步解决方案任务 ID。 |
100 |
| CreatorName |
string |
同步解决方案任务创建者名称。 |
dataworks_3h1 |
| StepDetail |
array<object> |
同步解决方案任务运行步骤详情。 |
|
|
object |
数据集成同步任务返回的数据结构。 |
||
| Status |
string |
同步解决方案运行步骤的状态。 |
success |
| StepId |
integer |
同步解决方案运行步骤的 ID。 |
1 |
| StepName |
string |
同步解决方案运行步骤的名称。 |
Create a base table |
| Info |
string |
同步解决方案运行信息 |
{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"} |
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "0bc1411515937635973****",
"Data": {
"Status": "RUN",
"Message": "fileId[100] is invalid",
"Name": "streamx_name",
"SolutionInfo": {
"Status": "run",
"Id": 100,
"CreatorName": "dataworks_3h1",
"StepDetail": [
{
"Status": "success",
"StepId": 1,
"StepName": "Create a base table",
"Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
}
]
}
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Param.Invalid | The parameter is invalid. | 参数错误 |
| 500 | InternalError.System | An internal error occurred. | 内部报错 |
| 403 | Forbidden.Access | Access is forbidden. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。