ListAvailableFileSystems - Elastic High Performance Computing

Queries the file systems that can be attached in a region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListAvailableFileSystems	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the page to return. Page starts from page 1. Default value: 1	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**
TotalCount	integer	The total number of entries returned.	65
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
FileSystemList	array<object>	The file systems.
FileSystemLists	object	The information about the file system.
FileSystemId	string	The ID of the file system.	2fa0248***
FileSystemType	string	The type of the file system. Valid values: standard: general-purpose network-attached storage (NAS) file system extreme: extreme NAS file system	cpfs
Status	string	The state of the file system. Valid values: Pending: The file system is processing a task. Running: The file system is available. You can perform subsequent operations, such as creating a mount target, only when the file system is in the Running state. 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
ProtocolType	string	The protocol type of the file system. Valid values: nfs smb cpfs	cpfs
CreateTime	string	The time when the file system was created.	2024-7-29 15:43:53
MountTargetList	array<object>	The mount targets of the file system.
MountTargetList	object	The information about the mount target.
VpcId	string	The virtual private cloud (VPC) ID.	vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomain	string	The address of the mount target.	c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com
Status	string	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 being mounted. Deleting: The mount target is being deleted.	Active
VSwitchId	string	The vSwitch ID.	vsw-2ze0c41hwu7lc29ris***
NetworkType	string	The network type. Valid values: Valid values: vpc	vpc
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
VpcId	string	The VPC ID.	vpc-bp132kgui8n0targb****

Examples

Sample success responses

JSONformat

{
  "RequestId": "BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**",
  "TotalCount": 65,
  "PageSize": 10,
  "PageNumber": 1,
  "FileSystemList": [
    {
      "FileSystemId": "2fa0248***",
      "FileSystemType": "cpfs",
      "Status": "Running",
      "ProtocolType": "cpfs",
      "CreateTime": "2024-7-29 15:43:53",
      "MountTargetList": [
        {
          "VpcId": "vpc-8vbvb34rtyh6xb3zrehs1****",
          "MountTargetDomain": "c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com",
          "Status": "Active",
          "VSwitchId": "vsw-2ze0c41hwu7lc29ris***",
          "NetworkType": "vpc"
        }
      ],
      "StorageType": "Performance",
      "VpcId": "vpc-bp132kgui8n0targb****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	NasError	NAS API request failed.	Failed to request the NAS interface.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
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

No change history