文档

DescribeFileSystems - 查询文件系统信息

更新时间:

查询文件系统信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:DescribeFileSystemsget
  • FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

名称类型必填描述示例值
FileSystemIdstring

文件系统 ID。

  • 通用型 NAS:31a8e4****。
  • 极速型 NAS:必须以 extreme-开头,例如 extreme-0015****。
  • CPFS:必须以 cpfs-开头,例如 cpfs-125487****。
说明 仅中国站支持 cpfs 文件系统。
31a8e4****
FileSystemTypestring

文件系统类型。

取值:

  • all(默认值):所有类型
  • standard:通用型 NAS
  • extreme:极速型 NAS
  • cpfs:CPFS
说明 仅中国站支持 CPFS 文件系统。
standard
VpcIdstring

专有网络 ID。

必须与待挂载的云服务器 ECS 选择相同的 VPC 网络。

vpc-bp1sevsgtqvk5gxbl****
PageSizeinteger

分页查询时,每个分页包含的文件系统个数。

取值范围:1~100

默认值:10

1
PageNumberinteger

文件系统列表的分页页码。

起始值(默认值):1。

1
Tagarray<object>

标签信息集合。

object
Keystring

标签键。

限制:

  • N 的取值范围为 1~20。
  • 最多支持 128 个字符。
  • 不能以aliyunacs:开头。
  • 不能包含http://https://
Valuestring

标签值。

限制:

  • N 的取值范围为 1~20。
  • 最多支持 128 个字符。
  • 不能以aliyunacs:开头。
  • 不能包含http://https://
ResourceGroupIdstring

资源组 ID

您可以通过资源管理控制台查看资源组 ID。

rg-acfmwavnfef****

返回参数

名称类型描述示例值
object
FileSystemsarray<object>

文件系统信息集合。

FileSystemobject
Statusstring

文件系统状态。包括:

  • Pending:当前文件系统正在处理任务中。
  • Running:当前文件系统可用,当状态为 Running 时才可以进行后续操作(例如:创建挂载点等)。
  • Stopped:当前文件系统不可用。
  • Extending:当前文件系统扩容中。
  • Stopping:当前文件系统停机中。
  • Deleting:当前文件系统删除中。
Pending
MeteredIASizelong

低频存储用量。

单位:Byte。

362832
Capacitylong

文件系统的容量。

单位:GiB。

100
CreateTimestring

文件系统的创建时间。

2020-01-05T16:00:00Z
ChargeTypestring

计费类型。

包括:

  • Subscription:包年包月
  • PayAsYouGo:按量付费
  • Package:已绑定存储包
PayAsYouGo
Tagsarray<object>

文件系统标签信息集合。

Tagobject
Keystring

标签键。

sdf
Valuestring

标签值。

asd123
StorageTypestring

存储类型。

包括:

  • 通用型 NAS:Capacity(容量型)、Performance(性能型)、Premium(高级型)
  • 极速型 NAS:standard(标准型)、advance(高级型)
  • CPFS:advance_100(100 MB/s/TiB 基线)、advance_200(200 MB/s/TiB 基线)
说明 仅中国站支持 CPFS 文件系统。
Performance
MeteredSizelong

文件系统的标准存储使用量。

非实时使用量,为上一小时最大使用量,单位:Byte。

说明 如果您需要查看文件系统总存储容量,请参见查询文件系统资源使用量
1611661312
Descriptionstring

文件系统的描述信息。

test
Bandwidthlong

文件系统的带宽。

单位:MB/s。通用型 NAS 没有该字段。

150
SupportedFeaturesarray

文件系统支持的功能集合。

SupportedFeaturestring

文件系统支持的功能。

包括:

  • Lifecycle:生命周期管理。
  • ACL:访问控制列表。
  • Ipv6:IPv6 功能。
说明 当前仅极速型 NAS 中国内地各地域支持 IPv6 功能。
Lifecycle
Versionstring

文件系统版本号。

该字段适用于极速型 NAS 和 CPFS。

2.3.4
ProtocolTypestring

文件系统协议类型。

包括:

  • NFS:NFS 文件协议
  • SMB:SMB 文件协议
  • cpfs:CPFS 文件系统支持的协议类型。
说明 仅中国站支持 CPFS 文件系统。
NFS
MountTargetsarray<object>

挂载点信息集合。

MountTargetobject
VpcIdstring

专有网络 ID。

vpc-bp1sevsgtqvk5gxbl****
Statusstring

