# 获取连接实例客户端Ip和连接数 - GetUDBClientConnNum

## 简介

输入一个DBID，能够获取客户端来源IP以及对应的连接数





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `GetUDBClientConnNum`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.sigcalcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **DBId** | string | DB实例id |**Yes**|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **DataSet** | array[[*ConnNumMap*](#ConnNumMap)] | db实例ip和连接数信息 |**Yes**|

#### 数据模型


#### ConnNumMap

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Ip** | string | 客户端IP |No|
| **Num** | int | 该Ip连接数 |No|

## 示例

### 请求示例
    
```
https://api.sigcalcloud.com/?Action=GetUDBClientConnNum
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=clkPraZH
&DBId=udb-xxxxxxx
```

### 响应示例
    
```json
{
  "Action": "GetUDBClientConnNumResponse",
  "DataSet": [
    {
      "Ip": "172.xx.xx.xx",
      "Num": 3
    }
  ],
  "RetCode": 0
}
```