All Products
Search
Document Center

ENS:DescribeFileSystems

Last Updated:Mar 12, 2024

Queries the information about file systems.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the region.

cn-beijing-cmcc
FileSystemIdstringNo

The ID of the file system.

c50f8*****
FileSystemNamestringNo

The name of the file system.

FileSystem1
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. The maximum value is 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

2
TotalCountinteger

The total number of entries returned.

1
FileSystemsobject []

The information about the file systems.

FileSystemIdstring

The ID of the file system.

c50f8*****
FileSystemNamestring

The name of the file system.

FileSystem1
EnsRegionIdstring

The ID of the region.

cn-beijing-cmcc
StorageTypestring

The storage type. Valid values:

  • capacity: Capacity NAS file systems
  • performance: Performance NAS file systems
capacity
ProtocolTypestring

The protocol type of the file system. Valid values:

  • NFS: Network File System (NFS)
  • SMB: Server Message Block (SMB)
NFS
Capacitylong

The capacity of the file system. Unit: MiB.

100000
MeteredSizelong

The storage usage of the file system. The value of this parameter is the maximum storage usage of the file system over the last hour. Unit: bytes.

102400
Statusstring

The status of the file system. Valid values:

  • pending: The file system is being created or modified.
  • running: The file system is available. Before you create a mount target for the file system, make sure that the file system is in the running state.
  • stopped: The file system is unavailable.
  • extending: The file system is being scaled out.
  • stopping: The file system is being disabled.
  • deleting: The file system is being deleted.
running
PayTypestring

The billing method. PostPaid is returned. PostPaid indicates the pay-as-you-go billing method.

PostPaid
CreationTimestring

The time when the file system was created.

2022-08-31 12:00:00
MountTargetsobject []

The information about mount targets.

MountTargetDomainstring

The path of the mount target.

*.*.*.*:/${FileSystemName}/{MountTargetName}
MountTargetNamestring

The name of the mount target.

target1
NetWorkIdstring

The ID of the network.

n-****
Statusstring

The status of the mount target. Valid values:

  • active: The mount target is available.
  • inactive: The mount target is unavailable.
  • pending: The task is running.
  • deleting: The mount target is being deleted.
active
RequestIdstring

The ID of the request.

762DD527-358B-1E48-8005-CCE3ED4EB9E0

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 2,
  "TotalCount": 1,
  "FileSystems": [
    {
      "FileSystemId": "c50f8*****",
      "FileSystemName": "FileSystem1",
      "EnsRegionId": "cn-beijing-cmcc",
      "StorageType": "capacity",
      "ProtocolType": "NFS",
      "Capacity": 100000,
      "MeteredSize": 102400,
      "Status": "running",
      "PayType": "PostPaid",
      "CreationTime": "2022-08-31 12:00:00",
      "MountTargets": [
        {
          "MountTargetDomain": "*.*.*.*:/${FileSystemName}/{MountTargetName}",
          "MountTargetName": "target1",
          "NetWorkId": "n-****",
          "Status": "active"
        }
      ]
    }
  ],
  "RequestId": "762DD527-358B-1E48-8005-CCE3ED4EB9E0"
}

Error codes

HTTP status codeError codeError message
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history