TDSQL MySQL版查询数据库对象列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： dcdb.tencentcloudapi.com 。

本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDatabaseObjects。
Version	是	String	公共参数，本接口取值：2018-04-11。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，形如：dcdbt-ow7t8lmc。示例值：dcdbt-52s53yyh
DbName	是	String	数据库名称，通过 DescribeDatabases 接口获取。示例值：test

3. 输出参数

参数名称	类型	描述
InstanceId	String	透传入参。示例值：dcdbt-52s53yyh
DbName	String	数据库名称。示例值：test
Tables	Array of DatabaseTable	表列表。
Views	Array of DatabaseView	视图列表。
Procs	Array of DatabaseProcedure	存储过程列表。
Funcs	Array of DatabaseFunction	函数列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库对象信息

输入示例

https://dcdb.tencentcloudapi.com/?Action=DescribeDatabaseObjects
&InstanceId=dcdbt-52s53yyh
&DbName=test
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "742443a5-4683-48ba-b30e-5151d26cf62d",
        "InstanceId": "dcdbt-52s53yyh",
        "DbName": "test",
        "Tables": [],
        "Views": [],
        "Procs": [
            {
                "Proc": "AddGeometryColumn"
            },
            {
                "Proc": "DropGeometryColumn"
            }
        ],
        "Funcs": []
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.CamAuthFailed	CAM鉴权请求失败。
InternalError.DbOperationFailed	查询数据库失败。
InternalError.GetDbObjectFailed	获取数据库对象失败。
InvalidParameter.GenericParameterError	参数合法性校验错误。
ResourceUnavailable.InstanceAlreadyDeleted	数据库实例已被删除。
ResourceUnavailable.InstanceStatusAbnormal	数据库实例状态不正确，当前无法操作。
UnauthorizedOperation.PermissionDenied	没有权限操作该接口或资源。

查询数据库对象列表

本页目录：