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.
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. |
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. |
https://mongodb.tencentcloudapi.com/?Action=DescribeClientConnections
&InstanceId=cmgo-eqmoaxxx
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"Clients": [
{
"Count": 1,
"IP": "xx",
"InternalService": true
},
{
"Count": 1,
"IP": "xx",
"InternalService": true
}
],
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?