DescribeNASFileSystems - 查询NAS文件系统信息

更新时间:
复制为 MD 格式

查询NAS文件系统信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeNASFileSystems

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou

OfficeSiteId

string

办公网络 ID。

cn-hangzhou+dir-363353****

MaxResults

integer

分页查询时每页行数。

  • 最大值:100。

  • 默认值:10。

10

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883

FileSystemId

array

NAS 文件系统 ID 列表。

04f314****

string

NAS 文件系统 ID。

04f314****

MatchCompatibleProfile

boolean

是否在查询结果中仅包含只支持 UPM 的 NAS 文件系统。

false

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883

RequestId

string

请求 ID。

269BDB16-2CD8-4865-84BD-11C40BC21DB0

FileSystems

array<object>

NAS 文件系统信息集合。

array<object>

NAS 文件系统信息。

Capacity

integer

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

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

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

10485760

MountTargetStatus

string

挂载点状态。

枚举值:

  • Active :

    已激活

  • Inactive :

    未激活

  • Pending :

    创建中

  • Deleting :

    删除中

  • Invalid :

    已失效

Active

CreateTime

string

NAS 文件系统的创建时间。

2021-05-10T11:39Z

OfficeSiteId

string

办公网络 ID。

cn-hangzhou+dir-363353****

SupportAcl

boolean

是否支持开启 SMB ACL 功能。

false

StorageType

string

NAS 文件系统的存储规格。

枚举值:

  • Capacity :

    容量型

  • Performance :

    性能型

Capacity

OfficeSiteName

string

办公网络名称。

test

RegionId

string

地域 ID。

cn-hangzhou

FileSystemId

string

NAS 文件系统 ID。

04f314****

FileSystemType

string

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

枚举值:

  • standard :

    通用型

standard

FileSystemName

string

NAS 文件系统名称。

testNAS

MeteredSize

integer

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

0

MountTargetDomain

string

挂载点域名。

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

Description

string

NAS 文件系统描述。

testDescription

ZoneId

string

可用区。

cn-hangzhou-f

FileSystemStatus

string

NAS 文件系统状态。

枚举值:

  • Stopped :

    已停止

  • Running :

    运行中

  • Deleted :

    已删除

  • Pending :

    创建中

  • Deleting :

    删除中

  • Invalid :

    已失效

Running

EncryptionEnabled

boolean

是否开启磁盘加密。

false

ProfileCompatible

boolean

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

false

DesktopGroups

array<object>

支持 UPM 的 NAS 绑定的共享型云电脑对象列表。

object

共享型云电脑对象信息。

DesktopGroupId

string

共享型云电脑 ID。

dg-9eeyf15b25nyl****

DesktopGroupName

string

共享型云电脑名称。

test_dg

Scene

string

NAS 文件系统的存储方式。

枚举值:

  • Upm :

    UPM NAS

  • ShareNas :

    共享存储 NAS

Upm

AppInstanceGroups

array<object>

支持 UPM 的 NAS 绑定的云应用交付组对象列表。

object

支持 UPM 的 NAS 绑定的云应用交付组对象信息。

AppInstanceGroupId

string

交付组 ID。

aig-0bz55ibznu9p7****

AppInstanceGroupName

string

交付组名称。

DemoDeliveryGroup

AllowOperateUserDrive

boolean

说明

该字段不对外开放使用。

OfficeSites

array<object>

办公网络列表。

object

办公网络。

OfficeSiteId

string

办公网络 ID。

cn-hangzhou+dir-363353****

OfficeSiteName

string

办公网络名称。

DemoOfficeNetwork

示例

正常返回示例

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"
        }
      ],
      "Scene": "Upm",
      "AppInstanceGroups": [
        {
          "AppInstanceGroupId": "aig-0bz55ibznu9p7****",
          "AppInstanceGroupName": "DemoDeliveryGroup"
        }
      ],
      "AllowOperateUserDrive": true,
      "OfficeSites": [
        {
          "OfficeSiteId": "cn-hangzhou+dir-363353****",
          "OfficeSiteName": "DemoOfficeNetwork"
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情