Queries file systems.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| nas:DescribeFileSystems | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileSystemId | string | No | The ID of the file system.
Note
CPFS file systems are available only on the China site (aliyun.com).
| 31a8e4**** |
| FileSystemType | string | No | The type of the file system. Valid values:
Note
CPFS file systems are available only on the China site (aliyun.com).
| standard |
| VpcId | string | No | The ID of the virtual private cloud (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 VPC. | vpc-bp1sevsgtqvk5gxbl**** |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| Tag | array<object> | No | The details about the tags. | |
| object | No | |||
| Key | string | No | The key of tag N to add to the resource. Limits:
| test |
| Value | string | No | The value of tag N to add to the resource. Limits:
| test-value |
| ResourceGroupId | string | No | The resource group ID. You can log on to the Resource Management console to view resource group IDs. | rg-acfmwavnfdf**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"FileSystems": {
"FileSystem": [
{
"Status": "Pending",
"MeteredIASize": 362832,
"Capacity": 100,
"CreateTime": "2020-01-05T16:00:00Z",
"ChargeType": "PayAsYouGo",
"Tags": {
"Tag": [
{
"Key": "test",
"Value": "test-value"
}
]
},
"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": "test",
"Value": "test-value"
}
]
},
"NetworkType": "vpc"
}
]
},
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
"AutoSnapshotPolicyId": "sp-extreme-233e6****\n",
"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-bp1cbv1ljve4j5hlw****\n",
"VswIds": {
"VswId": [
"vsw-2ze37k6jh8ums2fw2****\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-acfmwavnfdf****\n",
"MeteredArchiveSize": 1611661312,
"Options": {
"EnableOplock": true
},
"QuorumVswId": "vsw-2ze37k6jh8ums2fw2****\n"
}
]
},
"TotalCount": 1,
"RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-17 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-10-08 | The Error code has changed | View Change Details |
| 2024-07-08 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-03-25 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-12-26 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-11-03 | The Error code has changed | View Change Details |
| 2023-10-05 | The Error code has changed | View Change Details |
| 2023-04-29 | The Error code has changed | View Change Details |
| 2022-07-29 | The Error code has changed. The response structure of the API has changed | View Change Details |