调用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://

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

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

PageSize Integer 1

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

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

请求ID。

TotalCount Integer 1

文件系统的总个数。

FileSystems Array of FileSystem

文件系统信息集合。

FileSystem
Bandwidth Long 150

文件系统的带宽。

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

Capacity Long 1

文件系统的容量。

单位:GiB。

ChargeType String PayAsYouGo

计费类型。

包括:

  • Subscription:包年包月
  • PayAsYouGo:按量付费
  • Package:已绑定存储包
CreateTime String 2017-05-27T15:43:06CST

文件系统的创建时间。

Description String 31a8e48eda

文件系统的描述信息。

EncryptType Integer 1

加密类型。

包括:

  • 0:不加密
  • 1:加密
ExpiredTime String 2017-08-27T15:43:06CST

文件系统到期时间。

FileSystemId String 109c04****

文件系统ID。

FileSystemType String all

文件系统类型。

包括:

  • standard:通用型NAS
  • extreme:极速型NAS
  • cpfs:CPFS
KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

KMS密钥ID。

Ldap Struct

LDAP配置信息集合。

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

BindDN String cn=alibaba,dc=com

绑定LDAP的指定条目。

SearchBase String dc=example

LDAP搜索起始点。

URI String ldap://ldap.example.example

LDAP服务地址。

MeteredIASize Long 362832

低频介质存储用量。

单位:Byte。

MeteredSize Long 1611661312

文件系统的使用量。

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

MountTargets Array of MountTarget

挂载点信息集合。

MountTarget
AccessGroupName String test-001

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

ClientMasterNodes Array of ClientMasterNode

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

ClientMasterNode
DefaultPasswd String 123456

管理节点默认登录密码。

EcsId String i-hp3i3odi5ory1buo****

管理节点ECS实例ID。

EcsIp String 192.168.1.0

管理节点ECS实例IP。

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

IPv4和IPv6双栈挂载点。

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

挂载点。

NetworkType String vpc

网络类型。

包括:

  • vpc:专有网络
  • classic:经典网络
Status String active

挂载点状态。

包括:

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

挂载点标签信息集合。

Tag
Key String adasfsdfd

标签键。

Value String afsa

标签值。

VpcId String vpc-bp1sevsgtqvk5gxbl****

专有网络ID。

VswId String vsw-bp1omfzsszekkvaxn****

交换机ID。

Packages Array of Package

存储包信息集合。

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

存储包到期时间。

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

存储包ID。

PackageType String hybrid

存储包类型。

包括:

  • ssd:性能型
  • hybrid:容量型
Size Long 107374182400

存储包容量。

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

存储包起始时间。

ProtocolType String NFS

文件系统协议类型。

包括:

  • NFS:NFS文件协议
  • SMB:SMB文件协议
  • cpfs:CPFS文件系统支持的协议类型
RegionId String cn-hangzhou

地域ID。

Status String Pending

文件系统状态。

极速型NAS和CPFS返回该字段,包括:

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

存储类型。

包括:

  • 通用型NAS:Capacity(容量型)、Performance(性能型)
  • 极速型NAS:standard(标准型)、advance(高级型)
  • CPFS:advance_100(100 MB/s/TiB基线)、advance_200(200 MB/s/TiB基线)
SupportedFeatures List Lifecycle

文件系统支持的功能。

包括:

  • Lifecycle:生命周期管理。
  • ACL:访问控制列表。
  • Ipv6:IPv6功能。
说明 当前仅华北5(呼和浩特)地域的极速型NAS支持IPv6功能。
Tags Array of Tag

文件系统标签信息集合。

Tag
Key String sdf

标签键。

Value String asd123

标签值。

Version String 1

文件系统版本号。

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

ZoneId String cn-hangzhou-b

文件系统所在的可用区。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFileSystems
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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

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