文档首页/ 分布式缓存服务 DCS/ API参考/ API V2/ 会话管理/ 获取会话列表 - ListClients
更新时间:2026-07-30 GMT+08:00
分享

获取会话列表 - ListClients

功能介绍

获取会话列表。

使用该接口前需使用下发查询会话列表任务接口生成客户会话列表,否则会出现500访问异常报错。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcs:clients:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v2/{project_id}/instances/{instance_id}/clients

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。

约束限制

必须为当前租户下已存在的DCS实例ID。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

node_id

String

参数解释

节点ID。如果是读写分离、proxy集群实例请使用proxy节点node_id,如果是单机、主备、cluster集群实例请使用数据节点的node_id。不传则查询实例下所有节点。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

offset

Integer

参数解释

分页偏移量,表示从此偏移量开始查询。

约束限制

必须大于等于0。

取值范围

大于等于0的整数。

默认取值

0。

limit

Integer

参数解释

每页数量。

约束限制

必须大于0。

取值范围

最小值为1,最大值为1000的大于0的整数。

默认取值

10。

addr

String

参数解释

按客户端地址过滤。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

sort

String

参数解释

排序字段,指定会话列表ClientInfo中的一个值进行排序。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

order

String

参数解释

排序方向。

约束限制

不涉及。

取值范围

  • asc:升序。

  • desc:降序。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

time

String

参数解释

数据更新时间。

取值范围

不涉及。

clients

Array of ClientInfo objects

参数解释

客户端连接列表,各字段对应Redis CLIENT LIST命令输出字段。

取值范围

不涉及。

count

Integer

参数解释

客户端连接总数。

取值范围

大于等于0的整数。

表4 ClientInfo

参数

参数类型

描述

id

String

参数解释

客户端连接ID。

取值范围

不涉及。

addr

String

参数解释

客户端IP地址和端口。

取值范围

不涉及。

fd

String

参数解释

文件描述符。

取值范围

不涉及。

name

String

参数解释

客户端名称。

取值范围

不涉及。

age

Integer

参数解释

连接存活时长,单位秒。

取值范围

大于等于0的整数。

idle

Integer

参数解释

空闲时长,单位秒。

取值范围

大于等于0的整数。

flags

String

参数解释

客户端标志位。默认未设置,值为N。

取值范围

不涉及。

db

String

参数解释

当前使用的数据库编号。

取值范围

不涉及。

sub

Integer

参数解释

订阅的频道数。

取值范围

大于等于0的整数。

psub

Integer

参数解释

模式订阅数。

取值范围

大于等于0的整数。

multi

Integer

参数解释

在事务中被执行的命令数量。

取值范围

大于等于0的整数。

qbuf

Integer

参数解释

查询缓冲区长度,单位字节。0表示没有分配查询缓冲区。

取值范围

大于等于0的整数。

qbuf_free

Integer

参数解释

查询缓冲区空闲长度,单位字节。0表示没有剩余空间。

取值范围

大于等于0的整数。

obl

Long

参数解释

输出缓冲区长度,单位字节。0表示没有分配输出缓冲区。

取值范围

大于等于0的长整数。

oll

Long

参数解释

输出列表包含的对象数量。当输出缓冲区没有剩余空间时,命令回复会以字符串对象的形式被入队到这个队列里。

取值范围

大于等于0的长整数。

omem

Long

参数解释

输出缓冲区和输出列表占用的内存总量,单位字节。

取值范围

大于等于0的长整数。

events

String

参数解释

文件描述符事件类型。

取值范围

  • r:读

  • w:写

cmd

String

参数解释

最后执行的命令。

取值范围

不涉及。

network

String

参数解释

客户端所使用的网络类型。

取值范围

不涉及。

peer

String

参数解释

client地址和端口。

取值范围

不涉及。

user

String

参数解释

认证用户名。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/clients?node_id=8f7ee181-88e2-49b7-a4bf-81f18f93a135

响应示例

状态码:200

查询会话管理列表成功。

{
  "time" : "2023-06-15T03:10:01.332Z",
  "clients" : [ {
    "id" : "11677",
    "addr" : "198.19.131.14:1637",
    "name" : "dcs",
    "cmd" : "info",
    "age" : 376,
    "idle" : 376,
    "flags" : "N",
    "fd" : "16",
    "db" : "0",
    "sub" : 0,
    "psub" : 0,
    "multi" : 1,
    "qbuf" : 0,
    "qbuf_free" : 4,
    "obl" : 0,
    "oll" : 0,
    "omem" : 0,
    "events" : "r",
    "network" : "vpc",
    "peer" : "198.198.0.121:4058",
    "user" : "dcs"
  } ],
  "count" : 1
}

状态码:400

非法请求。

{
  "error_code" : "DCS.4957",
  "error_msg" : "This operation is not allowed when the task is in the current state."
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class ListClientsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClientsRequest request = new ListClientsRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListClientsResponse response = client.listClients(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListClientsRequest()
        request.instance_id = "{instance_id}"
        response = client.list_clients(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dcs.DcsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dcs.NewDcsClient(hcClient)

    request := &model.ListClientsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListClients(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询会话管理列表成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码

相关文档