Use ListFileSystemWithMountTargets to query file systems and mount targets - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries file systems and mount targets by calling ListFileSystemWithMountTargets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListFileSystemWithMountTargets

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number for the paging query.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page in the paging query. Settings: 1 to 50. Default value: 10.	10
RequestId	string	The request ID.	25638B77-2F19-5DC5-B578-7790CE92052B
PageNumber	integer	The page number of the paging query.	1
TotalCount	integer	The total number of entries in the list.	1
FileSystemList	object
FileSystems	array<object>	The file system list.
	array<object>	The file system list.
Status	string	The file system status. 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
Capacity	integer	The capacity of the file system. Unit: GiB.	5120
CreateTime	string	The time when the file system was created. The time is in the YYYY-MM-DD HH:mm:ss format.	2018-07-26 16:36:27
StorageType	string	The storage specification type. If FileSystemType is set to standard, valid values: Capacity and Performance. If FileSystemType is set to extreme, valid values: standard and advance.	Performance
BandWidth	integer	The bandwidth of the file system. Unit: MB/s.	150
RegionId	string	The region ID.	cn-hangzhou
FileSystemId	string	The file system ID.	088b****
FileSystemType	string	The file system type. Valid values: standard: General-purpose NAS extreme: Extreme NAS	standard
MeteredSize	integer	The used capacity of the NAS file system. Unit: bytes.	1216816455
EncryptType	integer	Indicates whether the file system is encrypted. A key hosted by Key Management Service (KMS) is used to encrypt data stored on the file system. Encrypted data does not need to be decrypted during read and write operations. Valid values: 0 (default): Not encrypted. 1: NAS-managed key. This value is supported when FileSystemType is set to standard or extreme. 2: User-managed key. This value is supported only when 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
Packages	array<object>	The storage plan information list.
	object	The storage plan information list.
PackageId	string	The storage plan ID.	naspackage-0be9c4b624-37****
MountTargetList	object
MountTargets	array<object>	The mount target list.
	object	The mount target list.
Status	string	The mount target status. Valid values: Active: Available. Inactive: Unavailable. Pending: The task is queued. Deleting: The mount target is being deleted.	Active
VpcId	string	The VPC ID.	vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomain	string	The mount target domain.	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. When the permission group is the default permission group, all IP addresses are allowed to access the file system, and you cannot delete the default permission group or the permission rules in the 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: VPC classic: classic network	vpc
VpcId	string	The VPC ID.	vpc-bp132kgui8n0targbn1cm

Examples

Success response

JSON format

{
  "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
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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.