1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
查询指定 SELECT SQL 在实例上的执行计划,常用于慢 SQL 分析、SQL 优化等场景。仅支持 SELECT 类语句
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDatabaseObjectV2。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Product | 是 | String | 服务产品类型。取值:sqlserver(云数据库 Sqlserver)。 示例值:sqlserver |
| ObjectType | 是 | String | 查询对象类型。 枚举值:
示例值:TableStatistics |
| InstanceId | 否 | String | 实例 ID。SQLServer: mssql-xxxx。 示例值:mssql-15rso1sb |
| TableSchema | 否 | String | 库名(catalog)。TableStatistics 时必填;TableDDL 时可选。 示例值:test_object |
| TableName | 否 | String | 当产品为sqlserver时,表名/视图名,支持 schema.table 格式,未带 schema 默认 dbo 示例值:sales.t_obj_dup |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IndexDDLs | Array of IndexDDLInfo | 索引 DDL 列表,每项为一条 CREATE INDEX 语句,无索引时为空数组。 |
| TableDDL | String | 建表 DDL 语句,对象不存在时为空串。 示例值:CREATE TABLE [dbo].[t_big_index] ( [id] INT IDENTITY(1,1) NOT NULL, [c1] VARCHAR(100) NOT NULL, CONSTRAINT [PK__t_big_in__3213E83F9B8B29CF] PRIMARY KEY ([id])); |
| TableName | String | 表名。 示例值:t_obj_dup |
| TableSchema | String | 库名。 示例值:test_object |
| TableStatistics | TableStatistics | 表空间统计。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询建表语句
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabaseObjectV2
<公共请求参数>
{
"Product": "sqlserver",
"ObjectType": "TableStatistics",
"InstanceId": "mssql-15rso1sb",
"TableSchema": "test_object",
"TableName": "sales.t_obj_dup"
}
输出示例
{
"Response": {
"TableName": "t_obj_dup",
"TableSchema": "test_object",
"TableStatistics": {
"DataFree": 0.05,
"DataLength": 0.02,
"DatabaseName": "test_object",
"Engine": "SqlServer",
"FragRatio": 71.43,
"IndexLength": 0,
"PhysicalFileSize": 0.1,
"TableName": "t_obj_dup",
"TableRows": 1,
"TableSchema": "sales",
"TotalLength": 0.07,
"UsedLength": 0.02
},
"RequestId": "fcaa610b-4a75-4b13-b88f-b4e2672f7322"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |