API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 数据库智能管家 DBbrain > kill会话相关接口 > 获取单个proxy实时会话统计详情

获取单个proxy实时会话统计详情

最近更新时间：2024-03-13 01:13:48

我的收藏

本页目录：

1. 接口描述

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

获取当前实例下的单个proxy的会话统计详情信息， 返回数据为单个 proxy 的会话统计信息。【注意】该接口仅限部分环境调用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeProxyProcessStatistics。
Version 是 String 公共参数，本接口取值：2021-05-27。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例 ID 。
示例值："crs-2gtest"
InstanceProxyId 是 String 该实例下需要查询的某一个 ProxyID 。
示例值："b237ff3c5f30b0615276f986cc75c045bc"
Limit 是 Integer 返回数量。
示例值：100
Product 是 String 服务产品类型，支持值包括： "redis" - 云数据库 Redis。
示例值："redis"
Offset 否 Integer 偏移量，默认0。
示例值：0
SortBy 否 String 按照某字段排序。支持值包括："AllConn"，"ActiveConn"，"Ip"。
示例值："AllConn"
OrderDirection 否 String 排序方向。支持值包括："DESC"，"ASC"。
示例值："DESC"

3. 输出参数

参数名称 类型 描述
ProcessStatistics ProcessStatistic 实时会话统计详情。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取单个proxy实时会话统计详情

获取单个proxy的实时会话统计详情

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyProcessStatistics
<公共请求参数>

{
    "InstanceId": "redis-test",
    "Product": "redis",
    "Limit": "20",
    "InstanceProxyId": "b237ff3c5f30b0"
}

输出示例

{
    "Response": {
        "RequestId": "099479c0-7b7c-11ed-8d71-fdsafda",
        "ProcessStatistics": {
            "Items": [
                {
                    "Ip": "127.0.0.1",
                    "ActiveConn": "1",
                    "AllConn": 10
                },
                {
                    "Ip": "127.0.0.2",
                    "ActiveConn": "3",
                    "AllConn": 5
                }
            ],
            "AllConnSum": 15,
            "ActiveConnSum": 4
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站