首页 数据管理 DMS API参考 API目录 工单操作 数据变更 ListDataCorrectPreCheckSQL - 获预检查环节的SQL详情

ListDataCorrectPreCheckSQL - 获预检查环节的SQL详情

获取数据变更工单中预检查环节的SQL信息列表。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListDataCorrectPreCheckSQLRead
    全部资源

请求参数

名称类型必填描述示例值
OrderIdlong

数据变更工单ID,可通过调用接口ListOrders获取该参数的值。

453****
PageNumberlong

第几页。

1
PageSizelong

每页数据量。

10
DbIdlong

数据库ID(DatabaseId),数据库分为物理库和逻辑库两种:

1930****
Tidlong

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

3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

31853A2B-DC9D-5B39-8492-D2AC8BCF550E
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
PreCheckSQLListarray

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

object

预检查环节的SQL详情。

CheckSQLstring

SQL语句。

CheckSQL": "OPTIMIZE TABLE `Text_TableNames`
AffectRowslong

预估影响行数。

0
DbIdlong

数据库ID。

1930****
SQLReviewQueryKeystring

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

b9e771fc6ec247dea6d06a32c777****
SqlReviewStatusstring

SQL审核状态,返回值如下:

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

SQL类型,例如,DELETE、UPDATE、ALTER_TABLE等。

OPTIMIZE
TableNamesstring

数据变更的表名。

Text_TableNames

示例

正常返回示例

JSON格式

{
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PreCheckSQLList": [
    {
      "CheckSQL": "CheckSQL\": \"OPTIMIZE TABLE `Text_TableNames`",
      "AffectRows": 0,
      "DbId": 0,
      "SQLReviewQueryKey": "b9e771fc6ec247dea6d06a32c777****",
      "SqlReviewStatus": "WAITING",
      "SqlType": "OPTIMIZE",
      "TableNames": "Text_TableNames"
    }
  ]
}

错误码

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

阿里云首页 数据管理 DMS 相关技术圈