DescribeClientConnections

Last updated: 2020-03-04 23:48:28

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeClientConnections.
Version Yes String Common parameter. The value used for this API: 2019-07-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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

3. Output Parameters

Parameter Name Type Description
Clients Array of ClientConnection Client connection information, including client IP and number of connections
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying client connections of a TencentDB instance

Input Example

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

Output Example

{
  "Response": {
    "Clients": [
      {
        "Count": 15,
        "IP": "10.xx.xx.xx"
      },
      {
        "Count": 15,
        "IP": "10.xx.xx.xx"
      }
    ],
    "RequestId": "c61fd6e2-c505-4fb9-9f30-edd8e897b236"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.