All Products
Search
Document Center

Elastic High Performance Computing:ListFileSystemWithMountTargets

Last Updated:Apr 09, 2024

Queries file systems and mount targets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListFileSystemWithMountTargetsREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page. Valid values: 1 to 50. Default value: 10.

10
RequestIdstring

The request ID.

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

The page number.

1
TotalCountinteger

The total number of entries.

1
FileSystemListobject []

The list of file systems.

Statusstring

The status of the file system. Valid values:

  • Pending: The file system is processing a task.
  • Running: The file system is available.
  • Stopped: The file system is unavailable.
  • Extending: The file system is being scaled out.
  • Stopping: The file system is being stopped.
  • Deleting: The file system is being deleted.
Running
Capacityinteger

The capacity of the file system. Unit: GiB

5120
CreateTimestring

The time when the file system was created.

2018-07-26 16:36:27
StorageTypestring

The storage type of the file system.

  • Valid values if FileSystemType is set to standard: Capacity and Performance.
  • Valid values if FileSystemType is set to extreme: standard and advance.
Performance
BandWidthinteger

The bandwidth of the file system. Unit: MB/s.

150
RegionIdstring

The region ID.

cn-hangzhou
FileSystemIdstring

The ID of the file system.

088b****
FileSystemTypestring

The type of the file system.

  • Valid values: standard (General-purpose NAS file systems) and extreme (Extreme NAS file systems).
standard
MeteredSizeinteger

The used capacity of the NAS file system. Unit: bytes.

1216816455
EncryptTypeinteger

Indicates whether data in the file system is encrypted.

You can use keys that are hosted by Key Management Service (KMS) to encrypt the data in a file system. When you read and write the encrypted data, the data is automatically decrypted.

Valid values:

  • 0 (default): does not encrypt the data in the file system.
  • 1: encrypts data in the file system by using a NAS-managed key. This parameter is valid only if the FileSystemType parameter is set to standard or extreme.
  • 2: A KMS-managed key is used to encrypt the data in the file system. This parameter is valid only if the FileSystemType parameter is set to extreme.
0
ProtocolTypestring

The protocol type of the file system. Valid values:

  • NFS-SMB
NFS
Destriptionstring

The description of the file system.

FilesDescription
PackageListobject []

The list of storage plans.

PackageIdstring

The ID of the storage plan.

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

The list of mount targets.

Statusstring

The state of the mount target. Valid values:

  • Active: The mount target is available.
  • Inactive: The mount target is unavailable.
  • Pending: The mount target is pending to be used.
  • Deleting: The mount target is being deleted.
Active
VpcIdstring

The ID of the VPC.

vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomainstring

The domain in which the mount target resides.

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

Specifies whether to use the user default permission group.

Valid values:

  • true: uses the default permission group. If the permission group is the default one, all IP addresses are allowed to access the permission group, and users cannot delete the group and its rules.
  • false: does not use the default permission group.
DEFAULT_VPC_GROUP_NAME
VswIdstring

The ID of the vSwitch.

vsw-8vb34rtyh6xb3zrehs1****
NetworkTypestring

The network type. Valid values:

  • vpc
  • classic
vpc
VpcIdstring

The ID of the VPC.

vpc-bp132kgui8n0targbn1cm

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
406NasErrorNAS API request failed.Failed to request the NAS interface.
406DbErrorA database service error occurred.Database request failed.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
407EntityNotExist.RoleThe role does not exist.The role does not exist.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-06-24The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 407 change
    delete Error Codes: 406
    delete Error Codes: 500
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.