# 查询客户端会话分布 - CountDbClientSession #### 功能介绍 查询客户端会话分布 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=CountDbClientSession)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI POST /v1/{project_id}/audit/{instance_id}/statistics/session/db-client 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。可通过IAM服务\[查询指定IAM用户的项目列表\]接口获取。 **约束限制**： 不涉及 **取值范围**： 以IAM服务接口返回值为准，字符长度32-64。 **默认取值**： 不涉及 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过查询实例列表接口ID字段获取 **约束限制**： 不涉及 **取值范围**： 以查询实例列表接口值为准，字符长度32-64。 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及 **取值范围**： IAM服务查询用户Token接口为准 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | db_id | 否 | Array of strings | 数据库ID | | time | 是 | [Duration] object | 查询时间范围，time_range属性优先于start_time/end_time | 表4Duration | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | end_time | 否 | String | 结束时间 | | start_time | 否 | String | 开始时间 | | time_range | 否 | String | 时间范围 - HALF_HOUR：半小时 - HOUR：1小时 - THREE_HOUR：3小时 - TWELVE_HOUR：12小时 - DAY：1天 - WEEK：1周 - MONTH：1个月 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ReportClientSessionNew] objects | 客户端会话统计 | 表6ReportClientSessionNew | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_id | String | 数据库ID | | db_ip | String | 数据库IP | | db_name | String | 数据库名称 | | session_num | Long | SESSION数量 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表8DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表12DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表14DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v1/{project_id}/audit/{instance_id}/statistics/session/db-client { "time" : { "time_range" : "MONTH" } } ``` #### 响应示例 **状态码：200** OK ``` [ { "db_id" : null, "db_ip" : "100.79.0.248", "session_num" : 16, "db_name" : null }, { "db_id" : null, "db_ip" : "100.79.0.247", "session_num" : 13, "db_name" : null } ] ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 请求参数有误 | | 401 | 认证失败 | | 403 | 未授权 | | 500 | 服务端错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。