查询数据库对象列表
最近更新时间: 2024-10-18 10:38:30
1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.cn。
本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。
默认接口请求频率限制：20次/秒。
接口更新时间：2019-04-25 11:10:48。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDatabaseObjects |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例 ID，形如：dcdbt-ow7t8lmc。 |
| DbName | 是 | 否 | String | 数据库名称，通过 DescribeDatabases 接口获取。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 透传入参。 |
| DbName | String | 数据库名称。 |
| Tables | DatabaseTable | 表列表。 |
| Views | DatabaseView | 视图列表。 |
| Procs | DatabaseProcedure | 存储过程列表。 |
| Funcs | DatabaseFunction | 函数列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CamAuthFailed | |
| InternalError.DbOperationFailed | |
| InternalError.GetDbObjectFailed | |
| InvalidParameter.GenericParameterError | |
| ResourceUnavailable.InstanceAlreadyDeleted | |
| ResourceUnavailable.InstanceStatusAbnormal | |
| UnauthorizedOperation.PermissionDenied |