查询逻辑会话列表

功能介绍

获取DDM实例的逻辑会话列表。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

• URL格式

  GET /v3/{project_id}/instances/{instance_id}/logical-processes?offset={offset}&limit={limit}

• 参数说明

  表1 路径参数

  参数	是否必选	参数类型	描述
  project_id	是	String	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  instance_id	是	String	DDM实例ID。

  表2 Query参数

  参数	是否必选	参数类型	描述
  offset	否	Integer	索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。
  limit	否	Integer	查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。
  keyword	否	String	会话结果筛选关键字，支持返回结果全字段模糊匹配，长度最大255。

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/logical-processes?offset=0&limit=10

响应消息

• 正常响应参数说明

  表3 响应Body参数

  参数	参数类型	描述
  total_count	Integer	总条数。
  logical_processes	Array of 表4 objects	实例的逻辑会话列表。

  表4 logicalProcessesInfo

  参数	参数类型	描述
  id	String	逻辑会话ID。
  user	String	当前连接的用户。
  host	String	所属的IP和端口。
  db	String	数据库名。
  command	String	连接状态，一般是休眠（sleep），查询（query），连接（connect）。
  time	String	连接状态持续的时间，单位是秒（s）。
  state	String	当前SQL语句的状态。
  info	String	当前所执行的SQL语句。

• 正常响应示例

  {
    "logical_processes": [
      {
        "id": "4564224",
        "user": "drdsagent",
        "host": "127.0.0.1:54486",
        "db": "None",
        "command": "Query",
        "time": "0",
        "state": "starting",
        "info": "show processlist"
      }
    ],
    "total_count": 1
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。