调用DescribeFileSystems查询文件系统信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFileSystems

接口名称。

固定取值:DescribeFileSystems。

FileSystemId String 109c04****

文件系统ID。

FileSystemType String standard

文件系统类型。

取值:

  • all(默认值):所有类型
  • standard:通用型NAS
  • extreme:极速型NAS
  • cpfs:CPFS
VpcId String vpc-bp1sevsgtqvk5gxbl****

专有网络ID。

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

PageSize Integer 1

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

取值范围:1~100

默认值:10

PageNumber Integer 1

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

起始值(默认值):1。

Tag.N.Key String

标签键。

限制:

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

标签值。

限制:

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

返回数据

名称 类型 示例值 描述
FileSystems Array of FileSystem

文件系统信息集合。

FileSystem
Status String Pending

文件系统状态。包括:

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

低频介质存储用量。

单位:Byte。

Capacity Long 1

文件系统的容量。

单位:GiB。

CreateTime String 2017-05-27T15:43:06CST

文件系统的创建时间。

ChargeType String PayAsYouGo

计费类型。

包括:

  • Subscription:包年包月
  • PayAsYouGo:按量付费
  • Package:已绑定存储包
Tags Array of Tag

文件系统标签信息集合。

Tag
Key String sdf

标签键。

Value String asd123

标签值。

StorageType String Performance

存储类型。

包括:

  • 通用型NAS:Capacity(容量型)、Performance(性能型)
  • 极速型NAS:standard(标准型)、advance(高级型)

  • CPFS:advance_100(100 MB/s/TiB基线)、advance_200(200 MB/s/TiB基线)
MeteredSize Long 1611661312

文件系统的使用量。

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

Description String 31a8e48eda

文件系统的描述信息。

Bandwidth Long 150

文件系统的带宽。

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

SupportedFeatures Array of String Lifecycle

文件系统支持的功能。

包括:

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

文件系统版本号。

该字段仅适用于极速型NAS。

ProtocolType String NFS

文件系统协议类型。

包括:

  • NFS:NFS文件协议
  • SMB:SMB文件协议
  • cpfs:CPFS文件系统支持的协议类型
MountTargets Array of MountTarget

挂载点信息集合。

MountTarget
VpcId String vpc-bp1sevsgtqvk5gxbl****

专有网络ID。

Status String active

挂载点状态。

包括:

  • Active:可用
  • Inactive:不可用
  • Pending:任务处理中
  • Deleting:删除中
ClientMasterNodes Array of ClientMasterNode

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

ClientMasterNode
EcsId String i-hp3i3odi5ory1buo****

管理节点ECS实例ID。

DefaultPasswd String 123456

管理节点默认登录密码。

EcsIp String 192.168.1.0

管理节点ECS实例IP。

MountTargetDomain String 109c042666-w****.cn-hangzhou.nas.aliyuncs.com

挂载点。

AccessGroupName String test-001

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

DualStackMountTargetDomain String 174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com

IPv4和IPv6双栈挂载点。

说明 当前仅极速型NAS中国内地各地域支持IPv6功能。
VswId String vsw-bp1omfzsszekkvaxn****

交换机ID。

Tags Array of Tag

挂载点标签信息集合。

Tag
Key String adasfsdfd

标签键。

Value String afsa

标签值。

NetworkType String vpc

网络类型。

包括:

  • vpc:专有网络
  • classic:经典网络
KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

KMS密钥ID。

RegionId String cn-hangzhou

地域ID。

FileSystemType String standard

文件系统类型。

包括:

  • standard:通用型NAS
  • extreme:极速型NAS
  • cpfs:CPFS
FileSystemId String 109c04****

文件系统ID。

EncryptType Integer 1

加密类型。

包括:

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

LDAP配置信息集合。

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

BindDN String cn=alibaba,dc=com

绑定LDAP的指定条目。

SearchBase String dc=example

LDAP搜索起始点。

URI String ldap://ldap.example.example

LDAP服务地址。

ExpiredTime String 2017-08-27T15:43:06CST

文件系统到期时间。

ZoneId String cn-hangzhou-b

文件系统所在的可用区。

Packages Array of Package

存储包信息集合。

Package
StartTime String 2019-12-05T01:40:56Z

存储包起始时间。

ExpiredTime String 2020-01-05T16:00:00Z

存储包到期时间。

Size Long 107374182400

存储包容量。

单位:Byte。

PackageId String naspackage-0be9c4b624-37****

存储包ID。

PackageType String hybrid

存储包类型。

包括:

  • ssd:性能型
  • hybrid:容量型
