调用GetStructSyncOrderDetail获取结构同步的工单详情信息。

调试

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

请求参数

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

工单号。

Tid Long 1

租户ID。

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String 4E1D2B4D-3E53-4ABC-999D-1D2520B3471A

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

StructSyncOrderDetail object

结构同步工单详情。

SourceDatabaseInfo object

源库信息。

DbId Long 432532

库ID。

SearchName String test

库搜索名。

DbType String MySQL

数据库类型。

EnvType String dev

实例的环境类型,更多信息,请参见实例环境说明

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
TargetDatabaseInfo object

目标库信息。

DbId Long 432543

库ID。

SearchName String test

库搜索名。

DbType String MySQL

数据库类型。

EnvType String dev

实例的环境类型,更多信息,请参见实例环境说明

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
SourceType String VERSION

表结构类型,取值和说明如下:

  • DATASOURCE:系统默认的最新版。
  • VERSION:手动输入的历史版本。
SourceVersionInfo object

源版本信息。

说明 仅当 SourceTypeVERSION时显示。
VersionId String e179bbb8163dcdcfacda24858bedb4d8006ae2b8

版本号。

TargetType String DATASOURCE

表结构类型,取值和说明如下:

  • DATASOURCE:系统默认的最新版。
  • VERSION:手动输入的历史版本。
TargetVersionInfo object

目标版本信息。

说明 仅当 SourceTypeVERSION时显示。
VersionId String e179bbb8163dcdcfacda24858bedb4d8006ae2b8

版本号。

TableInfoList Array of TableInfo

同步的表信息。

SourceTableName String test_tbl

源表表名。

TargetTableName String test_tbl

目标表表名。

IgnoreError Boolean false

是否忽略报错,取值:

  • true:忽略,遇到错误会跳过当前失败SQL脚本,继续执行。
  • false:不忽略,遇到出错则中断后面的SQL脚本,不再执行。

示例

请求示例

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

正常返回示例

XML格式

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

<GetStructSyncOrderDetailResponse>
    <RequestId>CA4E966B-1A57-4230-B0BB-CBB9CAF2CEDC</RequestId>
    <StructSyncOrderDetail>
        <SourceDatabaseInfo>
            <SearchName>poc_dev@rm-uxxxxx.mysql.rds.aliyuncs.com:3306</SearchName>
            <DbId>800000</DbId>
            <Logic>false</Logic>
            <EnvType>dev</EnvType>
            <DbType>mysql</DbType>
        </SourceDatabaseInfo>
        <SourceType>DATASOURCE</SourceType>
        <TargetType>DATASOURCE</TargetType>
        <IgnoreError>false</IgnoreError>
        <TargetDatabaseInfo>
            <SearchName>film@rm-uf64xxxxe.mysql.rds.aliyuncs.com:3306</SearchName>
            <DbId>700000</DbId>
            <Logic>false</Logic>
            <EnvType>dev</EnvType>
            <DbType>mysql</DbType>
        </TargetDatabaseInfo>
        <TableInfoList>
            <SourceTableName>*</SourceTableName>
            <TargetTableName>*</TargetTableName>
        </TableInfoList>
    </StructSyncOrderDetail>
    <Success>true</Success>
</GetStructSyncOrderDetailResponse>

JSON格式

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

{
  "RequestId" : "CA4E966B-1A57-4230-B0BB-CBB9CAF2CEDC",
  "StructSyncOrderDetail" : {
    "SourceDatabaseInfo" : {
      "SearchName" : "poc_dev@rm-uxxxxx.mysql.rds.aliyuncs.com:3306",
      "DbId" : 800000,
      "Logic" : false,
      "EnvType" : "dev",
      "DbType" : "mysql"
    },
    "SourceType" : "DATASOURCE",
    "TargetType" : "DATASOURCE",
    "IgnoreError" : false,
    "TargetDatabaseInfo" : {
      "SearchName" : "film@rm-uf64xxxxe.mysql.rds.aliyuncs.com:3306",
      "DbId" : 700000,
      "Logic" : false,
      "EnvType" : "dev",
      "DbType" : "mysql"
    },
    "TableInfoList" : [ {
      "SourceTableName" : "*",
      "TargetTableName" : "*"
    } ]
  },
  "Success" : true
}

错误码

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