云数据库 MongoDB 查询实例客户端连接信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

本接口（DescribeClientConnections）用于查询实例客户端连接信息，包括连接 IP 和连接数量。

默认接口请求频率限制：5次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClientConnections。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	指定待查询的实例ID，例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-eqmoaxxx
Limit	否	Integer	单次请求返回的数量。最小值为1，最大值为1000，默认值为1000。示例值：1
Offset	否	Integer	偏移量，默认值为0。Offset=Limit*(页码-1)。示例值：1

3. 输出参数

参数名称	类型	描述
Clients	Array of ClientConnection	客户端连接信息，包括客户端 IP 和对应 IP 的连接数量。
TotalCount	Integer	满足条件的记录总条数，可用于分页查询。示例值：2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库实例的客户端连接情况

查询云数据库实例的客户端连接情况

输入示例

https://mongodb.tencentcloudapi.com/?Action=DescribeClientConnections
&InstanceId=cmgo-eqmoaxxx
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。
InvalidParameterValue.MongoVersionNotSupportQueryClient	实例版本不支持查询客户端信息。
InvalidParameterValue.NotFoundInstance	未找到实例。
InvalidParameterValue.ProxyNotSupportQueryClient	proxy版本不支持查询客户端信息，请联系工作人员进行升级。
InvalidParameterValue.RegionNotSupportQueryClient	地域尚不支持查询客户端信息。

查询实例客户端连接信息

本页目录：