All Products
Search
Document Center

Elastic High Performance Computing:GetClusterVolumes

Last Updated:Jul 31, 2025

Queries the information of the NAS file system mounted to a specified cluster.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:GetClusterVolumes
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster.

You can call the ListClusters operation to query the cluster ID.

ehpc-hz-gh5WKb****

Response parameters

ParameterTypeDescriptionExample
object
RegionIdstring

The ID of the region.

cn-hangzhou
RequestIdstring

The ID of the request.

8BCFD52E-0336-4490-AE7D-F560F106****
Volumesarray<object>

The array of the file system mounted to the E-HPC cluster.

VolumeInfoobject
JobQueuestring

The queue of the job.

workq
VolumeIdstring

The ID of the file system.

0e754****
RemoteDirectorystring

The remote mount directory.

/test
VolumeMountpointstring

The address of the mount target.

0e754****-kal90.cn-hangzhou.nas.aliyuncs.com
LocalDirectorystring

The local mount directory.

/ehpcdata
VolumeTypestring

The type of the file system. Valid values:

  • NAS
NAS
MustKeepboolean

Indicates whether the resource can be unmounted.

true
Locationstring

The type of cluster. Valid values:

  • OnPremise: The cluster is deployed on a hybrid cloud.
  • PublicCloud: The cluster is deployed on a public cloud.
PublicCloud
VolumeProtocolstring

The storage protocol type of the file system. Valid values:

  • NFS
  • SMB
NFS
Rolesarray<object>

The array of the node on which the file system is mounted.

RoleInfoobject
Namestring

The type of the node on which the file system is mounted. Valid values:

  • Compute: compute node
  • Manager: management node
  • Login: logon node
Compute

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParamsInvalid param: %s-
404ClusterNotFoundThe specified instance does not exist.
406NasErrorFailed to request the NAS interface.
406DbErrorDatabase request failed.
406PartFailurePart of the batch operation failed.
407NotAuthorizedThe request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
No change history