该接口用于查询数据库结构导入任务的详细信息。
接口说明
CreateDataImportTask 接口用于创建数据导入任务，支持将存储在 OSS、ECS 或直接传入的 SQL/CSV 文件导入到目标数据库实例中。通过指定实例 ID、数据库名、引擎类型、数据来源（如 OSS 路径）及导入类型，系统将异步或同步执行数据写入操作，适用于数据迁移、初始化和补录等场景，返回任务 ID 以便后续状态查询与管理。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardbx:DescribeStructureImportTaskInfo |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所在地域。 |
cn-shanghai |
| SlinkTaskId |
string |
是 |
目标任务 id。 |
etx-szr2rr6i***** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 id。 |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
| Message |
string |
返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。 |
success |
| Data |
object |
返回结果集。 |
|
| StructureImportResult |
object |
结构导入任务的导入结果。 |
|
| Status |
string |
导入状态。 |
finish |
| FinishedNum |
integer |
已完成的记录数。 |
118 |
| TotalNum |
integer |
结果总数。 |
1 |
| ExceptionFullTableName |
string |
异常的表名。 |
hash_realtime_new.wm_in_job_et |
| ExceptionDetail |
string |
异常原因。 |
java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement |
| Percentage |
integer |
当前进度（百分比）。 |
100 |
| SlinkStage |
string |
slink 状态。 |
STRUCTURE_IMPORT |
| Success |
boolean |
请求是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Message": "success",
"Data": {
"StructureImportResult": {
"Status": "finish",
"FinishedNum": 118,
"TotalNum": 1,
"ExceptionFullTableName": "hash_realtime_new.wm_in_job_et",
"ExceptionDetail": "java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement",
"Percentage": 100
},
"SlinkStage": "STRUCTURE_IMPORT"
},
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。