Query file systems by calling DescribeFileSystems - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries 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

nas:DescribeFileSystems

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	No	The file system ID. General-purpose NAS: 31a8e4**. Extreme NAS: must start with extreme-, such as extreme-0015. Cloud Parallel File Storage (CPFS) (locally redundant): must start with cpfs-, such as cpfs-125487. CPFS SE (zone-redundant): must start with cpfsse-, such as cpfsse-022c71b134**.	31a8e4****
FileSystemType	string	No	The file system type. Valid values: all (default): queries all types. standard: General-purpose NAS. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS) (locally redundant). cpfsse: CPFS SE (zone-redundant). Note To query multiple types, separate them with commas (,).	standard
VpcId	string	No	The virtual private cloud (VPC) ID. The VPC must be the same as the VPC of the Elastic Computing Service (ECS) server to which you want to mount the file system.	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	No	The number of file systems on each page during a paged query. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number of the file system list. Start value (default value): 1.	1
StorageType	string	No
Tag	array<object>	No	The tag information.
	object	No	The tag information.
Key	string	No	The tag key. Limits: Valid values of N: 1 to 20. The tag key can be up to 128 characters in length. The tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	testKey
Value	string	No	The tag value. Limits: Valid values of N: 1 to 20. The tag value can be up to 128 characters in length. The tag value cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`.	testValue
ResourceGroupId	string	No	The resource group ID. You can view the resource group ID in the Resource Management console.	rg-acfmwavnfef****

Response elements

Element	Type	Description	Example
	object
FileSystems	object
FileSystem	array<object>	The file system list.
	array<object>
Status	string	The file system status. Valid values: Pending: The file system is processing a node. Running: The file system is active. You can perform what to do next (such as creating a mount target) only when the status is Running. Stopped: The file system is unavailable. Extending: The file system is being scaled out. Stopping: The file system is being stopped. Deleting: The file system is being deleted.	Pending
MeteredIASize	integer	The storage usage of the IA storage class. Unit: bytes.	362832
Capacity	integer	The capacity of the file system. Unit: GiB.	100
CreateTime	string	The time when the file system was created.	2020-01-05T16:00:00Z
ChargeType	string	The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. Package: a storage plan is attached.	PayAsYouGo
Tags	object
Tag	array<object>	The tag information of the file system.
	object
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
StorageType	string	The storage type. Valid values: General-purpose NAS: Capacity, Performance, Premium Extreme NAS: standard, advance CPFS: advance_100 (100 MB/s/TiB baseline), advance_200 (200 MB/s/TiB baseline), economic CPFS SE: advance_100 (100 MB/s/TiB baseline)	Performance
MeteredSize	integer	The standard storage usage of the file system. This is not a real-time value. It represents the maximum usage in the previous hour. Unit: bytes. Note To view the total storage capacity of a file system, see Query file system resource usage.	1611661312
Description	string	The description of the file system.	test
Bandwidth	integer	The bandwidth of the file system. Unit: MB/s. This field is not returned for General-purpose NAS file systems.	150
SupportedFeatures	object
SupportedFeature	array	The features supported by the file system.
	string	The feature supported by the file system. Valid values: Lifecycle: lifecycle management. ACL: access control list. Ipv6: IPv6. Note Currently, only Extreme NAS file systems in the Chinese mainland regions support IPv6.	Lifecycle
Version	string	The version number of the file system. This field applies to Extreme NAS and CPFS file systems.	2.3.4
ProtocolType	string	The protocol type of the file system. Valid values: NFS: NFS protocol. SMB: SMB protocol. cpfs: the protocol type supported by CPFS or CPFS SE file systems.	NFS
MountTargets	object
MountTarget	array<object>	The mount target information.
	array<object>
VpcId	string	The VPC ID.	vpc-bp1sevsgtqvk5gxbl****
Status	string	The mount target status. Valid values: Active: available. Inactive: unavailable. Pending: processing a task. Deleting: being deleted. Hibernating: entering hibernation. Hibernated: hibernated.	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	The client management node information. This parameter is returned only for CPFS file systems.
	object
EcsId	string	The ECS instance ID of the management node.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	The default logon password of the management node.	123456
EcsIp	string	The IP address of the ECS instance for the management node.	192.168.1.0
MountTargetDomain	string	The mount target domain.	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	The name of the permission group used by the mount target.	test-001
DualStackMountTargetDomain	string	The dual-stack (IPv4 and IPv6) mount target domain. Note Only Extreme NAS file systems in the Chinese mainland regions support IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	The vSwitch ID.	vsw-bp1omfzsszekkvaxn****
Tags	object
Tag	array<object>	The tag information of the mount target.
	object
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
NetworkType	string	The network type. The value is vpc, which indicates VPC.	vpc
KMSKeyId	string	The KMS key ID.	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	The automatic snapshot policy ID.	sp-extreme-09npwxadu1eqvw****
RegionId	string	The region ID.	cn-hangzhou
FileSystemType	string	The file system type. Valid values: standard: General-purpose NAS. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS), locally redundant. cpfsse: CPFS SE, zone-redundant.	standard
FileSystemId	string	The file system ID.	109c04****
EncryptType	integer	The encryption type. Valid values: 0: not encrypted. 1: NAS-managed key. 2: Custom Key (KMS).	1
Ldap	object	The LDAP configuration information. This parameter is returned only for CPFS file systems.
BindDN	string	The distinguished name (DN) used to bind to the LDAP server.	cn=alibaba,dc=com
SearchBase	string	The LDAP search base.	dc=example
URI	string	The LDAP server address.	ldap://ldap.example.example
ExpiredTime	string	The expiration time of the file system.	2020-01-05T16:00:00Z
ZoneId	string	The zone in which the file system resides.	cn-hangzhou-b
VpcId	string	The VPC ID.	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	The vSwitch information.
	string	The vSwitch ID.	vsw-bp1omfzsszekkvaxn****
Packages	object
Package	array<object>	The storage plan information.
	object
StartTime	string	The start time of the storage plan.	2019-12-05T01:40:56Z
ExpiredTime	string	The expiration time of the storage plan.	2020-01-05T16:00:00Z
Size	integer	The capacity of the storage plan. Unit: bytes.	107374182400
PackageId	string	The storage plan ID.	naspackage-0be9c4b624-37****
PackageType	string	The storage plan type. Valid values: ssd: Performance. hybrid: Capacity.	hybrid
AccessPointCount	string	The number of access points.	1
ResourceGroupId	string	The resource group ID.	rg-acfmwavnfef****
MeteredArchiveSize	integer	The storage usage of the archive storage class. Unit: bytes.	1611661312
Options	object	The options.
EnableOplock	boolean	Indicates whether the OpLock feature is enabled. Valid values: true: Enabled. false: Disabled. Note Only file systems that use the SMB Protocol Type support this feature.	true
VscAccessPointAccessOnly	boolean
EnableABE	boolean
QuorumVswId	string	The vSwitch ID.	vsw-bp1omfzsszekkvaxn****
VscTarget	string	Note This parameter is not yet available.	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
RedundancyType	string	The storage redundancy type. This field has a value only for CPFS SE file systems.	LRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	The list of zone-redundant vSwitch IDs.
	string	The list of zone-redundant vSwitch IDs. This field has a value when RedundancyType is set to ZRS.	vsw-123xxx
RequestId	string	The request ID.	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	The total number of file systems.	1
PageSize	integer	The number of file systems on each page.	1
PageNumber	integer	The page number of the file system list.	1

Examples

Success response

JSON format

{
  "FileSystems": {
    "FileSystem": [
      {
        "Status": "Pending",
        "MeteredIASize": 362832,
        "Capacity": 100,
        "CreateTime": "2020-01-05T16:00:00Z",
        "ChargeType": "PayAsYouGo",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "StorageType": "Performance",
        "MeteredSize": 1611661312,
        "Description": "test",
        "Bandwidth": 150,
        "SupportedFeatures": {
          "SupportedFeature": [
            "Lifecycle"
          ]
        },
        "Version": "2.3.4",
        "ProtocolType": "NFS",
        "MountTargets": {
          "MountTarget": [
            {
              "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
              "Status": "Active",
              "ClientMasterNodes": {
                "ClientMasterNode": [
                  {
                    "EcsId": "i-hp3i3odi5ory1buo****",
                    "DefaultPasswd": "123456",
                    "EcsIp": "192.168.1.0"
                  }
                ]
              },
              "MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
              "AccessGroupName": "test-001",
              "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
              "VswId": "vsw-bp1omfzsszekkvaxn****",
              "Tags": {
                "Tag": [
                  {
                    "Key": "testKey",
                    "Value": "testValue"
                  }
                ]
              },
              "NetworkType": "vpc"
            }
          ]
        },
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "AutoSnapshotPolicyId": "sp-extreme-09npwxadu1eqvw****",
        "RegionId": "cn-hangzhou",
        "FileSystemType": "standard",
        "FileSystemId": "109c04****",
        "EncryptType": 1,
        "Ldap": {
          "BindDN": "cn=alibaba,dc=com",
          "SearchBase": "dc=example",
          "URI": "ldap://ldap.example.example"
        },
        "ExpiredTime": "2020-01-05T16:00:00Z",
        "ZoneId": "cn-hangzhou-b",
        "VpcId": "vpc-bp1sevsgtqvk5gxbl****\n",
        "VswIds": {
          "VswId": [
            "vsw-bp1omfzsszekkvaxn****\n"
          ]
        },
        "Packages": {
          "Package": [
            {
              "StartTime": "2019-12-05T01:40:56Z",
              "ExpiredTime": "2020-01-05T16:00:00Z",
              "Size": 107374182400,
              "PackageId": "naspackage-0be9c4b624-37****",
              "PackageType": "hybrid"
            }
          ]
        },
        "AccessPointCount": "1",
        "ResourceGroupId": "rg-acfmwavnfef****\n",
        "MeteredArchiveSize": 1611661312,
        "Options": {
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false,
          "EnableABE": false
        },
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "RedundancyType": "LRS",
        "RedundancyVSwitchIds": {
          "RedundancyVSwitchId": [
            "vsw-123xxx"
          ]
        }
      }
    ]
  },
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "TotalCount": 1,
  "PageSize": 1,
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	Region.NotSupported	The specified Region is not supported for this API now.	The current region does not support this function.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.