# 查询实例节点会话-QueryingSessionsofanInstanceNode #### 接口说明 查询实例节点会话。 #### 约束说明 支持3.4及以上版本的社区版实例。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListSessions)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:listSession | list | - | - | dds:instance:session | - | #### URI - URI格式 GET /v3/{project_id}/nodes/{node_id}/sessions - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/nodes/520c58ba00a3497e97ce0b9604874dd6no02/sessions #### 请求参数 参数说明 表1请求参数 | 名称 | 类型 | IN | 是否必选 | 描述 | |:---|:---|:---|:---|:---| | X-Auth-Token | string | header | 是 | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | string | path | 是 | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | node_id | string | path | 是 | **参数解释：** 节点ID。 **约束限制：** - 集群实例支持选择mongos、shard、config中的任意节点。 - 副本集实例选择Primary或者Secondary节点。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | offset | Integer | 否 | **参数解释：** 索引位置，偏移量。 **约束限制：** 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 **取值范围：** 不涉及。 **默认取值：** 0 | | limit | Integer | 否 | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 10（表示返回10条数据）。 | | plan_summary | String | 否 | **参数解释：** 执行计划描述。 **约束限制：** 不涉及。 **取值范围：** 取空值表示查询plan_summary为空的会话。也可指定执行计划，例如：COLLSCAN IXSCAN FETCH SORT LIMIT SKIP COUNT COUNT_SCAN TEXT PROJECTION等。 **默认取值：** 不涉及。 | | type | String | 否 | **参数解释：** 操作类型。 **约束限制：** 不涉及。 **取值范围：** 取空值表示查询type为空的会话。也可指定操作类型，例如：none update insert query command getmore remove killcursors等。 **默认取值：** 不涉及。 | | namespace | String | 否 | **参数解释：** 命名空间。 **约束限制：** 取空值表示查询namespace为空的会话，也可根据当前业务进行指定。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | cost_time | Integer | 否 | **参数解释：** 运行时间，单位为us。 **约束限制：** 取空值表示查询cost_time为空的会话，也可根据当前业务需要进行配置，表示查询超出cost_time 的会话。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 - 参数说明 表3响应Body参数 | 参数 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | total_count | Integer | 是 | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | sessions | Array of objects | 是 | **参数解释：** 具体信息。详情请参见[表 QuerySessionResponse]。 **取值范围：** 不涉及。 | 表4session字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 会话ID。 **取值范围：** 不涉及。 | | active | Boolean | **参数解释：** 当前会话是否活跃。取值为"true"，表示活跃。取值为"false"，表示不活跃。 **取值范围：** 不涉及。 | | operation | String | **参数解释：** 操作。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 操作类型。 **取值范围：** 不涉及。 | | cost_time | String | **参数解释：** 运行时间，单位为us。 **取值范围：** 不涉及。 | | plan_summary | String | **参数解释：** 执行计划描述。 **取值范围：** 不涉及。 | | host | String | **参数解释：** 主机。 **取值范围：** 不涉及。 | | client | String | **参数解释：** 客户端地址。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 连接描述。 **取值范围：** 不涉及。 | | namespace | String | **参数解释：** 命名空间。 **取值范围：** 不涉及。 | | db | String | **参数解释：** 正在操作的数据库名称。 **取值范围：** 不涉及。 | | user | String | **参数解释：** 用户名称。 **取值范围：** 不涉及。 | #### 响应示例 ``` { "total_count" : 1, "sessions" : [ { "id" : "shard_1:7201646", "active" : true, "operation" : "{\"getMore\":4.9473050217983027E18,\"collection\":\"$cmd.aggregate\",\"batchSize\":101.0,\"lsid\":{\"id\":{\"$binary\":{\"base64\":\"9FhcBFVeTzafCH8BUZrLjQ\\=\\=\",\"subType\":\"03\"}},\"uid\":{\"$binary\":{\"base64\":\"O0CMtIVItQN4IsEOsJdrPL8s7jv5xwh5a/A5Qfvs2A8\\=\",\"subType\":\"00\"}}},\"$clusterTime\":{\"clusterTime\":{\"$timestamp\":{\"t\":1.614047961E9,\"i\":1.0}},\"signature\":{\"hash\":{\"$binary\":{\"base64\":\"HxUWu68VyfvQFivWjHQDdJj/3YQ\\=\",\"subType\":\"00\"}},\"keyId\":6.9312672235666801E18}},\"$client\":{\"driver\":{\"name\":\"PyMongo\",\"version\":\"3.6.1\"},\"os\":{\"type\":\"Linux\",\"name\":\"Linux\",\"architecture\":\"x86_64\",\"version\":\"4.18.0-147.5.1.0.h269.eulerosv2r9.x86_64\"},\"platform\":\"CPython 3.7.4.final.0\",\"mongos\":{\"host\":\"host-172-16-61-110:8635\",\"client\":\"127.0.0.1:33420\",\"version\":\"4.0.3\"}},\"$configServerState\":{\"opTime\":{\"ts\":{\"$timestamp\":{\"t\":1.614047961E9,\"i\":1.0}},\"t\":2.0}},\"$db\":\"admin\"}", "type" : "getmore", "cost_time" : "25", "plan_summary" : "COLLSCAN", "host" : "host-172-16-27-182:8635", "client" : "172.16.41.233:50700", "description" : "conn20", "namespace" : "admin.$cmd.aggregate", "db" : "admin", "user" : "root" } ] } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。