
# 查询实时会话等待事件统计 - QueryingWaitingEventStatisticsofReal-TimeSessions
#### 功能介绍
查询数据库实例实时会话出现频次最高的等待事件统计信息。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 接口约束
仅支持包含有CN或DN（主、备）组件的节点。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListSessionWaitEventStatistics)中调试该接口。
#### URI
GET /v3/{project_id}/instances/{instance_id}/session/statistic/wait-event
表1路径参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id  | 是    | String  | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。                                                                                       |
| instance_id | 是    | String  | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 |
| offset      | 是    | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为0，limit指定为10，则只展示第1\~10条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| limit       | 是    | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值**： 默认为100。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| X-Language   | 否    | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文  - **en-us** **：**英文   **默认取值** **：** **en-us**                 |
   
#### 响应参数
表3响应Body参数 
| 参数              | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| wait_event_info | Array of objects | **参数解释：** 统计数据。详细内容请参见[表4]。                                                                                                            |
| total           | Integer          | **参数解释：** 统计总条数。 **取值范围：** 不涉及。 |
   
 表4SessionWaitEventStatisticInfo参数说明 
| 参数                                                                                          | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| node_name                                                                                   | String | **参数解释：** 组件名称。 **取值范围：** 不涉及。 |
| event_name  | String | **参数解释：** 等待事件名称。 **取值范围：** 不涉及。 |
| count                                                                                       | String | **参数解释：** 等待事件数量。 **取值范围：** 大于等于0。                             |
   
#### 请求示例
```
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session/statistic/wait-event?limit=20&offset=0
```
#### 响应示例
```
{ 
  "total" : 1, 
  "wait_event_info" : [ { 
    "node_name" : "cn_5001", 
    "event_name" : "wait gs_sleep", 
    "count" : "1" 
  } ] 
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
