tencent cloud

DescribeDBInstanceNamespace
Last updated: 2025-12-03 10:42:07
DescribeDBInstanceNamespace
Last updated: 2025-12-03 10:42:07

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to query the table information on a database.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDBInstanceNamespace.
Version Yes String Common Params. The value used for this API: 2019-07-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Specifies the instance ID for querying the database. Batch querying is supported. Log in to the TencentDB for MongoDB console and copy the instance ID from the instance list.
DbName No String Specifies the database name for querying. If this parameter is left blank, a list of all databases of the current instance is returned.

3. Output Parameters

Parameter Name Type Description
Databases Array of String List of databases of the queried instance. If no database is specified for querying with DbName, a list of databases of only the queried instance is returned instead of the information indicated by Collections.
Collections Array of String Queried collection information. If DbName is specified, a list of collections of only this database is returned.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Database List of the Current Instance

This example shows you how to view the list of all databases of the current instance when the input parameter DbName is left blank.

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceNamespace
<Common request parameters>

{
    "InstanceId": "cmgo-qny2****"
}

Output Example

{
    "Response": {
        "Databases": [
            "demo_db7",
            "demo_db8",
            "demo_db9"
        ],
        "RequestId": "18cfe2bf-6934-4f17-a089-8d2e5d6cfc53"
    }
}

Example2 Querying All Collections of the Specified Database

This example shows you how to query the information on all collections of the database when DbName is specified.

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceNamespace
<Common request parameters>

{
    "InstanceId": "cmgo-qny2****",
    "DbName": "demo_db0"
}

Output Example

{
    "Response": {
        "Collections": [
            "col148",
            "col108",
            "col120"
        ],
        "RequestId": "21b503b5-6606-4efb-b250-63071c2fe565"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Parameter error
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback