tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClientConnections

Last updated: 2023-03-20 10:55:17

1. API Description

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

This API is used to query the client connection information of an instance, including the IP and number of connections. Currently, only instances of MongoDB 3.2 are supported.

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 No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
Limit No Integer Number of results to be returned for a single request. Value range: 1-1,000. Default value: 1,000
Offset No Integer Offset. Default value: 0.

3. Output Parameters

Parameter Name Type Description
Clients Array of ClientConnection Client connection information, including client IP and number of connections
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the client connections of a TencentDB instance

Input Example

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

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Clients": [
            {
                "Count": 1,
                "IP": "xx",
                "InternalService": true
            },
            {
                "Count": 1,
                "IP": "xx",
                "InternalService": true
            }
        ],
        "RequestId": "xx"
    }
}

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
InvalidParameter.PermissionDenied The current subaccount 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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy