调用GetSQLReviewCheckResultStatus获取SQL审核工单的审核结果。
关于该功能的更多说明,请参见SQL审核。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSQLReviewCheckResultStatus |
系统规定参数。取值:GetSQLReviewCheckResultStatus。 |
OrderId | Long | 是 | 123321 |
工单号,您可以调用CreateSQLReviewOrder接口获取该参数。 |
Tid | Long | 否 | 1 |
租户ID,您可以调用GetUserActiveTenant或ListUserTenants接口获取该参数。 |
RegionId | String | 否 | cn-hangzhou |
选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明。 说明 请根据应用所在地就近选择。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
Id of the request |
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
Success | Boolean | true |
请求是否成功。 |
CheckResultStatus | Object |
SQL审核结果。 |
|
TotalSQLCount | Long | 10 |
总SQL数量,单位:条。 |
CheckedCount | Long | 10 |
已审核SQL数量,单位:条。 |
CheckStatusResult | Object |
检测状态。 |
|
New | Long | 0 |
等待审核的SQL数量,单位:条。 |
Unknown | Long | 0 |
解析异常的SQL数量,单位:条。 |
CheckNotPass | Long | 1 |
检测不通过的SQL数量,单位:条。 |
CheckPass | Long | 8 |
检测通过的SQL数量,单位:条。 |
ForcePass | Long | 1 |
人工通过的SQL数量,单位:条。 |
ForceNotPass | Long | 0 |
人工不通过的SQL数量,单位:条。 |
SQLReviewResult | Object |
SQL审核优化建议。 |
|
MustImprove | Long | 1 |
必须改进的SQL数量,单位:条。 |
PotentialIssue | Long | 0 |
潜在问题的SQL数量,单位:条。 |
SuggestImprove | Long | 3 |
建议改进的SQL数量,单位:条。 |
UseDmsToolkit | Long | 0 |
推荐使用无锁结构变更的SQL数量,单位:条。 |
UseDmsDmlUnlock | Long | 0 |
推荐使用无锁数据变更的SQL数量,单位:条。 |
TableIndexSuggest | Long | 2 |
索引推荐的SQL数量,单位:条。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetSQLReviewCheckResultStatus
&OrderId=123321
&Tid=1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetSQLReviewCheckResultStatusResponse>
<RequestId>E1ABE358-14A0-4DFA-9776-1A3CB59192DF</RequestId>
<CheckResultStatus>
<SQLReviewResult>
<TableIndexSuggest>1</TableIndexSuggest>
<MustImprove>1</MustImprove>
<SuggestImprove>1</SuggestImprove>
<PotentialIssue>2</PotentialIssue>
</SQLReviewResult>
<TotalSQLCount>4</TotalSQLCount>
<CheckedCount>4</CheckedCount>
<CheckStatusResult>
<CheckNotPass>1</CheckNotPass>
<CheckPass>3</CheckPass>
</CheckStatusResult>
</CheckResultStatus>
<Success>true</Success>
</GetSQLReviewCheckResultStatusResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E1ABE358-14A0-4DFA-9776-1A3CB59192DF",
"CheckResultStatus" : {
"SQLReviewResult" : {
"TableIndexSuggest" : 1,
"MustImprove" : 1,
"SuggestImprove" : 1,
"PotentialIssue" : 2
},
"TotalSQLCount" : 4,
"CheckedCount" : 4,
"CheckStatusResult" : {
"CheckNotPass" : 1,
"CheckPass" : 3
}
},
"Success" : true
}
错误码
访问错误中心查看更多错误码。