ListFileSystemWithMountTargets - Elastic High Performance Computing

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListFileSystemWithMountTargets	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Valid values: 1 to 50. Default value: 10.	10
RequestId	string	The request ID.	25638B77-2F19-5DC5-B578-7790CE92052B
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	1
FileSystemList	object []	The queried file systems.
Status	string	The status of the file system. Valid values: Pending: The file system is being created or modified. Running: The file system is available. Stopped: The file system is unavailable. Extending: The file system is being scaled up. Stopping: The file system is being disabled. Deleting: The file system is being deleted.	Running
Capacity	integer	The capacity of the file system. Unit: GiB.	5120
CreateTime	string	The time when the file system was created.	2018-07-26 16:36:27
StorageType	string	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
BandWidth	integer	The bandwidth of the file system. Unit: Mbit/s.	150
RegionId	string	The region ID.	cn-hangzhou
FileSystemId	string	The ID of the file system.	088b****
FileSystemType	string	The type of the file system. Valid value: standard: general-purpose network-attached storage (NAS) file systems. extreme: extreme NAS file systems.	standard
MeteredSize	integer	The used capacity of the NAS file system. Unit: bytes.	1216816455
EncryptType	integer	Indicates whether data in the file system is encrypted. You can use keys that are managed 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. Default value: 0. Valid values: 0: The data in the file system is not encrypted. 1: The data in the file system is encrypted by using a NAS-managed key. This parameter is valid if FileSystemType is set to standard or extreme. 2: The data in the file system is encrypted by using a KMS-managed key. This parameter is valid only if FileSystemType is set to extreme.	0
ProtocolType	string	The protocol type of the file system. Valid values: NFS- SMB	NFS
Destription	string	The description of the file system.	FilesDescription
PackageList	object []	The list of storage plans.
PackageId	string	The ID of the storage plan.	naspackage-0be9c4b624-37****
MountTargetList	object []	The list of mount targets.
Status	string	The status of the mount target. Valid values: Active: The mount target is available. Inactive: The mount target is unavailable. Pending: The mount target is being created or modified. Deleting: The mount target is being deleted.	Active
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomain	string	The domain in which the mount target resides.	088b****-lj2.cn-hangzhou.nas.aliyuncs.com
AccessGroup	string	Indicates whether the permission group is the default permission group of the user. Valid values: true: The permission group is the default permission group. In this case, all IP addresses are allowed to access the permission group, and the user cannot delete the permission group and permission rules in the permission group. false: The permission group is not the default permission group.	DEFAULT_VPC_GROUP_NAME
VswId	string	The vSwitch ID.	vsw-8vb34rtyh6xb3zrehs1****
NetworkType	string	The network type. Valid values: vpc classic	vpc
VpcId	string	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 code	Error code	Error message	Description
406	NasError	NAS API request failed.	Failed to request the NAS interface.
406	DbError	A database service error occurred.	Database request failed.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
407	EntityNotExist.Role	The role does not exist.	The role does not exist.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The 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 time

Summary of changes

Operation

2022-06-24

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 407 change
	delete Error Codes: 406
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.