调用GetStructSyncJobDetail获取结构同步的任务详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
OrderId Long 4324321

工单号。

Tid Long 1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见 查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 48602B78-0DDF-414C-8688-70CAB6070115

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

StructSyncJobDetail object

结构同步任务详情。

JobStatus String DBTASK_SUCCESS

任务状态,取值和说明如下:

  • NEW:新创建。
  • COMPARING:正在对比结构。
  • COMPARE_BREAK:对比手动中断。
  • COMPARE_FINISH:对比完成。
  • NOT_SCRIPTS:对比完成, 没有可执行脚本。
  • SUBMITED_DBTASK:已提交DBTask。
  • DBTASK_SUCCESS:DBTask执行成功。
  • SUBMITED_WORKFLOW:提交审批。
  • WORKFLOW_SUCCESS:审批结束。
Message String test

任务描述信息。

TableAnalyzed Long 2

已经分析的表。

TableCount Long 2

表的总数。

SqlCount Long 1

SQL总数。

ExecuteCount Long 1

已执行的SQL数量。

SecurityRule String WITHOUT_APPROVE

安全规则描述,取值:

  • CANNOT_SYNC:不允许同步。
  • WITH_APPROVE:需通过审批后进行同步,可调用SubmitStructSyncOrderApproval接口发起审批流程。
  • WITHOUT_APPROVE:不需要审批即可进行同步。
DBTaskGroupId Long 12345

SQL任务分组ID。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?OrderId=4324321
&Tid=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetStructSyncJobDetailResponse>
    <RequestId>C29D0A5F-BB9B-4CB9-A6B7-19B5433983CA</RequestId>
    <StructSyncJobDetail>
        <JobStatus>COMPARE_FINISH</JobStatus>
        <Message>结构对比完成, 预览SQL已经生成</Message>
        <TableAnalyzed>6</TableAnalyzed>
        <TableCount>6</TableCount>
        <SecurityRule>WITH_APPROVE</SecurityRule>
        <DBTaskGroupId>3000000</DBTaskGroupId>
    </StructSyncJobDetail>
    <Success>true</Success>
</GetStructSyncJobDetailResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C29D0A5F-BB9B-4CB9-A6B7-19B5433983CA",
  "StructSyncJobDetail" : {
    "JobStatus" : "COMPARE_FINISH",
    "Message" : "结构对比完成, 预览SQL已经生成",
    "TableAnalyzed" : 6,
    "TableCount" : 6,
    "SecurityRule" : "WITH_APPROVE",
    "DBTaskGroupId" : 3000000
  },
  "Success" : true
}

错误码

访问错误中心查看更多错误码。