Queries the information of file systems.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeFileSystems |
The operation that you want to perform. Set the value to DescribeFileSystems. |
FileSystemId | String | No | 109c04**** |
The ID of the file system. |
FileSystemType | String | No | standard |
The type of the file system. Default value: all. Valid values:
|
VpcId | String | No | vpc-bp1sevsgtqvk5gxbl**** |
The ID of the VPC. If you want to mount the file system on an Elastic Compute Service (ECS) instance, the file system and the ECS instance must reside in the same virtual private cloud (VPC). |
PageSize | Integer | No | 1 |
The number of entries to return on each page. Valid values: 1 to 100. Default value: 10. |
PageNumber | Integer | No | 1 |
The number of the page to return. Minimum value: 1. Default value: 1. |
Tag.N.Key | String | No | N/A |
The key of tag N. Limits:
|
Tag.N.Value | String | No | N/A |
The value of tag N. Limits:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 1 |
The number of entries returned per page. |
RequestId | String | 035B3A3A-E514-4B41-B906-5D906CFB**** |
The ID of the request. |
TotalCount | Integer | 1 |
The total number of file systems. |
FileSystems | Array of FileSystem |
The list of file systems. |
|
FileSystem | |||
Bandwidth | Long | 150 |
The bandwidth of the file system. Unit: MB/s. This parameter is unavailable for General-purpose NAS file systems. |
Capacity | Long | 1 |
The capacity of the file system. Unit: GiB. |
ChargeType | String | PayAsYouGo |
The billing method of the file system. Valid values:
|
CreateTime | String | 2017-05-27T15:43:06CST |
The time when the file system was created. |
Description | String | 31a8e48eda |
The description of the file system. |
EncryptType | Integer | 1 |
The type of the encryption. Valid values:
|
ExpiredTime | String | 2017-08-27T15:43:06CST |
The expiration time of the file system. |
FileSystemId | String | 109c04**** |
The ID of the file system. |
FileSystemType | String | all |
The type of the file system. Valid values:
|
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
The ID of the key that is managed by Key Management Service (KMS). |
Ldap | Struct |
The configuration of the Lightweight Directory Access Protocol (LDAP). This parameter is available only for CPFS file systems. |
|
BindDN | String | cn=alibaba,dc=com |
An LDAP entry. |
SearchBase | String | dc=example |
An LDAP search base. |
URI | String | ldap://ldap.example.example |
An LDAP URI. |
MeteredIASize | Long | 362832 |
The used space of the Infrequent Access (IA) storage medium. Unit: bytes. |
MeteredSize | Long | 1611661312 |
The used space of the file system. The value of this parameter is the maximum used space of the file system over the last hour. Unit: bytes. |
MountTargets | Array of MountTarget |
The list of mount targets. |
|
MountTarget | |||
AccessGroupName | String | test-001 |
The name of the permission group that is attached to the mount target. |
ClientMasterNodes | Array of ClientMasterNode |
The list of clients in the management node. |
|
ClientMasterNode | |||
DefaultPasswd | String | 123456 |
The default logon password of the ECS instance in the management node. |
EcsId | String | i-hp3i3odi5ory1buo**** |
The ID of the ECS instance in the management node. |
EcsIp | String | 192.168.1.0 |
The IP address of the ECS instance in the management node. |
DualStackMountTargetDomain | String | 174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com |
The dual-stack domain name of the mount target. |
MountTargetDomain | String | 109c042666-w****.cn-hangzhou.nas.aliyuncs.com |
The domain name of the mount target. |
NetworkType | String | vpc |
The network type of the mount target. Valid values:
|
Status | String | active |
The status of the mount target. Valid values:
|
Tags | Array of Tag |
The list of tags that are attached to the mount target. |
|
Tag | |||
Key | String | adasfsdfd |
The key of the tag. |
Value | String | afsa |
The value of the tag. |
VpcId | String | vpc-bp1sevsgtqvk5gxbl**** |
The ID of the VPC. |
VswId | String | vsw-bp1omfzsszekkvaxn**** |
The ID of the vSwitch. |
Packages | Array of Package |
The list of storage plans. |
|
Package | |||
ExpiredTime | String | 2020-01-05T16:00:00Z |
The end time of the validity period for the storage plan. |
PackageId | String | naspackage-0be9c4b624-37**** |
The ID of the storage plan. |
PackageType | String | hybrid |
The type of the storage plan. Valid values:
|
Size | Long | 107374182400 |
The capacity of the storage plan. |
StartTime | String | 2019-12-05T01:40:56Z |
The start time of the validity period for the storage plan. |
ProtocolType | String | NFS |
The type of the protocol. Valid values:
|
RegionId | String | cn-hangzhou |
The ID of the region. |
Status | String | Pending |
The status of the fie system. This parameter is returned for Extreme NAS and CPFS file systems. Valid values:
|
StorageType | String | Performance |
The type of the storage. Valid values:
|
SupportedFeatures | List | Lifecycle |
The features that are supported by the file system. Valid values:
Note Only Extreme NAS file systems that reside in the China (Hohhot) region support IPv6.
|
Tags | Array of Tag |
The list of tags that are attached to the file system. |
|
Tag | |||
Key | String | sdf |
The key of the tag. |
Value | String | asd123 |
The value of the tag. |
Version | String | 1 |
The version number of the file system. This parameter is available only for Extreme NAS file systems. |
ZoneId | String | cn-hangzhou-b |
The ID of the zone where the file system resides. |
Examples
Sample request
http(s)://[Endpoint]/? Action=DescribeFileSystems
&<Common request parameters>
Sample success responses
XML
format
<FileSystems>
<FileSystem>
<Status>Pending</Status>
<KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
<StorageType>Performance</StorageType>
<Description>31a8e48eda</Description>
<ZoneId>cn-hangzhou-b</ZoneId>
<MeteredIASize>362832</MeteredIASize>
<CreateTime>2017-05-27T15:43:06CST</CreateTime>
<MeteredSize>1611661312</MeteredSize>
<EncryptType>1</EncryptType>
<Version>1</Version>
<Capacity>1</Capacity>
<ChargeType>PayAsYouGo</ChargeType>
<ProtocolType>NFS</ProtocolType>
<Bandwidth>150</Bandwidth>
<FileSystemType>all</FileSystemType>
<ExpiredTime>2017-08-27T15:43:06CST</ExpiredTime>
<FileSystemId>109c04****</FileSystemId>
<RegionId>cn-hangzhou</RegionId>
</FileSystem>
<FileSystem>
<MountTargets>
<MountTarget>
<Status>active</Status>
<DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>
<VswId>vsw-bp1omfzsszekkvaxn****</VswId>
<VpcId>vpc-bp1sevsgtqvk5gxbl****</VpcId>
<MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
<NetworkType>vpc</NetworkType>
<AccessGroupName>test-001</AccessGroupName>
</MountTarget>
<MountTarget>
<ClientMasterNodes>
<ClientMasterNode>
<EcsId>i-hp3i3odi5ory1buo****</EcsId>
<EcsIp>192.168.1.0</EcsIp>
<DefaultPasswd>123456</DefaultPasswd>
</ClientMasterNode>
</ClientMasterNodes>
<Tags>
<Tag>
<Value>afsa</Value>
<Key>adasfsdfd</Key>
</Tag>
</Tags>
</MountTarget>
</MountTargets>
<Packages>
<Package>
<StartTime>2019-12-05T01:40:56Z</StartTime>
<PackageId>naspackage-0be9c4b624-37****</PackageId>
<Size>107374182400</Size>
<ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>
<PackageType>hybrid</PackageType>
</Package>
</Packages>
<Tags>
<Tag>
<Value>asd123</Value>
<Key>sdf</Key>
</Tag>
</Tags>
</FileSystem>
<FileSystem>
<SupportedFeatures>
<SupportedFeature>Lifecycle</SupportedFeature>
</SupportedFeatures>
</FileSystem>
<FileSystem>
<Ldap>
<SearchBase>dc=example</SearchBase>
<URI>ldap://ldap.example.example</URI>
<BindDN>cn=alibaba,dc=com</BindDN>
</Ldap>
</FileSystem>
</FileSystems>
<TotalCount>1</TotalCount>
<PageSize>1</PageSize>
<RequestId>035B3A3A-E514-4B41-B906-5D906CFB****</RequestId>
<PageNumber>1</PageNumber>
JSON
format
{
"FileSystems": {
"FileSystem": [
{
"Status": "Pending",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
"StorageType": "Performance",
"Description": "31a8e48eda",
"ZoneId": "cn-hangzhou-b",
"MeteredIASize": 362832,
"CreateTime": "2017-05-27T15:43:06CST",
"MeteredSize": 1611661312,
"EncryptType": 1,
"Version": 1,
"Capacity": 1,
"ChargeType": "PayAsYouGo",
"ProtocolType": "NFS",
"Bandwidth": 150,
"FileSystemType": "all",
"ExpiredTime": "2017-08-27T15:43:06CST",
"FileSystemId": "109c04****",
"RegionId": "cn-hangzhou"
},
{
"MountTargets": {
"MountTarget": [
{
"Status": "active",
"DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
"VswId": "vsw-bp1omfzsszekkvaxn****",
"VpcId": "vpc-bp1sevsgtqvk5gxbl****",
"MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
"NetworkType": "vpc",
"AccessGroupName": "test-001"
},
{
"ClientMasterNodes": {
"ClientMasterNode": {
"EcsId": "i-hp3i3odi5ory1buo****",
"EcsIp": "192.168.1.0",
"DefaultPasswd": 123456
}
},
"Tags": {
"Tag": {
"Value": "afsa",
"Key": "adasfsdfd"
}
}
}
]
},
"Packages": {
"Package": {
"StartTime": "2019-12-05T01:40:56Z",
"PackageId": "naspackage-0be9c4b624-37****",
"Size": 107374182400,
"ExpiredTime": "2020-01-05T16:00:00Z",
"PackageType": "hybrid"
}
},
"Tags": {
"Tag": {
"Value": "asd123",
"Key": "sdf"
}
}
},
{
"SupportedFeatures": {
"SupportedFeature": "Lifecycle"
}
},
{
"Ldap": {
"SearchBase": "dc=example",
"URI": "ldap://ldap.example.example",
"BindDN": "cn=alibaba,dc=com"
}
}
]
},
"TotalCount": 1,
"PageSize": 1,
"RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
"PageNumber": 1
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | The error message returned because the specified file system does not exist. |
For a list of error codes, visit the API Error Center.