获取数据集成实时同步任务和同步解决方案的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 | 10000 |
| TaskType | string | 是 | 目标数据源所关联的数据集成同步任务的任务类型。取值如下：
| DI_REALTIME |
| FileId | long | 是 |
您可以调用 ListFiles 接口获取任务 ID。 | 100 |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "0bc1411515937635973****\t",
"Data": {
"Code": {
"extend": {
"mode": "wizard",
"resourceGroup": "S_res_group_287114642182658_1560324290517"
},
"nodeDef": {},
"order": {
"hops": [
{
"from": "datahub_8htXSsfiS2vtZCVG",
"to": "datahub_CRHBAyGfhSaLmv2f"
}
]
},
"setting": {
"errorLimit": {},
"jvmOption": ""
},
"steps": [
{
"stepType": "datahub",
"category": "writer",
"displayName": "DataHub1",
"parameter": {
"batchSize": 1000,
"datasource": "datahub_cloud_dev_test",
"topic": "dwd_tfc_opt_speed_rid_amap_rt"
},
"name": "datahub_CRHBAyGfhSaLmv2f",
"gui": {
"x": 262,
"y": 325
}
},
{
"stepType": "datahub",
"displayName": "DataHub2",
"parameter": {
"datasource": "datahub_uric_test",
"topic": "dwd_tfc_opt_speed_rid_amap_rt_330000",
"batchSize": 1000
},
"name": "datahub_8htXSsfiS2vtZCVG",
"gui": {
"x": 268,
"y": 160.5
},
"category": "writer"
}
]
},
"Status": "success",
"Message": "fileId:[100] is invalid.",
"AlarmList": [
{
"Id": 45242,
"Enabled": true,
"RuleName": "Delay alert rule name 1",
"Metric": "taskStatus",
"Description": "Description",
"AlarmRuleList": [
{
"Level": "WARNING",
"Comparator": "=",
"Threshold": 1,
"Duration": 3,
"Aggregator": "avg"
}
],
"NotifyRule": {
"Interval": 5,
"Warning": [
"Ding"
],
"Critical": [
"Ding"
]
}
}
],
"SolutionDetail": {
"Status": 0,
"Type": "holo",
"StartTime": "2021-12-07 14:40:51",
"CreatorName": "dataworks_di",
"ProjectId": 10000,
"SourceType": "mysql",
"ProcessContent": {
"holoDatasource": "holo",
"offlineSyncConfig": {
"nodeNameRule": "oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}",
"resourceGroup": "group_219193793999490"
},
"processRuleId": 1007,
"readerConcurrent": 10,
"realtimeSyncConfig": {
"content": {
"order": {
"hops": [
{
"from": "reader",
"to": "writer"
}
]
},
"setting": {
"speed": {
"readerConcurrent": 10
}
},
"steps": [
{
"stepType": "mysql",
"name": "reader",
"category": "reader",
"parameter": {
"connection": [
{
"datasource": "mm",
"datasourceType": "mysql",
"table": []
}
]
}
},
{
"stepType": "holo",
"name": "writer",
"category": "writer",
"parameter": {
"datasource": "holo",
"writeMode": "replay",
"datasourceSchema": "public",
"tableMappingRule": {
"datasource": [
{
"tableRule": [],
"srcDatasourceName": "mm"
}
]
}
}
}
]
},
"extend": {
"mode": "migration_holo",
"resourceGroup": "group_219193793999490"
}
},
"setting": {
"autoCreateWorkflow": true,
"userDefinedFileNameExpression": "oneclick"
},
"srcType": "mysql",
"tableMappingRuleFromRealtimeSyncConfig": {
"datasource": [
{
"srcDatasourceName": "mm",
"tableRule": []
}
]
}
},
"Name": "holo_20211206161025",
"ProcessExtra": {
"processType": "new",
"tableNum": 300
},
"SubmitTime": "2021-12-07 14:40:51",
"Id": 100
}
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Param.Invalid | The parameter is invalid. | 参数错误 |
| 403 | Forbidden.Access | Access is forbidden. | - |
| 500 | InternalError.System | An internal error occurred. | 内部报错 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-01-13 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |