DescribeClientConnections

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

DescribeClientConnections

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

1. API Description

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

This API is used to query the client connection information on an instance, including the IP address for connection and the number of connections.

A maximum of 5 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: DescribeClientConnections.
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 ID of the instance to be queried. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console and copy the instance ID from the instance list.
Limit	No	Integer	Number of entries returned per request. Minimum value: 1. Maximum value: 1000. Default value: 1000.
Offset	No	Integer	Offset. Default value: 0. Offset = Limit x (page number - 1).

3. Output Parameters

Parameter Name	Type	Description
Clients	Array of ClientConnection	Client connection information, including the numbers of connections of the client IP address and the database access IP address.
TotalCount	Integer	The total number of records that meet the query condition, which can be used for paginated queries.
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 Client Connection Information on a TencentDB for MongoDB Instance

This example shows you how to query the client connection information on a TencentDB for MongoDB instance.

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=DescribeClientConnections
&InstanceId=cmgo-eqmoaxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Clients": [
            {
                "Count": 1,
                "IP": "192.168.1.1",
                "InternalService": true
            }
        ],
        "RequestId": "1df930fb-eb7e-4e3f-bcab-15a1aa5fede0"
    }
}

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.MongoVersionNotSupportQueryClient	The instance version does not support querying the instance client information.
InvalidParameterValue.NotFoundInstance	The instance was not found.
InvalidParameterValue.ProxyNotSupportQueryClient	The proxy version does not support querying the instance client information. Please submit a ticket for upgrade.
InvalidParameterValue.RegionNotSupportQueryClient	The region does not support querying the instance client information.

Was this page helpful?

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

Yes

Feedback

tencent cloud