# Get UPFS File System List - DescribeUPFSVolume

## Overview

Get UPFS File System List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUPFSVolume`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.nubexcloud.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|
| **VolumeId** | string | File System ID |No|
| **Offset** | int | Start of File List |No|
| **Limit** | int | File List Length |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|
| **TotalCount** | int | Total Number of File Systems |**Yes**|
| **DataSet** | array[[*UPFSVolumeInfo*](#upfsvolumeinfo)] | File System Detailed Information List |**Yes**|

#### Data Model


#### UPFSVolumeInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Zone Name |No|
| **VolumeName** | string | File System Name |No|
| **VolumeId** | string | File System ID |No|
| **ProtocolType** | string | File System Protocol Type |No|
| **Remark** | string | File System Remarks Information |No|
| **Tag** | string | File System's Business Group |No|
| **CreateTime** | int | File system creation time (unix timestamp) |No|
| **ExpiredTime** | int | File system expiration time (unix timestamp) |No|
| **Size** | int | File system size, unit GB |No|
| **IsExpired** | string | Is it expired? |No|
| **ChargeType** | string | Billing Type |No|
| **MountStatus** | int | File System Mount Status |No|
| **MountAddress** | string | File System Mount Address |No|

## Example

### Request Example
    
```
https://api.nubexcloud.com/?Action=DescribeUPFSVolume
&Region=cn-zj
&ProjectId=yDBpseTQ
&VolumeId=TMblQHoJuoOViGPsxOzfCtimAOCeONyujjXRnMHtgKuOIlzsvtJLbrVhbTBLtaZWhxMeAbTNvLhwPwNoLOrguQbIjeFDVXngioewkQwYNtmlgGLIGKCbwntzeXhQvYuHmZCktKYWFKjeyJGrqtaEVSlckMDnPuFSAizSKtzGbmKAdxoJKdPpmvFKbHVLDFrHmoKAJxMGYiBDkZcLDUklvJQvDcDASEDLSQVqAwaLrLKVMXyJzrPcZiznAJImcadPjYrUfqCMpglWQJKrqFibFIoOtyDGUNDpBRQpfZVeSYYeqpazuJCXUSQvuWReyNJNyXvKHQZaOjWX
&Offset=9
&Limit=5500
&Zone=kvsqAKXH
```

### Response Example
    
```json
{
  "Action": "DescribeUPFSVolumeResponse",
  "DataSet": [
    {
      "CreateTime": 2,
      "ExpiredTime": 6,
      "IsExpired": "Yes",
      "MaxMountPointNum": 1,
      "ProtocolType": "eunAkFuF",
      "Remark": "xOwtCWxh",
      "Size": 2,
      "StorageType": "OLslEoSV",
      "Tag": "eAfYVwJb",
      "TotalMountPointNum": null,
      "UsedSize": 3,
      "VolumeId": "HPcVtkAkOkKSBnNPIjNaoIHJaFdoKcQZzRQcmbmBLGRySWEOXkoyiBUOxLaGFUtJKuCCzcbAoowEhgpGlwVQklcZdYIIwGEPjCmeOtGTCWXLdLdLnfPmODNcPhhlyLYBBRzHXbssTxDinSvGayMRwOEDCNMwPlpatJXDEIwAOtqCDXtqcTBNRKuDcKiIqvIgeFfRywlpklfJdxRfSTZyGVtzLcroNtAEIvJNlwkOYucGgOElBHRsAtFdKLFVoqGSusXZapuaLdaGyXclMlKAnFwpWUJzhmnfRhQullBDAmgwpfPCgqWrpyoggMRLynuAAXoFEhNWmOnX",
      "VolumeName": "wjbRdupnGmtmhStkWotqmfpdeZiBdFKsryWilyrxdWOSvSrUCYtPsrPcoRDcGZDmRHKlFhtfCMzgMcpvkQhrZmTsJIGGJJsvXtTvFrUmYBZbIUCaLYuKCaBxncVLHRgDkiItSrnFXsHeTeTXJFxTHLevCivCbOAeuhTUGPdnJuOkrGtXgsgXBwwHRBugBYCBksHviLakfuzkBCHWlhkyvrhGxJGjlizZfBuJgBIRabebYwPKpnfvkRXgTdGXZPdFkiMowDqAotTfgcUtESmmuGbtiUpLXXauwliEbOeBluIBFYSMCEILRJHFPoynzxrDcwFBOopHyksQ"
    }
  ],
  "RetCode": 0,
  "TotalCount": 7
}
```