TotalCount Integer 1

文件系统的总个数。

RequestId String 035B3A3A-E514-4B41-B906-5D906CFB****

请求ID。

PageSize Integer 1

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

PageNumber Integer 1

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFileSystems
&FileSystemId=109c04****
&FileSystemType=standard
&VpcId=vpc-bp1sevsgtqvk5gxbl****
&PageSize=1
&PageNumber=1
&Tag=[{"Key":"无","Value":"无"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFileSystemsResponse>
    <FileSystems>
        <FileSystem>
            <Status>Pending</Status>
            <MeteredIASize>362832</MeteredIASize>
            <Capacity>1</Capacity>
            <CreateTime>2017-05-27T15:43:06CST</CreateTime>
            <ChargeType>PayAsYouGo</ChargeType>
            <Tags>
                <Tag>
                    <Key>sdf</Key>
                    <Value>asd123</Value>
                </Tag>
            </Tags>
            <StorageType>Performance</StorageType>
            <MeteredSize>1611661312</MeteredSize>
            <Description>31a8e48eda</Description>
            <Bandwidth>150</Bandwidth>
            <SupportedFeatures>Lifecycle</SupportedFeatures>
            <Version>1</Version>
            <ProtocolType>NFS</ProtocolType>
            <MountTargets>
                <MountTarget>
                    <VpcId>vpc-bp1sevsgtqvk5gxbl****</VpcId>
                    <Status>active</Status>
                    <ClientMasterNodes>
                        <ClientMasterNode>
                            <EcsId>i-hp3i3odi5ory1buo****</EcsId>
                            <DefaultPasswd>123456</DefaultPasswd>
                            <EcsIp>192.168.1.0</EcsIp>
                        </ClientMasterNode>
                    </ClientMasterNodes>
                    <MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
                    <AccessGroupName>test-001</AccessGroupName>
                    <DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>
                    <VswId>vsw-bp1omfzsszekkvaxn****</VswId>
                    <Tags>
                        <Tag>
                            <Key>adasfsdfd</Key>
                            <Value>afsa</Value>
                        </Tag>
                    </Tags>
                    <NetworkType>vpc</NetworkType>
                </MountTarget>
            </MountTargets>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
            <RegionId>cn-hangzhou</RegionId>
            <FileSystemType>all</FileSystemType>
            <FileSystemId>109c04****</FileSystemId>
            <EncryptType>1</EncryptType>
            <Ldap>
                <BindDN>cn=alibaba,dc=com</BindDN>
                <SearchBase>dc=example</SearchBase>
                <URI>ldap://ldap.example.example</URI>
            </Ldap>
            <ExpiredTime>2017-08-27T15:43:06CST</ExpiredTime>
            <ZoneId>cn-hangzhou-b</ZoneId>
            <Packages>
                <Package>
                    <StartTime>2019-12-05T01:40:56Z</StartTime>
                    <ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>
                    <Size>107374182400</Size>
                    <PackageId>naspackage-0be9c4b624-37****</PackageId>
                    <PackageType>hybrid</PackageType>
                </Package>
            </Packages>
        </FileSystem>
    </FileSystems>
    <TotalCount>1</TotalCount>
    <RequestId>035B3A3A-E514-4B41-B906-5D906CFB****</RequestId>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
</DescribeFileSystemsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "FileSystems" : {
    "FileSystem" : [ {
      "Status" : "Pending",
      "MeteredIASize" : 362832,
      "Capacity" : 1,
      "CreateTime" : "2017-05-27T15:43:06CST",
      "ChargeType" : "PayAsYouGo",
      "Tags" : {
        "Tag" : [ {
          "Key" : "sdf",
          "Value" : "asd123"
        } ]
      },
      "StorageType" : "Performance",
      "MeteredSize" : 1611661312,
      "Description" : "31a8e48eda",
      "Bandwidth" : 150,
      "SupportedFeatures" : [ "Lifecycle" ],
      "Version" : "1",
      "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" : "all",
      "FileSystemId" : "109c04****",
      "EncryptType" : 1,
      "Ldap" : {
        "BindDN" : "cn=alibaba,dc=com",
        "SearchBase" : "dc=example",
        "URI" : "ldap://ldap.example.example"
      },
      "ExpiredTime" : "2017-08-27T15:43:06CST",
      "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"
        } ]
      }
    } ]
  },
  "TotalCount" : 1,
  "RequestId" : "035B3A3A-E514-4B41-B906-5D906CFB****",
  "PageSize" : 1,
  "PageNumber" : 1
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。

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