ListSQLReviewOriginSQL - 数据管理 DMS

关于该功能的更多说明，请参见SQL审核。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListSQLReviewOriginSQL	系统规定参数。取值：ListSQLReviewOriginSQL。
OrderId	Long	是	123321	工单号。您可以调用CreateSQLReviewOrder接口获取该参数。
OrderActionDetail	Object	否		工单参数（过滤条件）。
FileId	Long	否	123345	审核文件ID。
SQLReviewResult	String	否	MUST_IMPROVE	SQL审核优化建议。取值如下： MUST_IMPROVE：必须改进。 POTENTIAL_ISSUE：潜在问题。 SUGGEST_IMPROVE：建议改进。 USE_DMS_TOOLKIT：使用无锁结构变更。 USE_DMS_DML_UNLOCK：使用无锁数据变更。 TABLE_INDEX_SUGGEST：索引推荐。
CheckStatusResult	String	否	check_not_pass	检测结果。取值如下： new：等待分析 unknown：解析异常 check_not_pass：检测不通过 check_pass：检测通过 force_pass：人工通过 force_not_pass：人工不通过
Page	Object	否		分页参数。
PageNumber	Integer	否	1	第几页。
PageSize	Integer	否	20	每页数据量。
Tid	Long	否	1	租户ID。您可以调用GetUserActiveTenant或ListUserTenants接口获取该参数。
RegionId	String	否	cn-hangzhou	选择DMS的服务地域。取值请参见RegionID参数说明。说明请根据应用所在地就近选择。

返回数据


名称	类型	示例值	描述
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	请求ID。
ErrorCode	String	UnknownError	错误码。
ErrorMessage	String	UnknownError	错误信息。
Success	Boolean	true	请求是否成功。
TotalCount	Integer	10	总SQL条数。
OriginSQLList	Array of OriginSQLList		解析的SQL列表。
SQLId	Long	1111	SQL语句ID。
FileId	Long	123321	文件ID。
FileName	String	test.sql	文件名。
SQLContent	String	select id from table_name	SQL内容。
CheckStatus	String	check_pass	检测结果。返回值如下： new：等待分析。 unknown：解析异常。 check_not_pass：检测不通过。 check_pass：检测通过。 force_pass：人工通过。 force_not_pass：人工不通过。
StatusDesc	String	检测通过	检测结果描述。
CheckedTime	String	2021-06-09 21:07:00	检测时间。
SqlHash	String	95adb6e77a0884d9e50232cb8c5c969d	SQL内容的MD5值。
ReviewSummary	String	{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}	SQL审核优化建议的统计信息（Json字符串）。统计信息如下： MUST_IMPROVE：必须改进。 POTENTIAL_ISSUE：潜在问题。 SUGGEST_IMPROVE：建议改进。 USEDMSTOOLKIT：使用无锁结构变更。 USEDMSDML_UNLOCK：使用无锁数据变更。 TABLEINDEXSUGGEST：索引推荐。
SQLReviewQueryKey	String	a57e54ec5433475ea3082d882fdb89c5	SQL审核优化建议详情信息的查询KEY。根据此KEY调用GetSQLReviewOptimizeDetail获取详情。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSQLReviewOriginSQL
&OrderId=123321
&OrderActionDetail={"FileId":123345,"SQLReviewResult":"MUST_IMPROVE","CheckStatusResult":"check_not_pass","Page":{"PageNumber":1,"PageSize":20}}
&Tid=1
&公共请求参数

正常返回示例

XML格式

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

<ListSQLReviewOriginSQLResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
    <TotalCount>10</TotalCount>
    <OriginSQLList>
        <SQLId>1111</SQLId>
        <FileId>123321</FileId>
        <FileName>test.sql</FileName>
        <SQLContent>select id from table_name</SQLContent>
        <CheckStatus>check_pass</CheckStatus>
        <StatusDesc>检测通过</StatusDesc>
        <CheckedTime>2021-06-09 21:07:00</CheckedTime>
        <SqlHash>95adb6e77a0884d9e50232cb8c5c969d</SqlHash>
        <ReviewSummary>{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}</ReviewSummary>
        <SQLReviewQueryKey>a57e54ec5433475ea3082d882fdb89c5</SQLReviewQueryKey>
    </OriginSQLList>
</ListSQLReviewOriginSQLResponse>

JSON格式

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

{
  "RequestId" : "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true,
  "TotalCount" : 10,
  "OriginSQLList" : [ {
    "SQLId" : 1111,
    "FileId" : 123321,
    "FileName" : "test.sql",
    "SQLContent" : "select id from table_name",
    "CheckStatus" : "check_pass",
    "StatusDesc" : "检测通过",
    "CheckedTime" : "2021-06-09 21:07:00",
    "SqlHash" : "95adb6e77a0884d9e50232cb8c5c969d",
    "ReviewSummary" : "{\"POTENTIAL_ISSUE\":1,\"SUGGEST_IMPROVE\":1}",
    "SQLReviewQueryKey" : "a57e54ec5433475ea3082d882fdb89c5"
  } ]
}

错误码

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