Query mounted NAS file systems with GetClusterVolumes - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the NAS file systems mounted to a specified E-HPC cluster.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-gh5WKb****

Response elements

Element	Type	Description	Example
	object
RegionId	string	The ID of the region.	cn-hangzhou
RequestId	string	The ID of the request.	8BCFD52E-0336-4490-AE7D-F560F106****
Volumes	object
VolumeInfo	array<object>	The file systems mounted to the E-HPC cluster.
	array<object>
JobQueue	string	The queue of the job.	workq
VolumeId	string	The ID of the file system.	0e754****
RemoteDirectory	string	The remote mount directory.	/test
VolumeMountpoint	string	The address of the mount target.	0e754****-kal90.cn-hangzhou.nas.aliyuncs.com
LocalDirectory	string	The local mount directory.	/ehpcdata
VolumeType	string	The type of the file system. Valid values: NAS	NAS
MustKeep	boolean	Indicates whether the resource can be unmounted.	true
Location	string	The cluster type. Valid values: OnPremise: The cluster is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
VolumeProtocol	string	The protocol used by the file system. Valid values: NFS SMB	NFS
Roles	object
RoleInfo	array<object>	The nodes on which the file system is mounted.
	object
Name	string	The node type. Valid values: Compute: compute node Manager: management node Login: logon node	Compute

Examples

Success response

JSON format

{
  "RegionId": "cn-hangzhou",
  "RequestId": "8BCFD52E-0336-4490-AE7D-F560F106****",
  "Volumes": {
    "VolumeInfo": [
      {
        "JobQueue": "workq",
        "VolumeId": "0e754****",
        "RemoteDirectory": "/test",
        "VolumeMountpoint": "0e754****-kal90.cn-hangzhou.nas.aliyuncs.com",
        "LocalDirectory": "/ehpcdata",
        "VolumeType": "NAS",
        "MustKeep": true,
        "Location": "PublicCloud",
        "VolumeProtocol": "NFS",
        "Roles": {
          "RoleInfo": [
            {
              "Name": "Compute"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
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.
406	PartFailure	Part of the batch operation 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.