1. 接口描述
接口请求域名： mongodb.tencentcloudapi.com 。
本接口（DescribeDBInstanceNamespace）用于查询数据库的表信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDBInstanceNamespace。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 指定查询数据库所属的实例 ID，支持批量查询。请登录 MongoDB 控制台在实例列表复制实例 ID。 示例值："cmgo-j0i*" |
| DbName | 否 | String | 指定查询的数据库名。为空时，返回当前实例的全部数据库列表。 示例值：dba |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Databases | Array of String | 查询实例的数据库列表。若未使用 DbName 指定具体查询的数据库，则仅返回查询实例所有的数据库列表，而不返回 Collections 集合信息。 示例值：['db-a','db-b'] |
| Collections | Array of String | 查询的集合信息。指定 DbName 时，则仅返回该数据库下的集合列表。 示例值：['col-1','col-2',] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询当前实例的DB列表。
输入参数 DbName 为空时，查看当前实例全部数据库列表。
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceNamespace
<公共请求参数>
{
"InstanceId": "cmgo-qny2****"
}输出示例
{
"Response": {
"Databases": [
"demo_db7",
"demo_db8",
"demo_db9"
],
"RequestId": "18cfe2bf-6934-4f17-a089-8d2e5d6cfc53"
}
}示例2 查询指定 DB 下的所有集合
指定 DbName，查询该数据库下的所有集合信息。
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceNamespace
<公共请求参数>
{
"InstanceId": "cmgo-qny2****",
"DbName": "demo_db0"
}输出示例
{
"Response": {
"Collections": [
"col148",
"col108",
"col120"
],
"RequestId": "21b503b5-6606-4efb-b250-63071c2fe565"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
