# 获取实例的会话 - ObtainingInstanceSessions
#### 功能介绍
获取实例的会话。
#### 接口约束
该接口支持如下数据库实例。
- GeminiDB Redis
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ListInstancesSession)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                  | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                            | 别名                 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:listSession | List | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | nosql:session:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/instances/{instance_id}/sessions
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。     |
| instance_id | 是    | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| node_id | 否    | String | **参数解释：** 节点ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数            | 参数类型                                                                                   | 描述                                                   |
|:---|:---|:---|
| node_sessions | Array of [表5] objects | **参数解释：** 节点的会话信息列表。 |
   
 表5ListNodeSessionsResult 
| 参数          | 参数类型                                                       | 描述                                                                                                                                    |
|:---|:---|:---|
| node_id     | String                                                     | **参数解释：** 节点ID。 **取值范围：** 不涉及。 |
| total_count | Integer                                                    | **参数解释：** 总会话数。 **取值范围：** 不涉及。  |
| sessions    | Array of [表6] objects | **参数解释：** 节点会话详细信息列表。                                                                                |
   
 表6sessions 
| 参数    | 参数类型   | 描述                                                                                                                                               |
|:---|:---|:---|
| id    | String | **参数解释：** 会话ID。 **取值范围：** 不涉及。         |
| name  | String | **参数解释：** 连接名。 **取值范围：** 不涉及。              |
| cmd   | String | **参数解释：** 最近一次执行的命令。 **取值范围：** 不涉及。     |
| age   | String | **参数解释：** 以秒计算的已连接时长。 **取值范围：** 不涉及。          |
| idle  | String | **参数解释：** 以秒计算的空闲时长。 **取值范围：** 不涉及。      |
| db    | String | **参数解释：** 该客户端正在使用的数据库ID。 **取值范围：** 不涉及。 |
| addr  | String | **参数解释：** 客户端的地址和端口。 **取值范围：** 不涉及。      |
| fd    | String | **参数解释：** 套接字所使用的文件描述符。 **取值范围：** 不涉及。    |
| sub   | String | **参数解释：** 已订阅频道的数量。 **取值范围：** 不涉及。          |
| psub  | String | **参数解释：** 已订阅模式的数量。 **取值范围：** 不涉及。           |
| multi | String | **参数解释：** 在事务中被执行的命令数量。 **取值范围：** 不涉及。   |
   
#### 请求示例
- 查询实例所有节点的会话信息
  ```
  GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/e73893ef73754465a8bd2e0857bbf13ein12/sessions
  ```
  
- 查询实例指定节点的会话信息
  ```
  GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/e73893ef73754465a8bd2e0857bbf13ein12/sessions?node_id=9d3288bbbb81448e8a99ff41a5717281no12
  ```
  
 
#### 响应示例
**状态码： 200**
Success.
```
{ 
  "node_sessions" : [ { 
    "node_id" : "8436a91546294036b75931e879882200in06", 
    "total_count" : 1, 
    "sessions" : [ { 
      "addr" : "127.0.0.1:8080", 
      "id" : "54487", 
      "name" : "cli", 
      "cmd" : "get", 
      "age" : "8888581", 
      "idle" : "8888581", 
      "db" : "0", 
      "fd" : "1311", 
      "sub" : "0", 
      "psub" : "0", 
      "multi" : "-1" 
    } ] 
  }, { 
    "node_id" : "8123sa46294daw13def423fw79882200in06", 
    "total_count" : 1, 
    "sessions" : [ { 
      "addr" : "127.0.0.1:8080", 
      "id" : "54488", 
      "name" : "cli", 
      "cmd" : "get", 
      "age" : "3124124", 
      "idle" : "4414141", 
      "db" : "0", 
      "fd" : "1312", 
      "sub" : "0", 
      "psub" : "0", 
      "multi" : "-1" 
    } ] 
  } ] 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。