调用ListDataCorrectPreCheckSQL获取数据变更工单中预检查环节的SQL详情。

关于该功能的更多说明,请参见普通数据变更

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDataCorrectPreCheckSQL

系统规定参数。取值:ListDataCorrectPreCheckSQL

OrderId Long 12****

数据变更工单号。

PageNumber Long 1

当前页数。

取值范围:大于0的整数。

默认值:1。

PageSize Long 10

每页返回的结果个数。

DbId Long 11****

数据库ID。

Tid Long 1

租户ID。可通过调用GetUserActiveTenantListUserTenants接口获取该参数的值。

RegionId String cn-hangzhou

选择DMS的服务地域。取值请参见RegionID参数说明。

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

返回数据

名称 类型 示例值 描述
RequestId String 4B2520C9-3005-4CCA-9C9B-944254ABEB0B

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

PreCheckSQLList Array of PreCheckSQL

预检查环节的SQL信息列表。

CheckSQL String CREATE TABLE t1 ...

SQL语句。

AffectRows Long 0

预估影响行数。

DbId Long 431253

数据库ID。

SQLReviewQueryKey String b9e771fc6ec247dea6d06a32c777****

SQL审核优化建议详情信息的查询KEY。根据此Key调用GetSQLReviewOptimizeDetail获取SQL审核优化建议的详情。

SqlReviewStatus String PASS

SQL审核状态,取值如下:

  • WAITING:等待审核。
  • RUNNING:正在审核。
  • IGNORE:忽略审核。
  • PASS:审核通过。
  • BLOCK:审核不通过。
SqlType String CREATE_TABLE

SQL类型。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListDataCorrectPreCheckSQL
&OrderId=12345
&PageNumber=1
&PageSize=10
&DbId=111222
&Tid=1
&公共请求参数

正常返回示例

XML格式

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

<ListDataCorrectPreCheckSQLResponse>
    <RequestId>B02A7F37-96D2-4712-9196-4A5C94174A75</RequestId>
    <PreCheckSQLList>
        <CheckSQL>CREATE TABLE IF NOT EXISTS `task_data_2020-10` LIKE task_data</CheckSQL>
        <SqlReviewStatus>PASS</SqlReviewStatus>
        <DbId>8050000</DbId>
        <SqlType>CREATE_TABLE</SqlType>
        <AffectRows>0</AffectRows>
        <SQLReviewQueryKey>4eb7635609c54ced8c584e926aa7****</SQLReviewQueryKey>
    </PreCheckSQLList>
    <Success>true</Success>
</ListDataCorrectPreCheckSQLResponse>

JSON格式

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

{
  "RequestId" : "B02A7F37-96D2-4712-9196-4A5C94174A75",
  "PreCheckSQLList" : [ {
    "CheckSQL" : "CREATE TABLE IF NOT EXISTS `task_data_2020-10` LIKE task_data",
    "SqlReviewStatus" : "PASS",
    "DbId" : 8050000,
    "SqlType" : "CREATE_TABLE",
    "AffectRows" : 0,
    "SQLReviewQueryKey" : "4eb7635609c54ced8c584e926aa7****"
  } ],
  "Success" : true
}

错误码

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