全部产品
Search
文档中心

数据管理 DMS:GetSQLReviewCheckResultStatus - 获取SQL审核工单的审核结果

更新时间:Mar 28, 2024

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

123321
Tidlong

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

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

true
CheckResultStatusobject

SQL 审核结果。

TotalSQLCountlong

总 SQL 数量,单位:条。

10
CheckedCountlong

已审核 SQL 数量,单位:条。

10
CheckStatusResultobject

检测状态。

Newlong

等待审核的 SQL 数量,单位:条。

0
Unknownlong

解析异常的 SQL 数量,单位:条。

0
CheckNotPasslong

检测不通过的 SQL 数量,单位:条。

1
CheckPasslong

检测通过的 SQL 数量,单位:条。

8
ForcePasslong

人工通过的 SQL 数量,单位:条。

1
ForceNotPasslong

人工不通过的 SQL 数量,单位:条。

0
SQLReviewResultobject

SQL 审核优化建议。

MustImprovelong

必须改进的 SQL 数量,单位:条。

1
PotentialIssuelong

潜在问题的 SQL 数量,单位:条。

0
SuggestImprovelong

建议改进的 SQL 数量,单位:条。

3
UseDmsToolkitlong

推荐使用无锁结构变更的 SQL 数量,单位:条。

0
UseDmsDmlUnlocklong

推荐使用无锁数据变更的 SQL 数量,单位:条。

0
TableIndexSuggestlong

索引推荐的 SQL 数量,单位:条。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "CheckResultStatus": {
    "TotalSQLCount": 10,
    "CheckedCount": 10,
    "CheckStatusResult": {
      "New": 0,
      "Unknown": 0,
      "CheckNotPass": 1,
      "CheckPass": 8,
      "ForcePass": 1,
      "ForceNotPass": 0
    },
    "SQLReviewResult": {
      "MustImprove": 1,
      "PotentialIssue": 0,
      "SuggestImprove": 3,
      "UseDmsToolkit": 0,
      "UseDmsDmlUnlock": 0,
      "TableIndexSuggest": 2
    }
  }
}

错误码

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

变更历史

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