ListCpfsFileSystems - Elastic High Performance Computing

Queries the information about Cloud Paralleled File System (CPFS) and its 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:ListCpfsFileSystems	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	No	The ID of the file system. By default, the information about all CPFSs and their mount targets within your account are queried.	096751****
PageNumber	integer	No	The page number of the page to return. Pages start from page 1. Default value: 1.	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 on the current page.	10
RequestId	string	The ID of the request.	2B900AFE-C938-4551-86E9-97E231BBC876
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of returned entries.	10
FileSystemList	object []	The list of file systems.
FileSystemId	string	The ID of the file system.	096751****
Capacity	string	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
ZoneId	string	The zone ID.	cn-hangzhou-b
ProtocolType	string	The protocol type that is applied to the mounted file system. Valid values: NFS SMB	NFS
Destription	string	The description of the file system.	FilsDestription
RegionId	string	The region ID.	cn-hangzhou
MountTargetList	object []	The mount targets.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-8vbvb34rtyh6xb3zrehs1****
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 mounted. Deleting: The mount target is being deleted.	Active
VswId	string	The vSwitch ID of the instance.	vsw-8vb34rtyh6xb3zrehs1****
NetworkType	string	The network type.	VPC
MountTargetDomain	string	The domain where the mount target resides.	c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "2B900AFE-C938-4551-86E9-97E231BBC876",
  "PageNumber": 1,
  "TotalCount": 10,
  "FileSystemList": {
    "FileSystems": [
      {
        "FileSystemId": "096751****",
        "Capacity": "5120",
        "CreateTime": "2018-07-26 16:36:27",
        "ZoneId": "cn-hangzhou-b",
        "ProtocolType": "NFS",
        "Destription": "FilsDestription",
        "RegionId": "cn-hangzhou",
        "MountTargetList": {
          "MountTargets": [
            {
              "VpcId": "vpc-8vbvb34rtyh6xb3zrehs1****",
              "Status": "Active",
              "VswId": "vsw-8vb34rtyh6xb3zrehs1****",
              "NetworkType": "VPC",
              "MountTargetDomain": "c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
406	NasError		Failed to request the NAS interface.
406	DbError		Database request failed.
407	NotAuthorized		The request is not authorized by RAM.
500	UnknownError		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.