# Query Proxy Client Connection IP Information (Real-time) - ListUDBProxyClient

## Overview

Query Proxy Client Connection IP Information (Real-time)

 > 💡 The current interface only supports proxies created after March 10, 2023.




## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUDBProxyClient`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **UDBProxyID** | string | Agent ID |**Yes**|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **UDBProxyID** | string | Agent ID |**Yes**|
| **NodeClientInfos** | array[[*NodeClientInfo*](#nodeclientinfo)] | Proxy Node Client IP Connection Information |**Yes**|

#### Data Model


#### NodeClientInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Records** | array[[*ProxyProcesslist*](#proxyprocesslist)] | Client IP Connection Information |No|
| **ID** | string | Proxy Node ID |No|
| **IP** | string | Proxy Node IP |No|

#### ProxyProcesslist

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ID** | int | Current Connection DB Process ID |No|
| **User** | string | The user who started this thread |No|
| **Host** | string | Proxy Connection DB Address |No|
| **DB** | string | Which database is the current command being executed on? If no database is specified, this value is NULL. |No|
| **Command** | string | Display the commands executed by the current connection |No|
| **Time** | int | Time that the thread has been in the current status |No|
| **State** | string | The status of the thread, corresponding to the Command |No|
| **Info** | string | Generally records the statements executed by the thread. |No|
| **ClientHost** | string | Client Source IP Address |No|
| **DBID** | string | Database Resource ID |No|
| **Role** | string | Database Role (Master/Slave) |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListUDBProxyClient
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=jgfkYodX
&UDBProxyID=DYvlHomp
```

### Response Example
    
```json
{
  "Action": "ListUDBProxyClientResponse",
  "NodeClientInfos": [
    {
      "ID": "XMzPaFXa",
      "IP": "FKtUfzpg",
      "Records": [
        {
          "Count": 5,
          "IP": "GUjJGHGa"
        }
      ]
    }
  ],
  "RetCode": 0,
  "UDBProxyID": "LTXRBQLw"
}
```