1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
获取SQL优化建议。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-16 10:17:44。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeUserSqlAdvice |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID。 示例值： shard-lm6o3jwi |
| SqlText | 是 | 否 | String | SQL语句。 示例值： select * from t1 |
| Schema | 否 | 是 | String | 库名。 示例值： demo_db |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值： tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Cost | String | SQL优化后的成本节约详情，可解析为JSON，无需优化时输出为空。 示例值： After |
| Advices | String | SQL优化建议，可解析为JSON数组，无需优化时输出为空。 示例值： PossibleKeys |
| Comments | String | SQL优化建议备注，可解析为String数组，无需优化时输出为空。 示例值： SQL解析不通过 |
| SqlText | String | SQL语句。 示例值： select * from t1 |
| Schema | String | 库名。 示例值： demo_db |
| Tables | String | 相关表的DDL信息，可解析为JSON数组。 示例值： TableDDL |
| SqlPlan | String | SQL执行计划，可解析为JSON，无需优化时输出为空。 示例值： Before |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |