查询文件系统信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nas:DescribeFileSystems | get | *FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileSystemId | string | 否 | 文件系统 ID。
说明
仅中国站支持 cpfs 文件系统。
| 31a8e4**** |
| FileSystemType | string | 否 | 文件系统类型。 取值：
说明
| standard |
| VpcId | string | 否 | 专有网络 ID。 必须与待挂载的云服务器 ECS 选择相同的 VPC 网络。 | vpc-bp1sevsgtqvk5gxbl**** |
| PageSize | integer | 否 | 分页查询时，每个分页包含的文件系统个数。 取值范围：1~100 默认值：10 | 1 |
| PageNumber | integer | 否 | 文件系统列表的分页页码。 起始值（默认值）：1。 | 1 |
| Tag | array<object> | 否 | 标签信息集合。 | |
| object | 否 | |||
| Key | string | 否 | 标签键。 限制：
| testKey |
| Value | string | 否 | 标签值。 限制：
| testValue |
| ResourceGroupId | string | 否 | 资源组 ID 您可以通过资源管理控制台查看资源组 ID。 | rg-acfmwavnfef**** |
返回参数
示例
正常返回示例
JSON格式
{
"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
},
"QuorumVswId": "vsw-bp1omfzsszekkvaxn****"
}
]
},
"TotalCount": 1,
"RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
"PageSize": 1,
"PageNumber": 1
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Region.NotSupported | The specified Region is not supported for this API now. | 当前地域暂不支持该功能。 |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-17 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-10-08 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-07-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-03-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-26 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-03 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-10-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-04-29 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-07-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |