文档

DescribeNASFileSystems - 查询NAS文件系统信息

更新时间:

查询NAS文件系统信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 ID。

cn-hangzhou
OfficeSiteIdstring

工作区 ID。

cn-hangzhou+dir-363353****
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

caeba0bbb2be03f84eb48b699f0a4883
FileSystemIdarray

NAS 文件系统 ID。

string

NAS 文件系统 ID。

04f314****
MatchCompatibleProfileboolean

是否过滤只支持 UPM 的 NAS 文件系统。

false

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的 Token,NextToken 为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

269BDB16-2CD8-4865-84BD-11C40BC21DB0
FileSystemsobject []

NAS 文件系统信息集合。

Capacitylong

NAS 文件系统总容量,单位为 GiB。

  • 若存储规格为容量型,则容量固定为 10 PiB,即 10485760 GiB。
  • 若存储规格为性能型,则容量固定为 1 PiB,即 1048576 GiB。
10485760
MountTargetStatusstring

挂载点状态。

枚举值:
  • Active已激活
  • Inactive未激活
  • Pending创建中
  • Deleting删除中
  • Invalid已失效
Active
CreateTimestring

NAS 文件系统的创建时间。

2021-05-10T11:39Z
OfficeSiteIdstring

工作区 ID。

cn-hangzhou+dir-363353****
SupportAclboolean

是否支持开启 SMB ACL 功能。

false
StorageTypestring

NAS 文件系统的存储规格。

枚举值:
  • Capacity容量型
  • Performance性能型
Capacity
OfficeSiteNamestring

工作区名称。

test
RegionIdstring

地域 ID。

cn-hangzhou
FileSystemIdstring

NAS 文件系统 ID。

04f314****
FileSystemTypestring

NAS 文件系统的类型,目前仅支持通用型,即standard

standard
FileSystemNamestring

NAS 文件系统名称。

testNAS
MeteredSizelong

NAS 文件系统已使用的容量,单位为 Byte。

0
MountTargetDomainstring

挂载点域名。

04f314****-at***.cn-hangzhou.nas.aliyuncs.com
Descriptionstring

NAS 文件系统描述。

testDescription
ZoneIdstring

可用区。

cn-hangzhou-f
FileSystemStatusstring

NAS 文件系统状态。

枚举值:
  • Stopped已停止
  • Running运行中
  • Deleted已删除
  • Pending创建中
  • Deleting删除中
  • Invalid已失效
Running
EncryptionEnabledboolean

是否开启磁盘加密。

false
ProfileCompatibleboolean

是否支持 UPM(User Profile Management)功能。

false
DesktopGroupsobject []

支持 UPM 的 NAS 绑定的桌面组对象列表。

DesktopGroupIdstring

桌面组 ID。

dg-9eeyf15b25nyl****
DesktopGroupNamestring

桌面组名称。

test_dg

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "FileSystems": [
    {
      "Capacity": 10485760,
      "MountTargetStatus": "Active",
      "CreateTime": "2021-05-10T11:39Z",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "SupportAcl": false,
      "StorageType": "Capacity",
      "OfficeSiteName": "test",
      "RegionId": "cn-hangzhou",
      "FileSystemId": "04f314****",
      "FileSystemType": "standard",
      "FileSystemName": "testNAS",
      "MeteredSize": 0,
      "MountTargetDomain": "04f314****-at***.cn-hangzhou.nas.aliyuncs.com",
      "Description": "testDescription",
      "ZoneId": "cn-hangzhou-f",
      "FileSystemStatus": "Running",
      "EncryptionEnabled": false,
      "ProfileCompatible": false,
      "DesktopGroups": [
        {
          "DesktopGroupId": "dg-9eeyf15b25nyl****",
          "DesktopGroupName": "test_dg"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