调用DescribeFileSystems查询文件系统信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeFileSystems |
系统规定参数。取值:DescribeFileSystems。 |
FileSystemId | String | 否 | 109c04**** |
文件系统ID。 |
FileSystemType | String | 否 | standard |
文件系统类型。取值包括:
|
VpcId | String | 否 | vpc-bp1sevsgtqvk5gxbl**** |
专有网络ID。必须与待挂载的云服务器ECS选择相同的VPC网络。 |
PageSize | Integer | 否 | 1 |
分页查询时,每个分页包含的文件系统个数。取值范围:1~100个,默认值为:10个。 |
PageNumber | Integer | 否 | 1 |
文件系统列表的分页页码。默认值:1。 |
Tag.N.Key | String | 否 | 无 |
标签键。限制如下:
|
Tag.N.Value | String | 否 | 无 |
标签值。限制如下:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
文件系统列表的分页页码。 |
PageSize | Integer | 1 |
每个分页包含的文件系统个数。 |
RequestId | String | 035B3A3A-E514-4B41-B906-5D906CFBD65F |
请求ID。 |
TotalCount | Integer | 1 |
文件系统的总个数。 |
FileSystems | Array of FileSystem |
文件系统的描述信息。 |
|
FileSystem | |||
Bandwidth | Long | 150 |
文件系统的带宽。单位为MB/s,通用型NAS没有该字段。 |
Capacity | Long | 1 |
文件系统的容量。单位为GiB。 |
ChargeType | String | PayAsYouGo |
计费类型。包括如下类型:
|
CreateTime | String | 2017-05-27T15:43:06CST |
文件系统的创建时间。 |
Description | String | 31a8e48eda |
文件系统的描述信息。 |
EncryptType | Integer | 1 |
加密类型。包括如下类型:
|
ExpiredTime | String | 2017-08-27T15:43:06CST |
文件系统到期时间。 |
FileSystemId | String | 109c04**** |
文件系统ID。 |
FileSystemType | String | all |
文件系统类型。包括如下类型:
|
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 |
网络类型。
|
Status | String | active |
挂载点状态。
|
Tags | Array of Tag |
标签信息。 |
|
Tag | |||
Key | String | 无 |
标签键。 |
Value | String | 无 |
标签值。 |
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 |
存储包类型。
|
Size | Long | 107374182400 |
存储包容量。 |
StartTime | String | 2019-12-05T01:40:56Z |
存储包起始时间。 |
ProtocolType | String | NFS |
文件系统协议类型。取值包括:NFS、SMB和cpfs。 |
RegionId | String | cn-hangzhou |
地域ID。 |
Status | String | Pending |
文件系统状态,极速型NAS和CPFS返回该字段。状态如下:
|
StorageType | String | Performance |
存储类型。包括如下类型:
|
SupportedFeatures | List | Lifecycle |
文件系统支持的功能。包括如下功能:
说明 当前仅华北5(呼和浩特)地域的极速型NAS支持IPv6功能。
|
Tags | Array of Tag |
标签信息。 |
|
Tag | |||
Key | String | 无 |
标签键。 |
Value | String | 无 |
标签值。 |
Version | String | 1 |
文件系统版本号。该字段仅适用于极速型NAS。 |
ZoneId | String | cn-hangzhou-b |
文件系统所在的可用区。 |
示例
请求示例
https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeFileSystems
&FileSystemId=109c04****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeFileSystemsResponse>
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<PageSize>1</PageSize>
<RequestId>035B3A3A-E514-4B41-B906-5D906CFBD65F</RequestId>
<FileSystems>
<FileSystem>
<FileSystemId>109c04****</FileSystemId>
<ProtocolType>NFS</ProtocolType>
<RegionId>cn-hangzhou</RegionId>
<CreateTime>2017-05-27T15:43:06CST</CreateTime>
<Destription></Destription>
<MountTargets>
<MountTarget>
<MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
<Status>Active</Status>
<VpcId>i-2ze6whdvutxtvp6*****</VpcId>
<VswId>vsw-2zew2qdk7ghyfxp7*****</VswId>
<NetworkType>vpc</NetworkType>
<ClientMasterNodes>
<ClientMasterNode>
<EcsIp>192.168.1.36</EcsIp>
<EcsId>vpc-2zeolds5v62nux63*****</EcsId>
<DefaultPasswd>PWD-34ff7bbc68B*****</DefaultPasswd>
</ClientMasterNode>
<ClientMasterNode>
<EcsIp>192.168.1.37</EcsIp>
<EcsId>vpc-2zeolds5v62nux63*****</EcsId>
<DefaultPasswd>PWD-34ff7bbc68B*****</DefaultPasswd>
</ClientMasterNode>
<ClientMasterNode>
<EcsIp>192.168.1.35</EcsIp>
<EcsId>vpc-2zeolds5v62nux63*****</EcsId>
<DefaultPasswd>PWD-34ff7bbc68B*****</DefaultPasswd>
</ClientMasterNode>
</ClientMasterNodes>
<Tags>
<Tag>
</Tag>
</Tags>
</MountTarget>
</MountTargets>
<StorageType>Performance</StorageType>
<MeteredSize>1611661312</MeteredSize>
<Status>Running</Status>
<MountTargetCountLimit>1</MountTargetCountLimit>
<AutoSnapshotPolicyId></AutoSnapshotPolicyId>
<EncryptType>0</EncryptType>
<Capacity>4800</Capacity>
<ChargeType>Subscription</ChargeType>
<Packages>
<Package>
</Package>
</Packages>
<ExpiredTime>2020-11-29T16:00:00Z</ExpiredTime>
<FileSystemType>cpfs</FileSystemType>
<Bandwidth>960</Bandwidth>
<Tags>
<Tag>
<Key>1</Key>
<Value>1</Value>
</Tag>
</Tags>
</FileSystem>
</FileSystems>
</DescribeFileSystemsResponse>
JSON
格式
{
"DescribeFileSystemsResponse": {
"PageNumber": 1,
"TotalCount": 1,
"PageSize": 1,
"RequestId": "035B3A3A-E514-4B41-B906-5D906CFBD65F",
"FileSystems": {
"FileSystem": {
"FileSystemId": "109c04****",
"ProtocolType": "NFS",
"RegionId": "cn-hangzhou",
"CreateTime": "2017-05-27T15:43:06CST",
"Destription": "",
"MountTargets": {
"MountTarget": {
"MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
"Status": "Active",
"VpcId": "i-2ze6whdvutxtvp6*****",
"VswId": "vsw-2zew2qdk7ghyfxp7*****",
"NetworkType": "vpc",
"ClientMasterNodes": {
"ClientMasterNode": [
{
"EcsIp": "192.168.1.36",
"EcsId": "vpc-2zeolds5v62nux63*****",
"DefaultPasswd": "PWD-34ff7bbc68B*****"
},
{
"EcsIp": "192.168.1.37",
"EcsId": "vpc-2zeolds5v62nux63*****",
"DefaultPasswd": "PWD-34ff7bbc68B*****"
},
{
"EcsIp": "192.168.1.35",
"EcsId": "vpc-2zeolds5v62nux63*****",
"DefaultPasswd": "PWD-34ff7bbc68B*****"
}
]
},
"Tags": {
"Tag": ""
}
}
},
"StorageType": "Performance",
"MeteredSize": 1611661312,
"Status": "Running",
"MountTargetCountLimit": 1,
"AutoSnapshotPolicyId": "",
"EncryptType": 0,
"Capacity": 4800,
"ChargeType": "Subscription",
"Packages": {
"Package": ""
},
"ExpiredTime": "2020-11-29T16:00:00Z",
"FileSystemType": "cpfs",
"Bandwidth": 960,
"Tags": {
"Tag": {
"Key": 1,
"Value": 1
}
}
}
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
访问错误中心查看更多错误码。