查询数据库对象列表

最近更新时间: 2026-07-12 00:28:08

1. 接口描述

接口请求域名: mariadb.api3.fincloud.tencent.com。

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

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

接口更新时间:2019-04-05 00:20:52。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeDatabaseObjects
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId String 实例 ID,形如:dcdbt-ow7t8lmc。
示例值: tdsql-e9tklsgz
DbName String 数据库名称,通过 DescribeDatabases 接口获取。
示例值: userDB

3. 输出参数

参数名称 类型 描述
InstanceId String 透传入参。
示例值: tdsql-e9tklsgz
DbName String 数据库名称。
示例值: userDB
Tables Array of DatabaseTable 表列表。
示例值:查看
Views Array of DatabaseView 视图列表。
示例值:查看
Procs Array of DatabaseProcedure 存储过程列表。
示例值:查看
Funcs Array of DatabaseFunction 函数列表。
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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