全部产品
Search

搜索本产品

    数据管理 DMS：ListSQLReviewOriginSQL - 获取SQL审核工单的SQL详情

    文档中心

    数据管理 DMS：ListSQLReviewOriginSQL - 获取SQL审核工单的SQL详情

    更新时间：Nov 06, 2024

    获取SQL审核工单的SQL详情结果。

    接口说明

    SQL 审核功能的更多信息，请参见 SQL 审核。

    调试

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

    授权信息

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

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

    请求参数

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

    SQL 审核工单号。您可以调用 CreateSQLReviewOrder 接口获取该参数。

    		903****
    OrderActionDetailobject否

    工单参数（过滤条件）。

    FileIdlong否

    审核文件 ID。

    		85****
    SQLReviewResultstring否

    SQL 审核优化建议。取值如下：

    • MUST_IMPROVE：必须改进。
    • POTENTIAL_ISSUE：潜在问题。
    • SUGGEST_IMPROVE：建议改进。
    • USE_DMS_TOOLKIT：使用无锁结构变更。
    • USE_DMS_DML_UNLOCK：使用无锁数据变更。
    • TABLE_INDEX_SUGGEST：索引推荐。
    		MUST_IMPROVE
    CheckStatusResultstring否

    检测结果。取值及说明如下：

    • new：等待分析。
    • unknown：解析异常。
    • check_not_pass：检测不通过。
    • check_pass：检测通过。
    • force_pass：人工通过。
    • force_not_pass：人工不通过。
    		check_not_pass
    Pageobject否

    分页参数。

    PageNumberinteger否

    从第几页开始。

    		1
    PageSizeinteger否

    每页数据量。

    		20
    Tidlong否

    租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数。

    		233***

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

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

    		0A00863F-6366-5583-9B96-891DC8D8F88A
    ErrorCodestring

    错误码。

    		UnknownError
    ErrorMessagestring

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

    		UnknownError
    Successboolean

    请求是否成功。返回值及说明如下：

    • true：请求成功。
    • false：请求失败。
    		true
    TotalCountinteger

    文件中所包含的 SQL 条数。

    		1
    OriginSQLListarray<object>

    解析的 SQL 列表。

    OriginSQLListobject

    单条 SQL 详情。

    SQLIdlong

    SQL 语句 ID。

    		1111
    FileIdlong

    文件 ID。

    		858***
    FileNamestring

    文件名。

    		test.sql
    SQLContentstring

    文件中的 SQL 内容。

    		CREATE TABLE `test_sql_review_table` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `gmt_create` datetime NOT NULL, `name` varchar(256) DEFAULT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
    CheckStatusstring

    检测结果。返回值及说明如下：

    • new：等待分析。
    • unknown：解析异常。
    • check_not_pass：检测不通过。
    • check_pass：检测通过。
    • force_pass：人工通过。
    • force_not_pass：人工不通过。
    		check_pass
    StatusDescstring

    检测结果描述。

    		检测通过
    CheckedTimestring

    SQL 检测时间。

    		2021-06-09 21:07:00
    SqlHashstring

    对 SQL 内容进行 MD5 散列算法后得到的值。

    		c7992dc1b681c6733894aded7834f423
    ReviewSummarystring

    SQL 审核优化建议的统计信息（JSON 字符串）。返回值及说明如下：

    • MUST_IMPROVE：必须改进。
    • POTENTIAL_ISSUE：潜在问题。
    • SUGGEST_IMPROVE：建议改进。
    • USEDMSTOOLKIT：使用无锁结构变更。
    • USEDMSDML_UNLOCK：使用无锁数据变更。
    • TABLEINDEXSUGGEST：索引推荐。
    		{\"SUGGEST_IMPROVE\":2,\"POTENTIAL_ISSUE\":1}
    SQLReviewQueryKeystring

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

    		6e9a4bc6867a4174a96b23c8b48b****
    SQLNamestring

    SQL 名称。

    		getByPk

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0A00863F-6366-5583-9B96-891DC8D8F88A",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 1,
  "OriginSQLList": [
    {
      "SQLId": 1111,
      "FileId": 0,
      "FileName": "test.sql",
      "SQLContent": "CREATE TABLE `test_sql_review_table` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,\n  `gmt_create` datetime NOT NULL,\n  `name` varchar(256) DEFAULT NULL\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;",
      "CheckStatus": "check_pass",
      "StatusDesc": "检测通过",
      "CheckedTime": "2021-06-09 21:07:00",
      "SqlHash": "c7992dc1b681c6733894aded7834f423",
      "ReviewSummary": "{\\\"SUGGEST_IMPROVE\\\":2,\\\"POTENTIAL_ISSUE\\\":1}",
      "SQLReviewQueryKey": "6e9a4bc6867a4174a96b23c8b48b****",
      "SQLName": "getByPk"
    }
  ]
}

    错误码

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

    变更历史

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