DescribeDBInstances

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

DescribeDBInstances

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 list of TencentDB for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.

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: DescribeDBInstances.
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.
InstanceIds.N	No	Array of String	Instance ID list. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
InstanceType	No	Integer	Specifies the instance type for querying. Valid values: - 0: all instances. - 1: formal instance. - 2: temporary instance. - 3: read-only instance. - -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously.
ClusterType	No	Integer	Specifies the cluster type of the instance to be queried. Valid values: - 0: replica set instance. - 1: sharded cluster instance. - -1: replica set and sharded cluster instance.
Status.N	No	Array of Integer	Specifies the current status of the instance to be queried. Valid values: - 0: to be initialized. - 1: processing, such as specification changes and parameter modifications. - 2: running normally. - -2: isolated (yearly/monthly subscription). - -3: isolated (pay-as-you-go).
VpcId	No	String	VPC ID. - You do not need to specify this parameter for basic networks. - Log in to the TencentDB for MongoDB console, click a VPC name in the instance list, and obtain the ID on the VPC page.
SubnetId	No	String	VPC subnet ID. - You do not need to specify this parameter for basic networks. - Log in to the TencentDB for MongoDB console, click a VPC name in the instance list, and obtain the subnet ID on the VPC page.
PayMode	No	Integer	Billing type. Valid value: 0 (pay-as-you-go)
Limit	No	Integer	Number of entries returned per request. The default value is 20, and the value range is (1, 100].
Offset	No	Integer	Offset. Default value: `0`.
OrderBy	No	String	Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.
OrderByType	No	String	Configures the method for sorting returned results. - ASC: ascending order. - DESC: descending order.
ProjectIds.N	No	Array of Integer	Project ID. Log in to the TencentDB for MongoDB console and select Project Management in the account information drop-down menu at the top right corner to query projects.
SearchKey	No	String	Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.
Tags.N	No	Array of TagInfo	Tag information, including the tag key and tag value.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible instances
InstanceDetails	Array of InstanceDetail	List of instance details
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 Query Instance List

Query Instance List

Input Example

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

{
    "Status": [
        0
    ],
    "OrderBy": "ProjectId",
    "InstanceIds": [
        "cmgo-3vgr****"
    ],
    "VpcId": "vpc-gfb3****",
    "Tags": [
        {
            "TagKey": "testTag",
            "TagValue": "testValue"
        }
    ],
    "ClusterType": 0,
    "PayMode": 0,
    "Limit": 1,
    "SearchKey": "",
    "Offset": 1,
    "SubnetId": "",
    "OrderByType": "",
    "InstanceType": 0,
    "ProjectIds": [
        1
    ]
}

Output Example

{
    "Response": {
        "InstanceDetails": [
            {
                "AutoRenewFlag": 0,
                "CloneInstances": [],
                "ClusterType": 0,
                "ClusterVer": 1,
                "ConfigServerCpuNum": 0,
                "ConfigServerMemory": 0,
                "ConfigServerNodeNum": 3,
                "ConfigServerVolume": 0,
                "CpuNum": 2,
                "CreateTime": "2023-03-30 07:44:21",
                "DeadLine": "2073-03-30 07:44:21",
                "InstanceId": "cmgo-3vgr****",
                "InstanceName": "Test instance",
                "InstanceStatusDesc": "Running",
                "InstanceType": 1,
                "InstanceVer": 4,
                "MachineType": "HIO10G",
                "MaintenanceEnd": "05:00:00",
                "MaintenanceStart": "04:00:00",
                "Memory": 4096,
                "MongoVersion": "MONGO_42_WT",
                "MongosCpuNum": 0,
                "MongosMemory": 0,
                "MongosNodeNum": 0,
                "NetType": 1,
                "PayMode": 0,
                "ProjectId": 0,
                "Protocol": 0,
                "ReadonlyInstances": [],
                "ReadonlyNodeNum": 0,
                "RealInstanceId": "cmgo-3vgr****",
                "Region": "ap-guangzhou",
                "RelatedInstance": {
                    "InstanceId": "",
                    "Region": ""
                },
                "ReplicaSets": [
                    {
                        "Memory": 4096,
                        "OplogSize": 1024,
                        "RealReplicaSetId": "cmgo-3vgrapm5_*",
                        "ReplicaSetId": "cmgo-3vgrapm5_*",
                        "ReplicaSetName": "cmgo-3vgrapm5_*",
                        "SecondaryNum": 2,
                        "UsedVolume": 315,
                        "Volume": 10240
                    }
                ],
                "ReplicationSetNum": 1,
                "SecondaryNum": 2,
                "StandbyInstances": [],
                "Status": 2,
                "SubnetId": "subnet-7q7d****",
                "Tags": [],
                "UsedVolume": 315,
                "Vip": "10.5.2.12;10.5.2.14;10.5.2.10",
                "Volume": 10240,
                "VpcId": "vpc-gfb3****",
                "Vport": 27017,
                "Zone": "ap-guangzhou-2"
            }
        ],
        "RequestId": "230c9c0e-a56f-4639-81ee-3cb46905c087",
        "TotalCount": 1
    }
}

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

Tencent Cloud CLI 3.0

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
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.IllegalInstanceStatus	Invalid instance status
InvalidParameterValue.RegionError	Invalid region
InvalidParameterValue.VpcIdOrSubnetIdNotFound	The VPC (subnet) was not found.
InvalidParameterValue.ZoneError	Invalid availability zone
LimitExceeded.TooManyRequests	The API frequency limit is triggered due to frequent requests.
UnsupportedOperation	Unsupported operation

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud