# Fetch udredis proxy information - DescribeUDRedisProxyInfo

## Overview

Pull all proxy information of udredis






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUDRedisProxyInfo`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.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|
| **SpaceId** | string | udredis instance 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|
| **DataSet** | array[[*UDRedisProxyInfo*](#udredisproxyinfo)] | UDProxy |**Yes**|

#### Data Model


#### UDRedisProxyInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ResourceId** | string | Proxy Resource ID |**Yes**|
| **ProxyId** | string | Proxy ID |**Yes**|
| **Vip** | string | Proxy IP |**Yes**|
| **State** | string | Proxy Status [PROXY_CREATING: Creating, PROXY_NORMAL: Running Normally, PROXY_FAILED: Creation Failed, PROXY_CLOSED: Closed, PROXY_INIT_RESIZE: Initializing Core Adjustment, PROXY_WAIT_RESIZE: Waiting for Core Adjustment, PROXY_RESIZING: Core Adjusting, PROXY_RESIZE_ERROR: Core Adjustment Failed] |**Yes**|
| **CPU** | int | Proxy CPU Cores |**Yes**|
| **ProxyType** | int | 0: Physical Machine Version Distributed Proxy, 1: NVME (or SSD) Version Distributed Proxy |**Yes**|
| **PublicIp** | string | Public IP if enabled, otherwise empty |No|
| **SupportReadOnly** | boolean | Does the proxy support read-only settings? |No|
| **ReadOnly** | boolean | Is the proxy read-only? |No|
| **ReadMode** | string |  |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeUDRedisProxyInfo
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=TjgvEJaX
&SpaceId=WACSTNZf
```

### Response Example
    
```json
{
  "Action": "DescribeUDRedisProxyInfoResponse",
  "DataSet": [
    {
      "CPU": 6,
      "ProxyId": "wjhBFGjw",
      "ProxyType": 4,
      "ResourceId": "gVaugysY",
      "State": "HnRVTTox",
      "Vip": "XbBCnxli"
    }
  ],
  "RetCode": 0
}
```