全部产品
Search
文档中心

数据管理 DMS:ListDataImportSQLPreCheckDetail - 获取数据导入预检SQL详情

更新时间:Nov 06, 2024

获取数据导入预检SQL详情。

接口说明

仅支持导入模式为安全模式的数据导入工单使用此 API,不支持极速模式的数据导入使用此 API。

调试

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

授权信息

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

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

请求参数

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

工单 ID,您可调用 ListOrders 接口获取该参数的值。

11****
SqlTypestring

SQL 类型,常见 SQL 类型取值说明如下:

  • SELECT:查询
  • INSERT:插入
  • DELETE:删除
  • CREATE_TABLE:创建表
说明 您可以在顶部菜单栏中,选择安全与规范>操作审计,查看更多 SQL 类型取值。
INSERT
StatusCodestring

工单状态。若不填,则默认选择所有状态,其他取值如下:

  • INIT:初始化。
  • RUNNING:执行中。
  • SUCCESS:已完成。
  • TIMEOUT:超时跳过。
  • FAIL:已失败。
SUCCESS
PageNumerlong

页码,从 1 开始。

1
PageSizelong

每页数据量。

20
Tidlong

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

1

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。可用于定位日志,排查问题。

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

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

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

调用失败时,返回的错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
PreCheckSQLDetailListarray<object>

预检查 SQL 详情列表。

PreCheckSQLDetailobject

预检查 SQL 详情。

SqlIdlong

SQL ID,表示是第几个 SQL,从 1 开始。

1
SqlTypestring

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

INSERT
StatusCodestring

工单状态。取值如下:

  • INIT:初始化。
  • RUNNING:执行中。
  • SUCCESS:已完成。
  • TIMEOUT:超时跳过。
  • FAIL:已失败。
SUCCESS
Skipboolean

是否存在跳过预检查 SQL 的情况。取值如下:

  • true:存在。
  • false:不存在。
true
TotalCountlong

SQL 条数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PreCheckSQLDetailList": [
    {
      "SqlId": 1,
      "SqlType": "INSERT",
      "StatusCode": "SUCCESS",
      "Skip": true
    }
  ],
  "TotalCount": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史