获取会话列表
功能介绍
获取会话列表。
URI
GET /v2/{project_id}/instances/{instance_id}/clients
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参见获取项目ID。 |
| instance_id | 是 | String | 实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| node_id | 是 | String | 节点ID。如果是读写分离、proxy集群实例请使用proxy节点node_id，如果是单机、主备、cluster集群实例请使用数据节点的node_id。 |
| offset | 否 | Integer | 偏移量，表示从此偏移量开始查询，偏移量大于等于0，默认为0。 |
| limit | 否 | Integer | 每页显示条数，最小值为1，最大值为1000，默认值为10。 |
| addr | 否 | String | 按客户端连接地址过滤。 |
| sort | 否 | String | 排序字段，指定会话列表ClientInfo中的一个值进行排序。 |
| order | 否 | String | 排序方式，asc：正序排序，desc：倒序排序。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| time | String | 数据更新时间。 |
| clients | Array of ClientInfo objects | 会话列表。 |
| count | Integer | 会话总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 客户端ID。 |
| addr | String | 客户端所在的地址和端口。 |
| fd | String | 容器内所使用的文件描述符。 |
| name | String | 客户端的名称。 |
| cmd | String | 最近一次执行的命令。 |
| age | Integer | 已连接时长（单位：秒）。 |
| idle | Integer | 空闲时长（单位：秒）。 |
| db | String | 该客户端正在使用的数据库ID。 |
| flags | String | 客户端标志。默认未设置，值为N。 |
| sub | Integer | 已订阅频道的数量。 |
| psub | Integer | 已订阅模式的数量。 |
| multi | Integer | 在事务中被执行的命令数量。 |
| qbuf | Integer | 查询缓冲区的长度（单位为字节，0表示没有分配查询缓冲区）。 |
| qbuf_free | Integer | 查询缓冲区剩余空间的长度（单位为字节，0表示没有剩余空间）。 |
| obl | Integer | 输出缓冲区的长度（单位为字节，0表示没有分配输出缓冲区）。 |
| oll | Integer | 输出列表包含的对象数量（当输出缓冲区没有剩余空间时，命令回复会以字符串对象的形式被入队到这个队列里） |
| omem | Integer | 输出缓冲区和输出列表占用的内存总量。 |
| events | String | 文件操作事件，r:读;w:写。 |
| network | String | 客户端所使用的网络类型。 |
| peer | String | client地址和端口。 |
| user | String | 客户端用户。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_ext_msg | String | 扩展错误信息。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询会话管理列表成功。 |
| 400 | 非法请求。 |
| 401 | 认证信息非法。 |
| 403 | 请求被拒绝访问。 |
| 404 | 所请求的资源不存在。 |
| 500 | 内部服务错误。 |
错误码
请参见错误码。
