使用DescribeFileSystems查询文件系统信息-文件存储NAS-阿里云

查询文件系统信息。

调试

您可以在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。通用型 NAS：31a8e4**。极速型 NAS：必须以 extreme-开头，例如 extreme-0015。 CPFS：必须以 cpfs-开头，例如 cpfs-125487**。说明仅中国站支持 cpfs 文件系统。	31a8e4****
FileSystemType	string	否	文件系统类型。取值： all（默认值）：同时查询所有类型。 standard：通用型 NAS。 extreme：极速型 NAS。 cpfs：CPFS。说明仅中国站支持 CPFS 文件系统。如果查询多个类型，使用英文逗号隔开。	standard
VpcId	string	否	专有网络 ID。必须与待挂载的云服务器 ECS 选择相同的 VPC 网络。	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	否	分页查询时，每个分页包含的文件系统个数。取值范围：1~100。默认值：10。	1
PageNumber	integer	否	文件系统列表的分页页码。起始值（默认值）：1。	1
Tag	array<object>	否	标签信息集合。
	object	否	标签信息集合。
Key	string	否	标签键。限制： N 的取值范围为 1~20。最多支持 128 个字符。不能以`aliyun`或`acs:`开头。不能包含`http://`和`https://`。	testKey
Value	string	否	标签值。限制： N 的取值范围为 1~20。最多支持 128 个字符。不能以`aliyun`或`acs:`开头。不能包含`http://`和`https://`。	testValue
ResourceGroupId	string	否	资源组 ID。您可以通过资源管理控制台查看资源组 ID。	rg-acfmwavnfef****

返回参数

名称	类型	描述	示例值
	object
