获取SQL审核优化建议的详情,适用于数据变更工单和SQLReview工单。
接口说明
SQL 审核功能的更多信息,请参见 SQL 审核。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:GetSQLReviewOptimizeDetail | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SQLReviewQueryKey | string | 是 | 查询 SQL 审核优化建议详情信息。您可以调用 ListSQLReviewOriginSQL 接口获取该参数的值。 | a57e54ec5433475ea3082d882fdb**** |
Tid | long | 否 | 租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数的值。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"OptimizeDetail": {
"QueryKey": "a57e54ec5433475ea3082d882fdb****",
"InstanceId": 123321,
"DbId": 111222,
"SqlType": "UPDATE",
"QualityResult": {
"ErrorMessage": "syntax error",
"Results": [
{
"RuleName": "SELECT_SUGGEST_ASSIGN_WHERE",
"Feedback": "MUST_IMPROVE",
"Comments": "xxx业务规定:查询必须带where条件",
"Messages": [
"xxx表不存在"
],
"Scripts": [
{
"OpType": "AddIndex",
"Content": "alter table xxx add index idx_xx(yyy);",
"TableName": "xxx"
}
],
"RuleType": "REVIEW"
}
],
"OccurError": false
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史