获取Redis实例proxy实时会话详情

最近更新时间:2024-03-12 01:24:37

我的收藏

1. 接口描述

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

获取 Redis 实例所有 proxy 节点的实时会话详情列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRedisProcessList。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String Redis 实例ID。
示例值:crs-qylqkl4f
Product String 服务产品类型,支持值包括 "redis" - 云数据库 Redis。
示例值:redis
Limit Integer 查询的Proxy节点数量上限,默认值为20,最大值为50。
示例值:50
Offset Integer Proxy节点的偏移量,默认值为0。
示例值:50

3. 输出参数

参数名称 类型 描述
ProxyCount Integer 该实例的Proxy节点数量,可用于分页查询。
示例值:198
Processes Array of Process 实时会话详情列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取 Redis 实例 Proxy 实时会话详情列表

指定 Offset 分页获取实例 Proxy 实时会话详情列表。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeRedisProcessList
&InstanceId=crs-qylqks3c
&Product=redis
&Offset=50
&Limit=50
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "8108c1c0-bbcc-11ec-adb9-eb9c1358e02b",
        "ProxyCount": 198,
        "Processes": [
            {
                "Address": "100.12.168.216:33064",
                "Age": 11788,
                "FileDescriptor": 3,
                "Id": -522451396107420,
                "Idle": 0,
                "LastCommand": "client",
                "Name": "",
                "ProxyId": "49c4c738a3398cb0a41914396e24db2dee29d1e3"
            },
            {
                "Address": "100.1.168.115:36938",
                "Age": 47,
                "FileDescriptor": 7,
                "Id": -803926372818076,
                "Idle": 47,
                "LastCommand": "command",
                "Name": "",
                "ProxyId": "49c4c538a3397cb0a41914796e24db3dee29d1e3"
            }
        ]
    }
}

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 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。