DescribeFileSystems-阿里云帮助中心

Retrieves 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 ID of the file system. General-purpose NAS: For example, `31a8e4**`. Extreme NAS: The ID must start with `extreme-`, for example, `extreme-0015`. CPFS (locally redundant): The ID must start with `cpfs-`, for example, `cpfs-125487`. CPFS SE (zone-redundant): The ID must start with `cpfsse-`, for example, `cpfsse-022c71b134**`.	31a8e4****
FileSystemType	string	No	The type of the file system. Valid values: `all` (default): Returns all file system types. `standard`: General-purpose NAS. `extreme`: Extreme NAS. `cpfs`: CPFS (locally redundant). `cpfsse`: CPFS SE (zone-redundant). Note To query multiple file system types, separate the types with commas.	standard
VpcId	string	No	The ID of the VPC. You can mount the file system only on ECS instances in the same VPC.	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	No	The number of file systems to return per page. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number of the returned page. The value must be a positive integer. Default value: 1.	1
Tag	array<object>	No	The tags of the file system. You can specify a maximum of 20 tags.
	object	No	A tag.
Key	string	No	The key of tag N. A tag is a key-value pair. Limits: N specifies the serial number of the tag. 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 value of tag N. A tag is a key-value pair. Limits: N specifies the serial number of the tag. 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 ID of the resource group. For more information about resource groups, see the Resource Management console.	rg-acfmwavnfef****

Response elements

Element	Type	Description	Example
	object
FileSystems	object
FileSystem	array<object>	The list of file systems.
	array<object>
Status	string	The status of the file system. Valid values: `Pending`: The file system is processing a task. `Running`: The file system is available. You can perform subsequent operations, such as creating a mount target, only when the file system is in the `Running` state. `Stopped`: The file system is unavailable. `Extending`: The file system is being scaled up. `Stopping`: The file system is being stopped. `Deleting`: The file system is being deleted.	Pending
MeteredIASize	integer	The metered usage of Infrequent Access (IA) storage, in bytes.	362832
Capacity	integer	The capacity of the file system, in GiB.	100
CreateTime	string	The time when the file system was created.	2020-01-05T16:00:00Z
ChargeType	string	The billing method of the file system. Valid values: `Subscription`: The file system is subscription-based. `PayAsYouGo`: The file system is pay-as-you-go. `Package`: The file system is covered by a storage package.	PayAsYouGo
Tags	object
Tag	array<object>	The tags that are attached to the file system.
	object
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
StorageType	string	The storage type of the file system. Valid values: General-purpose NAS: `Capacity`, `Performance`, and `Premium` Extreme NAS: `standard` and `advance` Cloud Paralleled File System (CPFS): `advance_100` (100 MB/s/TiB baseline), `advance_200` (200 MB/s/TiB baseline), and `economic` CPFS SE: `advance_100` (100 MB/s/TiB baseline)	Performance
MeteredSize	integer	The metered storage usage of the file system. This value represents the peak usage in the previous hour and is not updated in real time. Unit: bytes. Note To view the total storage usage 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 parameter is not returned for General-purpose NAS file systems.	150
SupportedFeatures	object
SupportedFeature	array	The features that are supported by the file system.
	string	A feature that the file system supports. Valid values: `Lifecycle`: lifecycle management. `ACL`: access control list (ACL). `Ipv6`: IPv6. Note Currently, only Extreme NAS file systems in regions in the Chinese mainland support IPv6.	Lifecycle
Version	string	The version of the file system. This parameter is available only for Extreme NAS and CPFS file systems.	2.3.4
ProtocolType	string	The protocol type of the file system. Valid values: `NFS`: the NFS protocol `SMB`: the SMB protocol `cpfs`: The protocol for Cloud Paralleled File System (CPFS) or CPFS SE file systems.	NFS
MountTargets	object
MountTarget	array<object>	The mount targets.
	array<object>
