1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
获取指定catalog下数据库列表
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-11 17:35:37。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeSchemas |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Offset | 是 | 否 | Int64 | 偏移量,页编号,默认为0,表示第一页 示例值: 0 |
| Limit | 是 | 否 | Int64 | 每页数量,默认值为10,最大值为200 示例值: 10 |
| OrderFields | 否 | 否 | Array of OrderField | 排序字段,Fields支持字段:最近创建时间CreateTime,Direction支持"DESC"和"ASC" 示例值:查看 |
| Filters | 否 | 否 | Array of RequestFilter | 过滤字段,Name支持SchemaName,value为数据库名 示例值:查看 |
| CatalogName | 是 | 否 | String | 要查询对应集群的catalog的结果, 则提供clusterId.catalog格式的名称 示例值: c9kr93vco_hive |
| GetDetails | 否 | 否 | Bool | 是否携带Schema详情 示例值: True |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of SchemaSimpleInfo | 数据库列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| TotalCount | Int64 | 总数 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码。