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

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListSQLReviewOriginSQL

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OrderId	integer	是	SQL 审核工单号。您可以调用 CreateSQLReviewOrder 接口获取该参数。	903****
OrderActionDetail	object	否	工单参数（过滤条件）。
FileId	integer	否	审核文件 ID。	85****
SQLReviewResult	string	否	SQL 审核优化建议。取值如下： MUST_IMPROVE：必须改进。 POTENTIAL_ISSUE：潜在问题。 SUGGEST_IMPROVE：建议改进。 USE_DMS_TOOLKIT：使用无锁结构变更。 USE_DMS_DML_UNLOCK：使用无锁数据变更。 TABLE_INDEX_SUGGEST：索引推荐。	MUST_IMPROVE
CheckStatusResult	string	否	检测结果。取值及说明如下： new：等待分析。 unknown：解析异常。 check_not_pass：检测不通过。 check_pass：检测通过。 force_pass：人工通过。 force_not_pass：人工不通过。	check_not_pass
Page	object	否	分页参数。
PageNumber	integer	否	从第几页开始。	1
PageSize	integer	否	每页数据量。	20
Tid	integer	否	租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数。	233***

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，用于定位日志，排查问题。	0A00863F-6366-5583-9B96-891DC8D8F88A
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	调用 API 失败时，返回的错误信息。	UnknownError
Success	boolean	请求是否成功。返回值及说明如下： true：请求成功。 false：请求失败。	true
TotalCount	integer	文件中所包含的 SQL 条数。	1
OriginSQLList	array<object>	解析的 SQL 列表。
	object	单条 SQL 详情。
SQLId	integer	SQL 语句 ID。	1111
FileId	integer	文件 ID。	858***
FileName	string	文件名。	test.sql
SQLContent	string	文件中的 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;
CheckStatus	string	检测结果。返回值及说明如下： new：等待分析。 unknown：解析异常。 check_not_pass：检测不通过。 check_pass：检测通过。 force_pass：人工通过。 force_not_pass：人工不通过。	check_pass
StatusDesc	string	检测结果描述。	检测通过
CheckedTime	string	SQL 检测时间。	2021-06-09 21:07:00
SqlHash	string	对 SQL 内容进行 MD5 散列算法后得到的值。	c7992dc1b681c6733894aded7834f423
ReviewSummary	string	SQL 审核优化建议的统计信息（JSON 字符串）。返回值及说明如下： MUST_IMPROVE：必须改进。 POTENTIAL_ISSUE：潜在问题。 SUGGEST_IMPROVE：建议改进。 USEDMSTOOLKIT：使用无锁结构变更。 USEDMSDML_UNLOCK：使用无锁数据变更。 TABLEINDEXSUGGEST：索引推荐。	{\"SUGGEST_IMPROVE\":2,\"POTENTIAL_ISSUE\":1}
SQLReviewQueryKey	string	查询 SQL 审核优化建议信息的 Key。根据此 Key 调用 GetSQLReviewOptimizeDetail 接口获取详情。	6e9a4bc6867a4174a96b23c8b48b****
SQLName	string	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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。