VpcId	string	The ID of the VPC.	vpc-bp1sevsgtqvk5gxbl****
Status	string	The status of the mount target. Valid values: `Active`: The mount target is available. `Inactive`: The mount target is unavailable. `Pending`: The mount target is being created or modified. `Deleting`: The mount target is being deleted. `Hibernating`: The mount target is being hibernated. `Hibernated`: The mount target is hibernated.	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	The client master nodes. This parameter is returned only for CPFS file systems.
	object
EcsId	string	The ID of the ECS instance for the master node.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	The default login password for the master node.	123456
EcsIp	string	The IP address of the ECS instance for the master node.	192.168.1.0
MountTargetDomain	string	The domain name of the mount target.	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	The name of the permission group that the mount target uses.	test-001
DualStackMountTargetDomain	string	The dual-stack (IPv4 and IPv6) domain name of the mount target. Note Currently, only Extreme NAS file systems in regions in the Chinese mainland support IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	The ID of the vSwitch.	vsw-bp1omfzsszekkvaxn****
Tags	object
Tag	array<object>	The tags 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 a Virtual Private Cloud (VPC).	vpc
KMSKeyId	string	The ID of the key that is managed by Key Management Service (KMS).	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy.	sp-extreme-09npwxadu1eqvw****
RegionId	string	The ID of the region.	cn-hangzhou
FileSystemType	string	The type of the file system. Valid values: `standard`: General-purpose NAS `extreme`: Extreme NAS `cpfs`: A locally redundant Cloud Paralleled File System (CPFS). `cpfsse`: A zone-redundant Cloud Paralleled File System (CPFS).	standard
FileSystemId	string	The ID of the file system.	109c04****
EncryptType	integer	The encryption type. Valid values: `0`: Data is not encrypted. `1`: Data is encrypted by using a NAS-managed key. `2`: Data is encrypted by using a customer-managed key from Key Management Service (KMS).	1
Ldap	object	The LDAP configuration. This parameter is returned only for CPFS file systems.
BindDN	string	The distinguished name (DN) that is used to bind to the LDAP server.	cn=alibaba,dc=com
SearchBase	string	The base DN for LDAP searches.	dc=example
URI	string	The URI of the LDAP server.	ldap://ldap.example.example
ExpiredTime	string	The time when the file system expires.	2020-01-05T16:00:00Z
ZoneId	string	The ID of the zone where the file system resides.	cn-hangzhou-b
VpcId	string	The ID of the VPC.	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	The vSwitches.
	string	The ID of the vSwitch.	vsw-bp1omfzsszekkvaxn****
Packages	object
Package	array<object>	The storage packages.
	object
StartTime	string	The start time of the storage package.	2019-12-05T01:40:56Z
ExpiredTime	string	The expiration time of the storage package.	2020-01-05T16:00:00Z
Size	integer	The capacity of the storage package, in bytes.	107374182400
PackageId	string	The ID of the storage package.	naspackage-0be9c4b624-37****
PackageType	string	The type of the storage package. Valid values: `ssd`: a Performance storage package `hybrid`: a Capacity storage package	hybrid
AccessPointCount	string	The number of access points.	1
ResourceGroupId	string	The ID of the resource group.	rg-acfmwavnfef****
MeteredArchiveSize	integer	The metered usage of Archive storage, in bytes.	1611661312
Options	object	The options of the file system.
EnableOplock	boolean	Indicates whether opportunistic locks (oplocks) are enabled. Valid values: `true`: Oplocks are enabled. `false`: Oplocks are disabled. Note This parameter is available only for file systems that use the SMB protocol.	true
VscAccessPointAccessOnly	boolean
EnableABE	boolean
QuorumVswId	string	The ID of the vSwitch.	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 parameter is returned only for CPFS SE file systems.	LRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	The list of vSwitch IDs for zone-redundant storage.
	string	The ID of a vSwitch for zone-redundant storage. This parameter is returned only if the `RedundancyType` parameter is set to `ZRS`.	vsw-123xxx
RequestId	string	The ID of the request.	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	The total number of file systems.	1
PageSize	integer	The number of entries per page.	1
PageNumber	integer	The page number.	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.