# Query Space - DescribeUMemSpace

## Overview

Get UMem Memory Space List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUMemSpace`.                      | **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) |No|
| **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|
| **Offset** | int | Data offset, default is 0 |No|
| **Limit** | int | Return data length, default is 20 |No|
| **SpaceId** | string | Memory Space ID (If no ID, then retrieve all) |No|
| **Protocol** | string | Protocol Type: memcache, redis |No|

### 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[[*UMemSpaceSet*](#umemspaceset)] | JSON formatted UMem memory space instance list, see UMemSpaceSet for details. |No|
| **TotalCount** | int | Total count based on filter conditions |No|

#### Data Model


#### UMemSpaceSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Availability Zone, see [Availability Zone List](api/summary/regionlist) |No|
| **Tag** | string | instance tag |**Yes**|
| **RewriteTime** | int | Operation and Maintenance Time<br />0   //0 o'clock<br />1   //1 o'clock<br />And so on |**Yes**|
| **SpaceId** | string | Memory Space ID |No|
| **SubnetId** | string | Subnet ID |No|
| **VPCId** | string | VPC ID |No|
| **Name** | string | Memory Space Name |No|
| **CreateTime** | int | Creation Time |No|
| **ExpireTime** | int | Expiration Date |No|
| **Type** | string | Space Type: single (no hot backup), double (hot backup) |No|
| **Protocol** | string | Protocol Type: memcache, redis |No|
| **Size** | int | Capacity Unit GB |No|
| **UsedSize** | int | Usage Unit MB |No|
| **State** | string | Starting: Creating Running: Running Fail: Failure |No|
| **ChargeType** | string | Yearly, Monthly, Dynamic, Trial |No|
| **Address** | array[[*UMemSpaceAddressSet*](#umemspaceaddressset)] | Please refer to UMemSpaceAddressSet for IP port information. |No|
| **SupportAofRollback** | boolean | Does the instance support rollback? |No|
| **AofRollbackEnable** | boolean | Is the instance rollback enabled? |No|

#### UMemSpaceAddressSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **IP** | string | UMem Instance Access IP |No|
| **PrivateDomain** | string | The UMem instance's internal network access domain address returns an empty value when it is not enabled. |No|
| **PublicIp** | string | Public IP if enabled, otherwise empty |No|
| **Port** | int | UMem Instance Access Port |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeUMemSpace
&Region=cn-bj2

&Protocol=dSWWMtLZ
```

### Response Example
    
```json
{
  "Action": "DescribeUMemSpaceResponse",
  "DataSet": [
    {
      "Address": [
        {
          "IP": "XX.19X.1XX.4XX",
          "Port": 11211
        }
      ],
      "ChargeType": "Month",
      "CreateTime": 1529894002,
      "ExpireTime": 1530374400,
      "Name": "fbs_XXXX",
      "Protocol": "memcache",
      "Size": 8,
      "SpaceId": "umem-m3XXXXXX3",
      "State": "Running",
      "SubnetId": "subnet-iiXXXXz",
      "Tag": "Default",
      "Type": "double",
      "UsedSize": 0,
      "VPCId": "uvnet-XXXXXX4j",
      "Zone": "cn-bj2-04"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}
```