首页 数据管理 DMS API参考 API目录 工单操作 SQL审核 ListSQLReviewOriginSQL - 获取SQL审核工单的SQL详情

ListSQLReviewOriginSQL - 获取SQL审核工单的SQL详情

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

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

123321
OrderActionDetailobject

工单参数(过滤条件)。

FileIdlong

审核文件ID。

123345
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。您可以调用GetUserActiveTenantListUserTenants接口获取该参数。

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

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

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

true
TotalCountinteger

总SQL条数。

10
OriginSQLListobject []

解析的SQL列表。

SQLIdlong

SQL语句ID。

1111
FileIdlong

文件ID。

123321
FileNamestring

文件名。

test.sql
SQLContentstring

SQL内容。

select id from table_name
CheckStatusstring

检测结果。返回值如下:

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

检测结果描述。

检测通过
CheckedTimestring

检测时间。

2021-06-09 21:07:00
SqlHashstring

SQL内容的MD5值。

95adb6e77a0884d9e50232cb8c5c969d
ReviewSummarystring

SQL审核优化建议的统计信息(Json字符串)。统计信息如下:

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

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

a57e54ec5433475ea3082d882fdb89c5
SQLNamestring

SQL名称。

getByPk

示例

正常返回示例

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",
      "SQLName": "getByPk"
    }
  ]
}

错误码

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

阿里云首页 数据管理 相关技术圈