DescribeFileSystems API reference for querying file systems - ENS

Query NAS file system information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeFileSystems

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the region.	cn-beijing-cmcc
FileSystemId	string	No	The ID of the file system.	c50f8*****
FileSystemName	string	No	The name of the file system.	FileSystem1
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	2
TotalCount	integer	The total number of entries returned.	1
FileSystems	array<object>	The information about the file systems.
	array<object>
FileSystemId	string	The ID of the file system.	c50f8*****
FileSystemName	string	The name of the file system.	FileSystem1
EnsRegionId	string	The ID of the region.	cn-beijing-cmcc
StorageType	string	The storage type. Valid values: capacity: Capacity NAS file systems performance: Performance NAS file systems	capacity
ProtocolType	string	The protocol type of the file system. Valid values: NFS: Network File System (NFS) SMB: Server Message Block (SMB)	NFS
Capacity	integer	The capacity of the file system. Unit: MiB.	100000
MeteredSize	integer	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
Status	string	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
PayType	string	The billing method. PostPaid is returned. PostPaid indicates the pay-as-you-go billing method.	PostPaid
CreationTime	string	The time when the file system was created.	2022-08-31 12:00:00
MountTargets	array<object>	The information about mount targets.
	object
MountTargetDomain	string	The path of the mount target.	...:/${FileSystemName}/{MountTargetName}
MountTargetName	string	The name of the mount target.	target1
NetWorkId	string	The ID of the network.	n-****
Status	string	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
Description	string	Description.	test
RequestId	string	The ID of the request.	762DD527-358B-1E48-8005-CCE3ED4EB9E0

Examples

Success response

JSON format

{
  "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"
        }
      ],
      "Description": "test"
    }
  ],
  "RequestId": "762DD527-358B-1E48-8005-CCE3ED4EB9E0"
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	Permission denied.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.