文档

ListFileSystemWithMountTargets - 查询文件系统和挂载点

调用ListFileSystemWithMountTargets查询文件系统和挂载点。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListFileSystemWithMountTargetsRead
  • 全部资源
    *

请求参数

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

分页查询的页码。

1
PageSizeinteger

每页显示的行数。取值范围:1~50 默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时设置的每页行数。 取值范围:1~50。 默认值:10。

10
RequestIdstring

请求 ID

25638B77-2F19-5DC5-B578-7790CE92052B
PageNumberinteger

分页查询的页码。

1
TotalCountinteger

显示列表条目总数。

1
FileSystemListobject []

文件系统列表。

Statusstring

文件系统状态。可能值:

  • Pending:当前文件系统正在处理任务中。
  • Running:当前文件系统可用。
  • Stopped:当前文件系统不可用。
  • Extending:当前文件系统扩容中。
  • Stopping:当前文件系统停机中。
  • Deleting:当前文件系统删除中。
Running
Capacityinteger

文件系统的容量。单位:GiB

5120
CreateTimestring

文件系统创建时间。

2018-07-26 16:36:27
StorageTypestring

存储规格类型。

  • 当 FileSystemType 为 standard 时,可能值:Capacity(容量型)、Performance(性能型)

  • 当 FileSystemType 为 extreme 时,可能值:standard(标准型)、advance(高级型)

  • 当 FileSystemType 为 CPFS 时,可能值:advance_100(100MB/s/TiB 基线)、advance_200(200MB/s/TiB 基线)

Performance
BandWidthinteger

文件系统的带宽。单位:MB/s

150
RegionIdstring

地域 ID。

cn-hangzhou
FileSystemIdstring

文件系统 ID。

088b****
FileSystemTypestring

文件系统类型,可能值:

  • standard:通用型 NAS

  • extreme:极速型 NAS

  • cpfs:CPFS

standard
MeteredSizeinteger

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

1216816455
EncryptTypeinteger

文件系统是否加密。

使用 KMS 服务托管密钥,对文件系统落盘数据进行加密存储。在读写加密数据时,无需解密。

取值:

  • 0(默认值):不加密。
  • 1:NAS 托管密钥。当 FileSystemType=standard 或 extreme 时,支持 NAS 托管密钥。
  • 2:用户管理密钥。仅当 FileSystemType=extreme 时,支持用户管理密钥。
0
ProtocolTypestring

文件系统的协议类型。可能值:

  • NFS- SMB

  • CPFS

NFS
Destriptionstring

文件系统描述。

FilesDescription
PackageListobject []

存储包信息列表。

PackageIdstring

存储包 ID。

naspackage-0be9c4b624-37****
MountTargetListobject []

挂载点列表。

Statusstring

挂载点状态。可能值:

  • Active:可用
  • Inactive:不可用
  • Pending:任务排队中
  • Deleting:删除中
Active
VpcIdstring

专有网络 ID。

vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomainstring

挂载目标域。

088b****-lj2.cn-hangzhou.nas.aliyuncs.com
AccessGroupstring

权限组是否为用户的默认权限组。

包括:

  • true:该权限组为默认权限组。当该权限组为默认权限组时,允许所有 IP 地址访问,且用户无法删除默认权限组及权限组内的权限规则。
  • false:该权限组不是默认权限组。
DEFAULT_VPC_GROUP_NAME
VswIdstring

交换机 ID。

vsw-8vb34rtyh6xb3zrehs1****
NetworkTypestring

网络类型。可能值:

  • vpc:专有网络
  • classic:经典网络
vpc
VpcIdstring

专有网络 ID。

vpc-bp132kgui8n0targbn1cm

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "25638B77-2F19-5DC5-B578-7790CE92052B",
  "PageNumber": 1,
  "TotalCount": 1,
  "FileSystemList": {
    "FileSystems": [
      {
        "Status": "Running",
        "Capacity": 5120,
        "CreateTime": "2018-07-26 16:36:27",
        "StorageType": "Performance",
        "BandWidth": 150,
        "RegionId": "cn-hangzhou",
        "FileSystemId": "088b****",
        "FileSystemType": "standard",
        "MeteredSize": 1216816455,
        "EncryptType": 0,
        "ProtocolType": "NFS",
        "Destription": "FilesDescription",
        "PackageList": {
          "Packages": [
            {
              "PackageId": "naspackage-0be9c4b624-37****"
            }
          ]
        },
        "MountTargetList": {
          "MountTargets": [
            {
              "Status": "Active",
              "VpcId": "vpc-8vbvb34rtyh6xb3zrehs1****",
              "MountTargetDomain": "088b****-lj2.cn-hangzhou.nas.aliyuncs.com",
              "AccessGroup": "DEFAULT_VPC_GROUP_NAME",
              "VswId": "vsw-8vb34rtyh6xb3zrehs1****",
              "NetworkType": "vpc"
            }
          ]
        },
        "VpcId": "vpc-bp132kgui8n0targbn1cm"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
406NasErrorNAS API request failed.NAS接口请求失败
406DbErrorA database service error occurred.数据库请求失败
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
407EntityNotExist.RoleThe role does not exist.当前角色不存在
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2022-06-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 407 变更
    删除错误码:406
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