获取数据变更工单中预检查环节的SQL信息列表。
接口说明
关于该功能的更多说明,请参见普通数据变更。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:ListDataCorrectPreCheckSQL |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| OrderId |
integer |
是 |
数据变更工单 ID,可通过调用接口 ListOrders 获取该参数的值。 |
453**** |
| PageNumber |
integer |
否 |
第几页。 |
1 |
| PageSize |
integer |
否 |
每页数据量。 |
10 |
| DbId |
integer |
否 |
数据库 ID(DatabaseId),数据库分为物理库和逻辑库两种:
|
1930**** |
| Tid |
integer |
否 |
租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。 |
3*** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
31853A2B-DC9D-5B39-8492-D2AC8BCF550E |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| ErrorCode |
string |
错误码。 |
UnknownError |
| PreCheckSQLList |
array<object> |
预检查环节的 SQL 信息列表。 |
|
|
object |
预检查环节的 SQL 详情。 |
||
| CheckSQL |
string |
SQL 语句。 |
OPTIMIZE TABLE `Text_TableNames` |
| AffectRows |
integer |
预估影响行数。 |
0 |
| DbId |
integer |
数据库 ID。 |
1930**** |
| SQLReviewQueryKey |
string |
SQL 审核优化建议详情信息的查询 KEY。根据此 Key 调用 GetSQLReviewOptimizeDetail 获取 SQL 审核优化建议的详情。 |
b9e771fc6ec247dea6d06a32c777**** |
| SqlReviewStatus |
string |
SQL 审核状态,返回值如下:
|
WAITING |
| SqlType |
string |
SQL 类型,例如,DELETE、UPDATE、ALTER_TABLE 等。 |
OPTIMIZE |
| TableNames |
string |
数据变更的表名。 |
Text_TableNames |
示例
正常返回示例
JSON格式
{
"RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"PreCheckSQLList": [
{
"CheckSQL": "OPTIMIZE TABLE `Text_TableNames`",
"AffectRows": 0,
"DbId": 0,
"SQLReviewQueryKey": "b9e771fc6ec247dea6d06a32c777****",
"SqlReviewStatus": "WAITING",
"SqlType": "OPTIMIZE",
"TableNames": "Text_TableNames"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。