Use ListVolumes to query mounted file systems - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters.

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:ListVolumes

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number 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 elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of returned entries.	1
Volumes	object
VolumeInfo	array<object>	The file systems mounted on E-HPC clusters.
	array<object>
VolumeId	string	The ID of the file system.	bc8a****
ClusterName	string	The instance name.	cluster1
RemoteDirectory	string	The remote directory on which the file system is mounted.	/test1
VolumeMountpoint	string	The domain name of the mount target.	bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com
VolumeType	string	The type of file system mounted on the cluster. Only NAS is supported.	NAS
VolumeProtocol	string	The type of the storage protocol. Valid values: NFS SMB	NFS
RegionId	string	The region ID.	cn-hangzhou
ClusterId	string	The cluster ID.	ehpc-hz-FYUr32****
AdditionalVolumes	object
VolumeInfo	array<object>	The additional file systems mounted on E-HPC clusters.
	object
JobQueue	string	The queue to which the job belongs.	all.q
VolumeId	string	The ID of the file system.	86y3****
RemoteDirectory	string	The remote directory on which the file system is mounted.	/test
VolumeMountpoint	string	The domain name of the mount target.	86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com
Role	string	The type of the node on which the file system is mounted. Valid values: Manager: management node Login: logon node Compute: compute node	Compute
LocalDirectory	string	The local mount directory.	/testopt
VolumeType	string	The type of additional file system. Only NAS is supported.	NAS
Location	string	The location where the cluster is deployed. Valid values: OnPremise: The node is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
VolumeProtocol	string	The type of the storage protocol. Valid values: NFS SMB	NFS

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "TotalCount": 1,
  "Volumes": {
    "VolumeInfo": [
      {
        "VolumeId": "bc8a****",
        "ClusterName": "cluster1",
        "RemoteDirectory": "/test1",
        "VolumeMountpoint": "bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com",
        "VolumeType": "NAS",
        "VolumeProtocol": "NFS",
        "RegionId": "cn-hangzhou",
        "ClusterId": "ehpc-hz-FYUr32****",
        "AdditionalVolumes": {
          "VolumeInfo": [
            {
              "JobQueue": "all.q",
              "VolumeId": "86y3****",
              "RemoteDirectory": "/test",
              "VolumeMountpoint": "86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com",
              "Role": "Compute",
              "LocalDirectory": "/testopt",
              "VolumeType": "NAS",
              "Location": "PublicCloud",
              "VolumeProtocol": "NFS"
            }
          ]
        }
      }
    ]
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.