FileSystems	array<object>	文件系统列表。
FileSystem	object
Status	string	文件系统状态。包括： Pending：当前文件系统正在处理任务中。 Running：当前文件系统可用，当状态为 Running 时才可以进行后续操作（例如：创建挂载点等）。 Stopped：当前文件系统不可用。 Extending：当前文件系统扩容中。 Stopping：当前文件系统停机中。 Deleting：当前文件系统删除中。	Pending
MeteredIASize	long	低频存储用量。单位：Byte。	362832
Capacity	long	文件系统的容量。单位：GiB。	100
CreateTime	string	文件系统的创建时间。	2020-01-05T16:00:00Z
ChargeType	string	计费类型。包括： Subscription：包年包月。 PayAsYouGo：按量付费。 Package：已绑定存储包。	PayAsYouGo
Tags	array<object>	文件系统标签信息集合。
Tag	object
Key	string	标签键。	testKey
Value	string	标签值。	testValue
StorageType	string	存储类型。包括：通用型 NAS：Capacity（容量型）、Performance（性能型）、Premium（高级型）极速型 NAS：standard（标准型）、advance（高级型） CPFS：advance_100（100 MB/s/TiB 基线）、advance_200（200 MB/s/TiB 基线）说明仅中国站支持 CPFS 文件系统。	Performance
MeteredSize	long	文件系统的标准存储使用量。非实时使用量，为上一小时最大使用量，单位：Byte。说明如果您需要查看文件系统总存储容量，请参见查询文件系统资源使用量。	1611661312
Description	string	文件系统的描述信息。	test
Bandwidth	long	文件系统的带宽。单位：MB/s。通用型 NAS 没有该字段。	150
SupportedFeatures	array	文件系统支持的功能集合。
SupportedFeature	string	文件系统支持的功能。包括： Lifecycle：生命周期管理。 ACL：访问控制列表。 Ipv6：IPv6 功能。说明当前仅极速型 NAS 中国内地各地域支持 IPv6 功能。	Lifecycle
Version	string	文件系统版本号。该字段适用于极速型 NAS 和 CPFS。	2.3.4
ProtocolType	string	文件系统协议类型。包括： NFS：NFS 文件协议。 SMB：SMB 文件协议。 cpfs：CPFS 文件系统支持的协议类型。说明仅中国站支持 CPFS 文件系统。	NFS
MountTargets	array<object>	挂载点信息集合。
MountTarget	object
VpcId	string	专有网络 ID。	vpc-bp1sevsgtqvk5gxbl****
Status	string	挂载点状态。包括： Active：可用。 Inactive：不可用。 Pending：任务处理中。 Deleting：删除中。 Hibernating：休眠中。 Hibernated：已休眠。	Active
ClientMasterNodes	array<object>	客户端管理节点信息集合。仅 CPFS 文件系统返回该参数。
ClientMasterNode	object
EcsId	string	管理节点 ECS 实例 ID。	i-hp3i3odi5ory1buo****
DefaultPasswd	string	管理节点默认登录密码。	123456
EcsIp	string	管理节点 ECS 实例 IP。	192.168.1.0
MountTargetDomain	string	挂载点。	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	挂载点使用的权限组名称。	test-001
DualStackMountTargetDomain	string	IPv4 和 IPv6 双栈挂载点。说明仅极速型 NAS 中国内地各地域支持 IPv6 功能。	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	交换机 ID。	vsw-bp1omfzsszekkvaxn****
Tags	array<object>	挂载点标签信息集合。
Tag	object
Key	string	标签键。	testKey
Value	string	标签值。	testValue
NetworkType	string	网络类型。取值为 vpc，表示专有网络类型。	vpc
KMSKeyId	string	KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	自动快照策略 ID。	sp-extreme-09npwxadu1eqvw****
RegionId	string	地域 ID。	cn-hangzhou
FileSystemType	string	文件系统类型。包括： standard：通用型 NAS。 extreme：极速型 NAS。 cpfs：CPFS。说明仅中国站支持 CPFS 文件系统。	standard
FileSystemId	string	文件系统 ID。	109c04****
EncryptType	integer	加密类型。包括： 0：不加密。 1：NAS 托管密钥。 2：用户管理密钥。	1
Ldap	object	LDAP 配置信息集合。仅 CPFS 文件系统返回该参数。
BindDN	string	绑定 LDAP 的指定条目。	cn=alibaba,dc=com
SearchBase	string	LDAP 搜索起始点。	dc=example
URI	string	LDAP 服务地址。	ldap://ldap.example.example
ExpiredTime	string	文件系统到期时间。	2020-01-05T16:00:00Z
ZoneId	string	文件系统所在的可用区。	cn-hangzhou-b
VpcId	string	专有网络 ID。	vpc-bp1sevsgtqvk5gxbl****
VswIds	array	交换机信息集合。
VswId	string	交换机 ID。	vsw-bp1omfzsszekkvaxn****
Packages	array<object>	存储包信息集合。
Package	object
StartTime	string	存储包起始时间。	2019-12-05T01:40:56Z
ExpiredTime	string	存储包到期时间。	2020-01-05T16:00:00Z
Size	long	存储包容量。单位：Byte。	107374182400
PackageId	string	存储包 ID。	naspackage-0be9c4b624-37****
PackageType	string	存储包类型。包括： ssd：性能型。 hybrid：容量型。	hybrid
AccessPointCount	string	接入点数量。	1
ResourceGroupId	string	资源组 ID	rg-acfmwavnfef****
MeteredArchiveSize	long	归档存储用量。单位：Byte。	1611661312
Options	object	选项。
EnableOplock	boolean	是否开启 OpLock 功能。取值： true：开启。 false：不开启。说明仅支持 SMB 协议类型的文件系统。	true
QuorumVswId	string	交换机 ID。	vsw-bp1omfzsszekkvaxn****
VscTarget	string	说明该参数暂未开放使用。	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
TotalCount	integer	文件系统的总个数。	1
RequestId	string	请求 ID。	035B3A3A-E514-4B41-B906-5D906CFB****
PageSize	integer	每个分页包含的文件系统个数。	1
PageNumber	integer	文件系统列表的分页页码。	1

示例

正常返回示例

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****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com"
      }
    ]
  },
  "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 返回结构发生变更	查看变更详情