挂载点状态。

包括:

  • Active:可用
  • Inactive:不可用
  • Pending:任务处理中
  • Deleting:删除中
  • Hibernating:休眠中
  • Hibernated:已休眠
Active
ClientMasterNodesarray<object>

客户端管理节点信息集合。

仅 CPFS 文件系统返回该参数。

ClientMasterNodeobject
EcsIdstring

管理节点 ECS 实例 ID。

i-hp3i3odi5ory1buo****
DefaultPasswdstring

管理节点默认登录密码。

123456
EcsIpstring

管理节点 ECS 实例 IP。

192.168.1.0
MountTargetDomainstring

挂载点。

109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupNamestring

挂载点使用的权限组名称。

test-001
DualStackMountTargetDomainstring

IPv4 和 IPv6 双栈挂载点。

说明 仅极速型 NAS 中国内地各地域支持 IPv6 功能。
174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswIdstring

交换机 ID。

vsw-bp1omfzsszekkvaxn****
Tagsarray<object>

挂载点标签信息集合。

Tagobject
Keystring

标签键。

adasfsdfd
Valuestring

标签值。

afsa
NetworkTypestring

网络类型。取值为 vpc,表示专有网络类型。

vpc
KMSKeyIdstring

KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
RegionIdstring

地域 ID。

cn-hangzhou
FileSystemTypestring

文件系统类型。

包括:

  • standard:通用型 NAS
  • extreme:极速型 NAS
  • cpfs:CPFS。
说明 仅中国站支持 CPFS 文件系统。
standard
FileSystemIdstring

文件系统 ID。

109c04****
EncryptTypeinteger

加密类型。

包括:

  • 0:不加密
  • 1:NAS 托管密钥
  • 2:用户管理密钥
1
Ldapobject

LDAP 配置信息集合。

仅 CPFS 文件系统返回该参数。

BindDNstring

绑定 LDAP 的指定条目。

cn=alibaba,dc=com
SearchBasestring

LDAP 搜索起始点。

dc=example
URIstring

LDAP 服务地址。

ldap://ldap.example.example
ExpiredTimestring

文件系统到期时间。

2020-01-05T16:00:00Z
ZoneIdstring

文件系统所在的可用区。

cn-hangzhou-b
Packagesarray<object>

存储包信息集合。

Packageobject
StartTimestring

存储包起始时间。

2019-12-05T01:40:56Z
ExpiredTimestring

存储包到期时间。

2020-01-05T16:00:00Z
Sizelong

存储包容量。 单位:Byte。

107374182400
PackageIdstring

存储包 ID。

naspackage-0be9c4b624-37****
PackageTypestring

存储包类型。

包括:

  • ssd:性能型
  • hybrid:容量型
hybrid
AccessPointCountstring

接入点数量。

1
ResourceGroupIdstring

资源组 ID

rg-acfmwavnfef****
MeteredArchiveSizelong

归档存储用量。

单位:Byte。

1611661312
Optionsobject

选项。

EnableOplockboolean

是否开启 OpLock 功能。 取值:

  • true:开启。
  • false:不开启。
说明 仅支持 SMB 协议类型的文件系统。
true
TotalCountinteger

文件系统的总个数。

1
RequestIdstring

请求 ID。

035B3A3A-E514-4B41-B906-5D906CFB****
PageSizeinteger

每个分页包含的文件系统个数。

1
PageNumberinteger

文件系统列表的分页页码。

1

示例

正常返回示例

JSON格式

{
  "FileSystems": {
    "FileSystem": [
      {
        "Status": "Pending",
        "MeteredIASize": 362832,
        "Capacity": 100,
        "CreateTime": "2020-01-05T16:00:00Z",
        "ChargeType": "PayAsYouGo",
        "Tags": {
          "Tag": [
            {
              "Key": "sdf",
              "Value": "asd123"
            }
          ]
        },
        "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": "adasfsdfd",
                    "Value": "afsa"
                  }
                ]
              },
              "NetworkType": "vpc"
            }
          ]
        },
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "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",
        "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
        }
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "PageSize": 1,
  "PageNumber": 1
}

错误码

HTTP status code错误码错误信息描述
400Region.NotSupportedThe specified Region is not supported for this API now.当前地域暂不支持该功能。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-11-03OpenAPI 错误码发生变更查看变更详情
2023-10-05OpenAPI 错误码发生变更查看变更详情
2023-04-29OpenAPI 错误码发生变更查看变更详情
2022-07-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情